ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.121 by root, Mon Jan 28 12:13:54 2008 UTC vs.
Revision 1.178 by root, Sat Sep 13 18:25:50 2008 UTC

…		…
2		2
3	libev - a high performance full-featured event loop written in C	3	libev - a high performance full-featured event loop written in C
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	#include <ev.h>	7	#include <ev.h>
8		8
9	=head2 EXAMPLE PROGRAM	9	=head2 EXAMPLE PROGRAM
10		10
		11	// a single header file is required
11	#include <ev.h>	12	#include <ev.h>
12		13
		14	// every watcher type has its own typedef'd struct
		15	// with the name ev_<type>
13	ev_io stdin_watcher;	16	ev_io stdin_watcher;
14	ev_timer timeout_watcher;	17	ev_timer timeout_watcher;
15		18
16	/* called when data readable on stdin */	19	// all watcher callbacks have a similar signature
		20	// this callback is called when data is readable on stdin
17	static void	21	static void
18	stdin_cb (EV_P_ struct ev_io *w, int revents)	22	stdin_cb (EV_P_ struct ev_io *w, int revents)
19	{	23	{
20	/* puts ("stdin ready"); */	24	puts ("stdin ready");
21	ev_io_stop (EV_A_ w); /* just a syntax example */	25	// for one-shot events, one must manually stop the watcher
22	ev_unloop (EV_A_ EVUNLOOP_ALL); /* leave all loop calls */	26	// with its corresponding stop function.
		27	ev_io_stop (EV_A_ w);
		28
		29	// this causes all nested ev_loop's to stop iterating
		30	ev_unloop (EV_A_ EVUNLOOP_ALL);
23	}	31	}
24		32
		33	// another callback, this time for a time-out
25	static void	34	static void
26	timeout_cb (EV_P_ struct ev_timer *w, int revents)	35	timeout_cb (EV_P_ struct ev_timer *w, int revents)
27	{	36	{
28	/* puts ("timeout"); */	37	puts ("timeout");
29	ev_unloop (EV_A_ EVUNLOOP_ONE); /* leave one loop call */	38	// this causes the innermost ev_loop to stop iterating
		39	ev_unloop (EV_A_ EVUNLOOP_ONE);
30	}	40	}
31		41
32	int	42	int
33	main (void)	43	main (void)
34	{	44	{
		45	// use the default event loop unless you have special needs
35	struct ev_loop *loop = ev_default_loop (0);	46	struct ev_loop *loop = ev_default_loop (0);
36		47
37	/* initialise an io watcher, then start it */	48	// initialise an io watcher, then start it
		49	// this one will watch for stdin to become readable
38	ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);	50	ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);
39	ev_io_start (loop, &stdin_watcher);	51	ev_io_start (loop, &stdin_watcher);
40		52
		53	// initialise a timer watcher, then start it
41	/* simple non-repeating 5.5 second timeout */	54	// simple non-repeating 5.5 second timeout
42	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);	55	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
43	ev_timer_start (loop, &timeout_watcher);	56	ev_timer_start (loop, &timeout_watcher);
44		57
45	/* loop till timeout or data ready */	58	// now wait for events to arrive
46	ev_loop (loop, 0);	59	ev_loop (loop, 0);
47		60
		61	// unloop was called, so exit
48	return 0;	62	return 0;
49	}	63	}
50		64
51	=head1 DESCRIPTION	65	=head1 DESCRIPTION
52		66
53	The newest version of this document is also available as a html-formatted	67	The newest version of this document is also available as an html-formatted
54	web page you might find easier to navigate when reading it for the first	68	web page you might find easier to navigate when reading it for the first
55	time: L<http://cvs.schmorp.de/libev/ev.html>.	69	time: L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod>.
56		70
57	Libev is an event loop: you register interest in certain events (such as a	71	Libev is an event loop: you register interest in certain events (such as a
58	file descriptor being readable or a timeout occurring), and it will manage	72	file descriptor being readable or a timeout occurring), and it will manage
59	these event sources and provide your program with events.	73	these event sources and provide your program with events.
60		74
…		…
84	L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent	98	L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent
85	for example).	99	for example).
86		100
87	=head2 CONVENTIONS	101	=head2 CONVENTIONS
88		102
89	Libev is very configurable. In this manual the default configuration will	103	Libev is very configurable. In this manual the default (and most common)
90	be described, which supports multiple event loops. For more info about	104	configuration will be described, which supports multiple event loops. For
91	various configuration options please have a look at B<EMBED> section in	105	more info about various configuration options please have a look at
92	this manual. If libev was configured without support for multiple event	106	B<EMBED> section in this manual. If libev was configured without support
93	loops, then all functions taking an initial argument of name C<loop>	107	for multiple event loops, then all functions taking an initial argument of
94	(which is always of type C<struct ev_loop *>) will not have this argument.	108	name C<loop> (which is always of type C<struct ev_loop *>) will not have
		109	this argument.
95		110
96	=head2 TIME REPRESENTATION	111	=head2 TIME REPRESENTATION
97		112
98	Libev represents time as a single floating point number, representing the	113	Libev represents time as a single floating point number, representing the
99	(fractional) number of seconds since the (POSIX) epoch (somewhere near	114	(fractional) number of seconds since the (POSIX) epoch (somewhere near
100	the beginning of 1970, details are complicated, don't ask). This type is	115	the beginning of 1970, details are complicated, don't ask). This type is
101	called C<ev_tstamp>, which is what you should use too. It usually aliases	116	called C<ev_tstamp>, which is what you should use too. It usually aliases
102	to the C<double> type in C, and when you need to do any calculations on	117	to the C<double> type in C, and when you need to do any calculations on
103	it, you should treat it as some floatingpoint value. Unlike the name	118	it, you should treat it as some floating point value. Unlike the name
104	component C<stamp> might indicate, it is also used for time differences	119	component C<stamp> might indicate, it is also used for time differences
105	throughout libev.	120	throughout libev.
		121
		122	=head1 ERROR HANDLING
		123
		124	Libev knows three classes of errors: operating system errors, usage errors
		125	and internal errors (bugs).
		126
		127	When libev catches an operating system error it cannot handle (for example
		128	a system call indicating a condition libev cannot fix), it calls the callback
		129	set via C<ev_set_syserr_cb>, which is supposed to fix the problem or
		130	abort. The default is to print a diagnostic message and to call C<abort
		131	()>.
		132
		133	When libev detects a usage error such as a negative timer interval, then
		134	it will print a diagnostic message and abort (via the C<assert> mechanism,
		135	so C<NDEBUG> will disable this checking): these are programming errors in
		136	the libev caller and need to be fixed there.
		137
		138	Libev also has a few internal error-checking C<assert>ions, and also has
		139	extensive consistency checking code. These do not trigger under normal
		140	circumstances, as they indicate either a bug in libev or worse.
		141
106		142
107	=head1 GLOBAL FUNCTIONS	143	=head1 GLOBAL FUNCTIONS
108		144
109	These functions can be called anytime, even before initialising the	145	These functions can be called anytime, even before initialising the
110	library in any way.	146	library in any way.
…		…
119		155
120	=item ev_sleep (ev_tstamp interval)	156	=item ev_sleep (ev_tstamp interval)
121		157
122	Sleep for the given interval: The current thread will be blocked until	158	Sleep for the given interval: The current thread will be blocked until
123	either it is interrupted or the given time interval has passed. Basically	159	either it is interrupted or the given time interval has passed. Basically
124	this is a subsecond-resolution C<sleep ()>.	160	this is a sub-second-resolution C<sleep ()>.
125		161
126	=item int ev_version_major ()	162	=item int ev_version_major ()
127		163
128	=item int ev_version_minor ()	164	=item int ev_version_minor ()
129		165
…		…
142	not a problem.	178	not a problem.
143		179
144	Example: Make sure we haven't accidentally been linked against the wrong	180	Example: Make sure we haven't accidentally been linked against the wrong
145	version.	181	version.
146		182
147	assert (("libev version mismatch",	183	assert (("libev version mismatch",
148	ev_version_major () == EV_VERSION_MAJOR	184	ev_version_major () == EV_VERSION_MAJOR
149	&& ev_version_minor () >= EV_VERSION_MINOR));	185	&& ev_version_minor () >= EV_VERSION_MINOR));
150		186
151	=item unsigned int ev_supported_backends ()	187	=item unsigned int ev_supported_backends ()
152		188
153	Return the set of all backends (i.e. their corresponding C<EV_BACKEND_*>	189	Return the set of all backends (i.e. their corresponding C<EV_BACKEND_*>
154	value) compiled into this binary of libev (independent of their	190	value) compiled into this binary of libev (independent of their
…		…
156	a description of the set values.	192	a description of the set values.
157		193
158	Example: make sure we have the epoll method, because yeah this is cool and	194	Example: make sure we have the epoll method, because yeah this is cool and
159	a must have and can we have a torrent of it please!!!11	195	a must have and can we have a torrent of it please!!!11
160		196
161	assert (("sorry, no epoll, no sex",	197	assert (("sorry, no epoll, no sex",
162	ev_supported_backends () & EVBACKEND_EPOLL));	198	ev_supported_backends () & EVBACKEND_EPOLL));
163		199
164	=item unsigned int ev_recommended_backends ()	200	=item unsigned int ev_recommended_backends ()
165		201
166	Return the set of all backends compiled into this binary of libev and also	202	Return the set of all backends compiled into this binary of libev and also
167	recommended for this platform. This set is often smaller than the one	203	recommended for this platform. This set is often smaller than the one
168	returned by C<ev_supported_backends>, as for example kqueue is broken on	204	returned by C<ev_supported_backends>, as for example kqueue is broken on
169	most BSDs and will not be autodetected unless you explicitly request it	205	most BSDs and will not be auto-detected unless you explicitly request it
170	(assuming you know what you are doing). This is the set of backends that	206	(assuming you know what you are doing). This is the set of backends that
171	libev will probe for if you specify no backends explicitly.	207	libev will probe for if you specify no backends explicitly.
172		208
173	=item unsigned int ev_embeddable_backends ()	209	=item unsigned int ev_embeddable_backends ()
174		210
…		…
181	See the description of C<ev_embed> watchers for more info.	217	See the description of C<ev_embed> watchers for more info.
182		218
183	=item ev_set_allocator (void *(*cb)(void *ptr, long size))	219	=item ev_set_allocator (void *(*cb)(void *ptr, long size))
184		220
185	Sets the allocation function to use (the prototype is similar - the	221	Sets the allocation function to use (the prototype is similar - the
186	semantics is identical - to the realloc C function). It is used to	222	semantics are identical to the C<realloc> C89/SuS/POSIX function). It is
187	allocate and free memory (no surprises here). If it returns zero when	223	used to allocate and free memory (no surprises here). If it returns zero
188	memory needs to be allocated, the library might abort or take some	224	when memory needs to be allocated (C<size != 0>), the library might abort
189	potentially destructive action. The default is your system realloc	225	or take some potentially destructive action.
190	function.	226
		227	Since some systems (at least OpenBSD and Darwin) fail to implement
		228	correct C<realloc> semantics, libev will use a wrapper around the system
		229	C<realloc> and C<free> functions by default.
191		230
192	You could override this function in high-availability programs to, say,	231	You could override this function in high-availability programs to, say,
193	free some memory if it cannot allocate memory, to use a special allocator,	232	free some memory if it cannot allocate memory, to use a special allocator,
194	or even to sleep a while and retry until some memory is available.	233	or even to sleep a while and retry until some memory is available.
195		234
196	Example: Replace the libev allocator with one that waits a bit and then	235	Example: Replace the libev allocator with one that waits a bit and then
197	retries).	236	retries (example requires a standards-compliant C<realloc>).
198		237
199	static void *	238	static void *
200	persistent_realloc (void *ptr, size_t size)	239	persistent_realloc (void *ptr, size_t size)
201	{	240	{
202	for (;;)	241	for (;;)
…		…
213	...	252	...
214	ev_set_allocator (persistent_realloc);	253	ev_set_allocator (persistent_realloc);
215		254
216	=item ev_set_syserr_cb (void (*cb)(const char *msg));	255	=item ev_set_syserr_cb (void (*cb)(const char *msg));
217		256
218	Set the callback function to call on a retryable syscall error (such	257	Set the callback function to call on a retryable system call error (such
219	as failed select, poll, epoll_wait). The message is a printable string	258	as failed select, poll, epoll_wait). The message is a printable string
220	indicating the system call or subsystem causing the problem. If this	259	indicating the system call or subsystem causing the problem. If this
221	callback is set, then libev will expect it to remedy the sitution, no	260	callback is set, then libev will expect it to remedy the situation, no
222	matter what, when it returns. That is, libev will generally retry the	261	matter what, when it returns. That is, libev will generally retry the
223	requested operation, or, if the condition doesn't go away, do bad stuff	262	requested operation, or, if the condition doesn't go away, do bad stuff
224	(such as abort).	263	(such as abort).
225		264
226	Example: This is basically the same thing that libev does internally, too.	265	Example: This is basically the same thing that libev does internally, too.
…		…
240	=head1 FUNCTIONS CONTROLLING THE EVENT LOOP	279	=head1 FUNCTIONS CONTROLLING THE EVENT LOOP
241		280
242	An event loop is described by a C<struct ev_loop *>. The library knows two	281	An event loop is described by a C<struct ev_loop *>. The library knows two
243	types of such loops, the I<default> loop, which supports signals and child	282	types of such loops, the I<default> loop, which supports signals and child
244	events, and dynamically created loops which do not.	283	events, and dynamically created loops which do not.
245
246	If you use threads, a common model is to run the default event loop
247	in your main thread (or in a separate thread) and for each thread you
248	create, you also create another event loop. Libev itself does no locking
249	whatsoever, so if you mix calls to the same event loop in different
250	threads, make sure you lock (this is usually a bad idea, though, even if
251	done correctly, because it's hideous and inefficient).
252		284
253	=over 4	285	=over 4
254		286
255	=item struct ev_loop *ev_default_loop (unsigned int flags)	287	=item struct ev_loop *ev_default_loop (unsigned int flags)
256		288
…		…
260	flags. If that is troubling you, check C<ev_backend ()> afterwards).	292	flags. If that is troubling you, check C<ev_backend ()> afterwards).
261		293
262	If you don't know what event loop to use, use the one returned from this	294	If you don't know what event loop to use, use the one returned from this
263	function.	295	function.
264		296
		297	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,
		299	as loops cannot bes hared easily between threads anyway).
		300
265	The default loop is the only loop that can handle C<ev_signal> and	301	The default loop is the only loop that can handle C<ev_signal> and
266	C<ev_child> watchers, and to do this, it always registers a handler	302	C<ev_child> watchers, and to do this, it always registers a handler
267	for C<SIGCHLD>. If this is a problem for your app you can either	303	for C<SIGCHLD>. If this is a problem for your application you can either
268	create a dynamic loop with C<ev_loop_new> that doesn't do that, or you	304	create a dynamic loop with C<ev_loop_new> that doesn't do that, or you
269	can simply overwrite the C<SIGCHLD> signal handler I<after> calling	305	can simply overwrite the C<SIGCHLD> signal handler I<after> calling
270	C<ev_default_init>.	306	C<ev_default_init>.
271		307
272	The flags argument can be used to specify special behaviour or specific	308	The flags argument can be used to specify special behaviour or specific
…		…
281	The default flags value. Use this if you have no clue (it's the right	317	The default flags value. Use this if you have no clue (it's the right
282	thing, believe me).	318	thing, believe me).
283		319
284	=item C<EVFLAG_NOENV>	320	=item C<EVFLAG_NOENV>
285		321
286	If this flag bit is ored into the flag value (or the program runs setuid	322	If this flag bit is or'ed into the flag value (or the program runs setuid
287	or setgid) then libev will I<not> look at the environment variable	323	or setgid) then libev will I<not> look at the environment variable
288	C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will	324	C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will
289	override the flags completely if it is found in the environment. This is	325	override the flags completely if it is found in the environment. This is
290	useful to try out specific backends to test their performance, or to work	326	useful to try out specific backends to test their performance, or to work
291	around bugs.	327	around bugs.
…		…
297	enabling this flag.	333	enabling this flag.
298		334
299	This works by calling C<getpid ()> on every iteration of the loop,	335	This works by calling C<getpid ()> on every iteration of the loop,
300	and thus this might slow down your event loop if you do a lot of loop	336	and thus this might slow down your event loop if you do a lot of loop
301	iterations and little real work, but is usually not noticeable (on my	337	iterations and little real work, but is usually not noticeable (on my
302	Linux system for example, C<getpid> is actually a simple 5-insn sequence	338	GNU/Linux system for example, C<getpid> is actually a simple 5-insn sequence
303	without a syscall and thus I<very> fast, but my Linux system also has	339	without a system call and thus I<very> fast, but my GNU/Linux system also has
304	C<pthread_atfork> which is even faster).	340	C<pthread_atfork> which is even faster).
305		341
306	The big advantage of this flag is that you can forget about fork (and	342	The big advantage of this flag is that you can forget about fork (and
307	forget about forgetting to tell libev about forking) when you use this	343	forget about forgetting to tell libev about forking) when you use this
308	flag.	344	flag.
309		345
310	This flag setting cannot be overriden or specified in the C<LIBEV_FLAGS>	346	This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS>
311	environment variable.	347	environment variable.
312		348
313	=item C<EVBACKEND_SELECT> (value 1, portable select backend)	349	=item C<EVBACKEND_SELECT> (value 1, portable select backend)
314		350
315	This is your standard select(2) backend. Not I<completely> standard, as	351	This is your standard select(2) backend. Not I<completely> standard, as
…		…
317	but if that fails, expect a fairly low limit on the number of fds when	353	but if that fails, expect a fairly low limit on the number of fds when
318	using this backend. It doesn't scale too well (O(highest_fd)), but its	354	using this backend. It doesn't scale too well (O(highest_fd)), but its
319	usually the fastest backend for a low number of (low-numbered :) fds.	355	usually the fastest backend for a low number of (low-numbered :) fds.
320		356
321	To get good performance out of this backend you need a high amount of	357	To get good performance out of this backend you need a high amount of
322	parallelity (most of the file descriptors should be busy). If you are	358	parallelism (most of the file descriptors should be busy). If you are
323	writing a server, you should C<accept ()> in a loop to accept as many	359	writing a server, you should C<accept ()> in a loop to accept as many
324	connections as possible during one iteration. You might also want to have	360	connections as possible during one iteration. You might also want to have
325	a look at C<ev_set_io_collect_interval ()> to increase the amount of	361	a look at C<ev_set_io_collect_interval ()> to increase the amount of
326	readyness notifications you get per iteration.	362	readiness notifications you get per iteration.
327		363
328	=item C<EVBACKEND_POLL> (value 2, poll backend, available everywhere except on windows)	364	=item C<EVBACKEND_POLL> (value 2, poll backend, available everywhere except on windows)
329		365
330	And this is your standard poll(2) backend. It's more complicated	366	And this is your standard poll(2) backend. It's more complicated
331	than select, but handles sparse fds better and has no artificial	367	than select, but handles sparse fds better and has no artificial
…		…
339	For few fds, this backend is a bit little slower than poll and select,	375	For few fds, this backend is a bit little slower than poll and select,
340	but it scales phenomenally better. While poll and select usually scale	376	but it scales phenomenally better. While poll and select usually scale
341	like O(total_fds) where n is the total number of fds (or the highest fd),	377	like O(total_fds) where n is the total number of fds (or the highest fd),
342	epoll scales either O(1) or O(active_fds). The epoll design has a number	378	epoll scales either O(1) or O(active_fds). The epoll design has a number
343	of shortcomings, such as silently dropping events in some hard-to-detect	379	of shortcomings, such as silently dropping events in some hard-to-detect
344	cases and rewiring a syscall per fd change, no fork support and bad	380	cases and requiring a system call per fd change, no fork support and bad
345	support for dup.	381	support for dup.
346		382
347	While stopping, setting and starting an I/O watcher in the same iteration	383	While stopping, setting and starting an I/O watcher in the same iteration
348	will result in some caching, there is still a syscall per such incident	384	will result in some caching, there is still a system call per such incident
349	(because the fd could point to a different file description now), so its	385	(because the fd could point to a different file description now), so its
350	best to avoid that. Also, C<dup ()>'ed file descriptors might not work	386	best to avoid that. Also, C<dup ()>'ed file descriptors might not work
351	very well if you register events for both fds.	387	very well if you register events for both fds.
352		388
353	Please note that epoll sometimes generates spurious notifications, so you	389	Please note that epoll sometimes generates spurious notifications, so you
…		…
356		392
357	Best performance from this backend is achieved by not unregistering all	393	Best performance from this backend is achieved by not unregistering all
358	watchers for a file descriptor until it has been closed, if possible, i.e.	394	watchers for a file descriptor until it has been closed, if possible, i.e.
359	keep at least one watcher active per fd at all times.	395	keep at least one watcher active per fd at all times.
360		396
361	While nominally embeddeble in other event loops, this feature is broken in	397	While nominally embeddable in other event loops, this feature is broken in
362	all kernel versions tested so far.	398	all kernel versions tested so far.
363		399
364	=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)	400	=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)
365		401
366	Kqueue deserves special mention, as at the time of this writing, it	402	Kqueue deserves special mention, as at the time of this writing, it
367	was broken on all BSDs except NetBSD (usually it doesn't work reliably	403	was broken on all BSDs except NetBSD (usually it doesn't work reliably
368	with anything but sockets and pipes, except on Darwin, where of course	404	with anything but sockets and pipes, except on Darwin, where of course
369	it's completely useless). For this reason it's not being "autodetected"	405	it's completely useless). For this reason it's not being "auto-detected"
370	unless you explicitly specify it explicitly in the flags (i.e. using	406	unless you explicitly specify it explicitly in the flags (i.e. using
371	C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough)	407	C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough)
372	system like NetBSD.	408	system like NetBSD.
373		409
374	You still can embed kqueue into a normal poll or select backend and use it	410	You still can embed kqueue into a normal poll or select backend and use it
…		…
376	the target platform). See C<ev_embed> watchers for more info.	412	the target platform). See C<ev_embed> watchers for more info.
377		413
378	It scales in the same way as the epoll backend, but the interface to the	414	It scales in the same way as the epoll backend, but the interface to the
379	kernel is more efficient (which says nothing about its actual speed, of	415	kernel is more efficient (which says nothing about its actual speed, of
380	course). While stopping, setting and starting an I/O watcher does never	416	course). While stopping, setting and starting an I/O watcher does never
381	cause an extra syscall as with C<EVBACKEND_EPOLL>, it still adds up to	417	cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to
382	two event changes per incident, support for C<fork ()> is very bad and it	418	two event changes per incident, support for C<fork ()> is very bad and it
383	drops fds silently in similarly hard-to-detect cases.	419	drops fds silently in similarly hard-to-detect cases.
384		420
385	This backend usually performs well under most conditions.	421	This backend usually performs well under most conditions.
386		422
…		…
401	=item C<EVBACKEND_PORT> (value 32, Solaris 10)	437	=item C<EVBACKEND_PORT> (value 32, Solaris 10)
402		438
403	This uses the Solaris 10 event port mechanism. As with everything on Solaris,	439	This uses the Solaris 10 event port mechanism. As with everything on Solaris,
404	it's really slow, but it still scales very well (O(active_fds)).	440	it's really slow, but it still scales very well (O(active_fds)).
405		441
406	Please note that solaris event ports can deliver a lot of spurious	442	Please note that Solaris event ports can deliver a lot of spurious
407	notifications, so you need to use non-blocking I/O or other means to avoid	443	notifications, so you need to use non-blocking I/O or other means to avoid
408	blocking when no data (or space) is available.	444	blocking when no data (or space) is available.
409		445
410	While this backend scales well, it requires one system call per active	446	While this backend scales well, it requires one system call per active
411	file descriptor per loop iteration. For small and medium numbers of file	447	file descriptor per loop iteration. For small and medium numbers of file
412	descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend	448	descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend
413	might perform better.	449	might perform better.
414		450
415	On the positive side, ignoring the spurious readyness notifications, this	451	On the positive side, ignoring the spurious readiness notifications, this
416	backend actually performed to specification in all tests and is fully	452	backend actually performed to specification in all tests and is fully
417	embeddable, which is a rare feat among the OS-specific backends.	453	embeddable, which is a rare feat among the OS-specific backends.
418		454
419	=item C<EVBACKEND_ALL>	455	=item C<EVBACKEND_ALL>
420		456
…		…
424		460
425	It is definitely not recommended to use this flag.	461	It is definitely not recommended to use this flag.
426		462
427	=back	463	=back
428		464
429	If one or more of these are ored into the flags value, then only these	465	If one or more of these are or'ed into the flags value, then only these
430	backends will be tried (in the reverse order as listed here). If none are	466	backends will be tried (in the reverse order as listed here). If none are
431	specified, all backends in C<ev_recommended_backends ()> will be tried.	467	specified, all backends in C<ev_recommended_backends ()> will be tried.
432		468
433	The most typical usage is like this:	469	The most typical usage is like this:
434		470
435	if (!ev_default_loop (0))	471	if (!ev_default_loop (0))
436	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");	472	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
437		473
438	Restrict libev to the select and poll backends, and do not allow	474	Restrict libev to the select and poll backends, and do not allow
439	environment settings to be taken into account:	475	environment settings to be taken into account:
440		476
441	ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV);	477	ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV);
442		478
443	Use whatever libev has to offer, but make sure that kqueue is used if	479	Use whatever libev has to offer, but make sure that kqueue is used if
444	available (warning, breaks stuff, best use only with your own private	480	available (warning, breaks stuff, best use only with your own private
445	event loop and only if you know the OS supports your types of fds):	481	event loop and only if you know the OS supports your types of fds):
446		482
447	ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE);	483	ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE);
448		484
449	=item struct ev_loop *ev_loop_new (unsigned int flags)	485	=item struct ev_loop *ev_loop_new (unsigned int flags)
450		486
451	Similar to C<ev_default_loop>, but always creates a new event loop that is	487	Similar to C<ev_default_loop>, but always creates a new event loop that is
452	always distinct from the default loop. Unlike the default loop, it cannot	488	always distinct from the default loop. Unlike the default loop, it cannot
453	handle signal and child watchers, and attempts to do so will be greeted by	489	handle signal and child watchers, and attempts to do so will be greeted by
454	undefined behaviour (or a failed assertion if assertions are enabled).	490	undefined behaviour (or a failed assertion if assertions are enabled).
455		491
		492	Note that this function I<is> thread-safe, and the recommended way to use
		493	libev with threads is indeed to create one loop per thread, and using the
		494	default loop in the "main" or "initial" thread.
		495
456	Example: Try to create a event loop that uses epoll and nothing else.	496	Example: Try to create a event loop that uses epoll and nothing else.
457		497
458	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);	498	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
459	if (!epoller)	499	if (!epoller)
460	fatal ("no epoll found here, maybe it hides under your chair");	500	fatal ("no epoll found here, maybe it hides under your chair");
461		501
462	=item ev_default_destroy ()	502	=item ev_default_destroy ()
463		503
464	Destroys the default loop again (frees all memory and kernel state	504	Destroys the default loop again (frees all memory and kernel state
465	etc.). None of the active event watchers will be stopped in the normal	505	etc.). None of the active event watchers will be stopped in the normal
466	sense, so e.g. C<ev_is_active> might still return true. It is your	506	sense, so e.g. C<ev_is_active> might still return true. It is your
467	responsibility to either stop all watchers cleanly yoursef I<before>	507	responsibility to either stop all watchers cleanly yourself I<before>
468	calling this function, or cope with the fact afterwards (which is usually	508	calling this function, or cope with the fact afterwards (which is usually
469	the easiest thing, you can just ignore the watchers and/or C<free ()> them	509	the easiest thing, you can just ignore the watchers and/or C<free ()> them
470	for example).	510	for example).
471		511
472	Note that certain global state, such as signal state, will not be freed by	512	Note that certain global state, such as signal state, will not be freed by
…		…
506		546
507	Like C<ev_default_fork>, but acts on an event loop created by	547	Like C<ev_default_fork>, but acts on an event loop created by
508	C<ev_loop_new>. Yes, you have to call this on every allocated event loop	548	C<ev_loop_new>. Yes, you have to call this on every allocated event loop
509	after fork, and how you do this is entirely your own problem.	549	after fork, and how you do this is entirely your own problem.
510		550
		551	=item int ev_is_default_loop (loop)
		552
		553	Returns true when the given loop actually is the default loop, false otherwise.
		554
511	=item unsigned int ev_loop_count (loop)	555	=item unsigned int ev_loop_count (loop)
512		556
513	Returns the count of loop iterations for the loop, which is identical to	557	Returns the count of loop iterations for the loop, which is identical to
514	the number of times libev did poll for new events. It starts at C<0> and	558	the number of times libev did poll for new events. It starts at C<0> and
515	happily wraps around with enough iterations.	559	happily wraps around with enough iterations.
…		…
529	received events and started processing them. This timestamp does not	573	received events and started processing them. This timestamp does not
530	change as long as callbacks are being processed, and this is also the base	574	change as long as callbacks are being processed, and this is also the base
531	time used for relative timers. You can treat it as the timestamp of the	575	time used for relative timers. You can treat it as the timestamp of the
532	event occurring (or more correctly, libev finding out about it).	576	event occurring (or more correctly, libev finding out about it).
533		577
		578	=item ev_now_update (loop)
		579
		580	Establishes the current time by querying the kernel, updating the time
		581	returned by C<ev_now ()> in the progress. This is a costly operation and
		582	is usually done automatically within C<ev_loop ()>.
		583
		584	This function is rarely useful, but when some event callback runs for a
		585	very long time without entering the event loop, updating libev's idea of
		586	the current time is a good idea.
		587
		588	See also "The special problem of time updates" in the C<ev_timer> section.
		589
534	=item ev_loop (loop, int flags)	590	=item ev_loop (loop, int flags)
535		591
536	Finally, this is it, the event handler. This function usually is called	592	Finally, this is it, the event handler. This function usually is called
537	after you initialised all your watchers and you want to start handling	593	after you initialised all your watchers and you want to start handling
538	events.	594	events.
…		…
549	A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle	605	A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle
550	those events and any outstanding ones, but will not block your process in	606	those events and any outstanding ones, but will not block your process in
551	case there are no events and will return after one iteration of the loop.	607	case there are no events and will return after one iteration of the loop.
552		608
553	A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if	609	A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if
554	neccessary) and will handle those and any outstanding ones. It will block	610	necessary) and will handle those and any outstanding ones. It will block
555	your process until at least one new event arrives, and will return after	611	your process until at least one new event arrives, and will return after
556	one iteration of the loop. This is useful if you are waiting for some	612	one iteration of the loop. This is useful if you are waiting for some
557	external event in conjunction with something not expressible using other	613	external event in conjunction with something not expressible using other
558	libev watchers. However, a pair of C<ev_prepare>/C<ev_check> watchers is	614	libev watchers. However, a pair of C<ev_prepare>/C<ev_check> watchers is
559	usually a better approach for this kind of thing.	615	usually a better approach for this kind of thing.
560		616
561	Here are the gory details of what C<ev_loop> does:	617	Here are the gory details of what C<ev_loop> does:
562		618
563	- Before the first iteration, call any pending watchers.	619	- Before the first iteration, call any pending watchers.
564	* If EVFLAG_FORKCHECK was used, check for a fork.	620	* If EVFLAG_FORKCHECK was used, check for a fork.
565	- If a fork was detected, queue and call all fork watchers.	621	- If a fork was detected (by any means), queue and call all fork watchers.
566	- Queue and call all prepare watchers.	622	- Queue and call all prepare watchers.
567	- If we have been forked, recreate the kernel state.	623	- If we have been forked, detach and recreate the kernel state
		624	as to not disturb the other process.
568	- Update the kernel state with all outstanding changes.	625	- Update the kernel state with all outstanding changes.
569	- Update the "event loop time".	626	- Update the "event loop time" (ev_now ()).
570	- Calculate for how long to sleep or block, if at all	627	- Calculate for how long to sleep or block, if at all
571	(active idle watchers, EVLOOP_NONBLOCK or not having	628	(active idle watchers, EVLOOP_NONBLOCK or not having
572	any active watchers at all will result in not sleeping).	629	any active watchers at all will result in not sleeping).
573	- Sleep if the I/O and timer collect interval say so.	630	- Sleep if the I/O and timer collect interval say so.
574	- Block the process, waiting for any events.	631	- Block the process, waiting for any events.
575	- Queue all outstanding I/O (fd) events.	632	- Queue all outstanding I/O (fd) events.
576	- Update the "event loop time" and do time jump handling.	633	- Update the "event loop time" (ev_now ()), and do time jump adjustments.
577	- Queue all outstanding timers.	634	- Queue all outstanding timers.
578	- Queue all outstanding periodics.	635	- Queue all outstanding periodics.
579	- If no events are pending now, queue all idle watchers.	636	- Unless any events are pending now, queue all idle watchers.
580	- Queue all check watchers.	637	- Queue all check watchers.
581	- Call all queued watchers in reverse order (i.e. check watchers first).	638	- Call all queued watchers in reverse order (i.e. check watchers first).
582	Signals and child watchers are implemented as I/O watchers, and will	639	Signals and child watchers are implemented as I/O watchers, and will
583	be handled here by queueing them when their watcher gets executed.	640	be handled here by queueing them when their watcher gets executed.
584	- If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK	641	- If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK
…		…
589	anymore.	646	anymore.
590		647
591	... queue jobs here, make sure they register event watchers as long	648	... queue jobs here, make sure they register event watchers as long
592	... as they still have work to do (even an idle watcher will do..)	649	... as they still have work to do (even an idle watcher will do..)
593	ev_loop (my_loop, 0);	650	ev_loop (my_loop, 0);
594	... jobs done. yeah!	651	... jobs done or somebody called unloop. yeah!
595		652
596	=item ev_unloop (loop, how)	653	=item ev_unloop (loop, how)
597		654
598	Can be used to make a call to C<ev_loop> return early (but only after it	655	Can be used to make a call to C<ev_loop> return early (but only after it
599	has processed all outstanding events). The C<how> argument must be either	656	has processed all outstanding events). The C<how> argument must be either
…		…
620	respectively).	677	respectively).
621		678
622	Example: Create a signal watcher, but keep it from keeping C<ev_loop>	679	Example: Create a signal watcher, but keep it from keeping C<ev_loop>
623	running when nothing else is active.	680	running when nothing else is active.
624		681
625	struct ev_signal exitsig;	682	struct ev_signal exitsig;
626	ev_signal_init (&exitsig, sig_cb, SIGINT);	683	ev_signal_init (&exitsig, sig_cb, SIGINT);
627	ev_signal_start (loop, &exitsig);	684	ev_signal_start (loop, &exitsig);
628	evf_unref (loop);	685	evf_unref (loop);
629		686
630	Example: For some weird reason, unregister the above signal handler again.	687	Example: For some weird reason, unregister the above signal handler again.
631		688
632	ev_ref (loop);	689	ev_ref (loop);
633	ev_signal_stop (loop, &exitsig);	690	ev_signal_stop (loop, &exitsig);
634		691
635	=item ev_set_io_collect_interval (loop, ev_tstamp interval)	692	=item ev_set_io_collect_interval (loop, ev_tstamp interval)
636		693
637	=item ev_set_timeout_collect_interval (loop, ev_tstamp interval)	694	=item ev_set_timeout_collect_interval (loop, ev_tstamp interval)
638		695
639	These advanced functions influence the time that libev will spend waiting	696	These advanced functions influence the time that libev will spend waiting
640	for events. Both are by default C<0>, meaning that libev will try to	697	for events. Both time intervals are by default C<0>, meaning that libev
641	invoke timer/periodic callbacks and I/O callbacks with minimum latency.	698	will try to invoke timer/periodic callbacks and I/O callbacks with minimum
		699	latency.
642		700
643	Setting these to a higher value (the C<interval> I<must> be >= C<0>)	701	Setting these to a higher value (the C<interval> I<must> be >= C<0>)
644	allows libev to delay invocation of I/O and timer/periodic callbacks to	702	allows libev to delay invocation of I/O and timer/periodic callbacks
645	increase efficiency of loop iterations.	703	to increase efficiency of loop iterations (or to increase power-saving
		704	opportunities).
646		705
647	The background is that sometimes your program runs just fast enough to	706	The background is that sometimes your program runs just fast enough to
648	handle one (or very few) event(s) per loop iteration. While this makes	707	handle one (or very few) event(s) per loop iteration. While this makes
649	the program responsive, it also wastes a lot of CPU time to poll for new	708	the program responsive, it also wastes a lot of CPU time to poll for new
650	events, especially with backends like C<select ()> which have a high	709	events, especially with backends like C<select ()> which have a high
…		…
660	to spend more time collecting timeouts, at the expense of increased	719	to spend more time collecting timeouts, at the expense of increased
661	latency (the watcher callback will be called later). C<ev_io> watchers	720	latency (the watcher callback will be called later). C<ev_io> watchers
662	will not be affected. Setting this to a non-null value will not introduce	721	will not be affected. Setting this to a non-null value will not introduce
663	any overhead in libev.	722	any overhead in libev.
664		723
665	Many (busy) programs can usually benefit by setting the io collect	724	Many (busy) programs can usually benefit by setting the I/O collect
666	interval to a value near C<0.1> or so, which is often enough for	725	interval to a value near C<0.1> or so, which is often enough for
667	interactive servers (of course not for games), likewise for timeouts. It	726	interactive servers (of course not for games), likewise for timeouts. It
668	usually doesn't make much sense to set it to a lower value than C<0.01>,	727	usually doesn't make much sense to set it to a lower value than C<0.01>,
669	as this approsaches the timing granularity of most systems.	728	as this approaches the timing granularity of most systems.
		729
		730	Setting the I<timeout collect interval> can improve the opportunity for
		731	saving power, as the program will "bundle" timer callback invocations that
		732	are "near" in time together, by delaying some, thus reducing the number of
		733	times the process sleeps and wakes up again. Another useful technique to
		734	reduce iterations/wake-ups is to use C<ev_periodic> watchers and make sure
		735	they fire on, say, one-second boundaries only.
		736
		737	=item ev_loop_verify (loop)
		738
		739	This function only does something when C<EV_VERIFY> support has been
		740	compiled in. It tries to go through all internal structures and checks
		741	them for validity. If anything is found to be inconsistent, it will print
		742	an error message to standard error and call C<abort ()>.
		743
		744	This can be used to catch bugs inside libev itself: under normal
		745	circumstances, this function will never abort as of course libev keeps its
		746	data structures consistent.
670		747
671	=back	748	=back
672		749
673		750
674	=head1 ANATOMY OF A WATCHER	751	=head1 ANATOMY OF A WATCHER
675		752
676	A watcher is a structure that you create and register to record your	753	A watcher is a structure that you create and register to record your
677	interest in some event. For instance, if you want to wait for STDIN to	754	interest in some event. For instance, if you want to wait for STDIN to
678	become readable, you would create an C<ev_io> watcher for that:	755	become readable, you would create an C<ev_io> watcher for that:
679		756
680	static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents)	757	static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents)
681	{	758	{
682	ev_io_stop (w);	759	ev_io_stop (w);
683	ev_unloop (loop, EVUNLOOP_ALL);	760	ev_unloop (loop, EVUNLOOP_ALL);
684	}	761	}
685		762
686	struct ev_loop *loop = ev_default_loop (0);	763	struct ev_loop *loop = ev_default_loop (0);
687	struct ev_io stdin_watcher;	764	struct ev_io stdin_watcher;
688	ev_init (&stdin_watcher, my_cb);	765	ev_init (&stdin_watcher, my_cb);
689	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);	766	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);
690	ev_io_start (loop, &stdin_watcher);	767	ev_io_start (loop, &stdin_watcher);
691	ev_loop (loop, 0);	768	ev_loop (loop, 0);
692		769
693	As you can see, you are responsible for allocating the memory for your	770	As you can see, you are responsible for allocating the memory for your
694	watcher structures (and it is usually a bad idea to do this on the stack,	771	watcher structures (and it is usually a bad idea to do this on the stack,
695	although this can sometimes be quite valid).	772	although this can sometimes be quite valid).
696		773
697	Each watcher structure must be initialised by a call to C<ev_init	774	Each watcher structure must be initialised by a call to C<ev_init
698	(watcher *, callback)>, which expects a callback to be provided. This	775	(watcher *, callback)>, which expects a callback to be provided. This
699	callback gets invoked each time the event occurs (or, in the case of io	776	callback gets invoked each time the event occurs (or, in the case of I/O
700	watchers, each time the event loop detects that the file descriptor given	777	watchers, each time the event loop detects that the file descriptor given
701	is readable and/or writable).	778	is readable and/or writable).
702		779
703	Each watcher type has its own C<< ev_<type>_set (watcher *, ...) >> macro	780	Each watcher type has its own C<< ev_<type>_set (watcher *, ...) >> macro
704	with arguments specific to this watcher type. There is also a macro	781	with arguments specific to this watcher type. There is also a macro
…		…
774	=item C<EV_FORK>	851	=item C<EV_FORK>
775		852
776	The event loop has been resumed in the child process after fork (see	853	The event loop has been resumed in the child process after fork (see
777	C<ev_fork>).	854	C<ev_fork>).
778		855
		856	=item C<EV_ASYNC>
		857
		858	The given async watcher has been asynchronously notified (see C<ev_async>).
		859
779	=item C<EV_ERROR>	860	=item C<EV_ERROR>
780		861
781	An unspecified error has occured, the watcher has been stopped. This might	862	An unspecified error has occurred, the watcher has been stopped. This might
782	happen because the watcher could not be properly started because libev	863	happen because the watcher could not be properly started because libev
783	ran out of memory, a file descriptor was found to be closed or any other	864	ran out of memory, a file descriptor was found to be closed or any other
784	problem. You best act on it by reporting the problem and somehow coping	865	problem. You best act on it by reporting the problem and somehow coping
785	with the watcher being stopped.	866	with the watcher being stopped.
786		867
787	Libev will usually signal a few "dummy" events together with an error,	868	Libev will usually signal a few "dummy" events together with an error,
788	for example it might indicate that a fd is readable or writable, and if	869	for example it might indicate that a fd is readable or writable, and if
789	your callbacks is well-written it can just attempt the operation and cope	870	your callbacks is well-written it can just attempt the operation and cope
790	with the error from read() or write(). This will not work in multithreaded	871	with the error from read() or write(). This will not work in multi-threaded
791	programs, though, so beware.	872	programs, though, so beware.
792		873
793	=back	874	=back
794		875
795	=head2 GENERIC WATCHER FUNCTIONS	876	=head2 GENERIC WATCHER FUNCTIONS
…		…
825	Although some watcher types do not have type-specific arguments	906	Although some watcher types do not have type-specific arguments
826	(e.g. C<ev_prepare>) you still need to call its C<set> macro.	907	(e.g. C<ev_prepare>) you still need to call its C<set> macro.
827		908
828	=item C<ev_TYPE_init> (ev_TYPE *watcher, callback, [args])	909	=item C<ev_TYPE_init> (ev_TYPE *watcher, callback, [args])
829		910
830	This convinience macro rolls both C<ev_init> and C<ev_TYPE_set> macro	911	This convenience macro rolls both C<ev_init> and C<ev_TYPE_set> macro
831	calls into a single call. This is the most convinient method to initialise	912	calls into a single call. This is the most convenient method to initialise
832	a watcher. The same limitations apply, of course.	913	a watcher. The same limitations apply, of course.
833		914
834	=item C<ev_TYPE_start> (loop *, ev_TYPE *watcher)	915	=item C<ev_TYPE_start> (loop *, ev_TYPE *watcher)
835		916
836	Starts (activates) the given watcher. Only active watchers will receive	917	Starts (activates) the given watcher. Only active watchers will receive
…		…
919	to associate arbitrary data with your watcher. If you need more data and	1000	to associate arbitrary data with your watcher. If you need more data and
920	don't want to allocate memory and store a pointer to it in that data	1001	don't want to allocate memory and store a pointer to it in that data
921	member, you can also "subclass" the watcher type and provide your own	1002	member, you can also "subclass" the watcher type and provide your own
922	data:	1003	data:
923		1004
924	struct my_io	1005	struct my_io
925	{	1006	{
926	struct ev_io io;	1007	struct ev_io io;
927	int otherfd;	1008	int otherfd;
928	void *somedata;	1009	void *somedata;
929	struct whatever *mostinteresting;	1010	struct whatever *mostinteresting;
930	}	1011	};
		1012
		1013	...
		1014	struct my_io w;
		1015	ev_io_init (&w.io, my_cb, fd, EV_READ);
931		1016
932	And since your callback will be called with a pointer to the watcher, you	1017	And since your callback will be called with a pointer to the watcher, you
933	can cast it back to your own type:	1018	can cast it back to your own type:
934		1019
935	static void my_cb (struct ev_loop *loop, struct ev_io *w_, int revents)	1020	static void my_cb (struct ev_loop *loop, struct ev_io *w_, int revents)
936	{	1021	{
937	struct my_io *w = (struct my_io *)w_;	1022	struct my_io *w = (struct my_io *)w_;
938	...	1023	...
939	}	1024	}
940		1025
941	More interesting and less C-conformant ways of casting your callback type	1026	More interesting and less C-conformant ways of casting your callback type
942	instead have been omitted.	1027	instead have been omitted.
943		1028
944	Another common scenario is having some data structure with multiple	1029	Another common scenario is to use some data structure with multiple
945	watchers:	1030	embedded watchers:
946		1031
947	struct my_biggy	1032	struct my_biggy
948	{	1033	{
949	int some_data;	1034	int some_data;
950	ev_timer t1;	1035	ev_timer t1;
951	ev_timer t2;	1036	ev_timer t2;
952	}	1037	}
953		1038
954	In this case getting the pointer to C<my_biggy> is a bit more complicated,	1039	In this case getting the pointer to C<my_biggy> is a bit more
955	you need to use C<offsetof>:	1040	complicated: Either you store the address of your C<my_biggy> struct
		1041	in the C<data> member of the watcher, or you need to use some pointer
		1042	arithmetic using C<offsetof> inside your watchers:
956		1043
957	#include <stddef.h>	1044	#include <stddef.h>
958		1045
959	static void	1046	static void
960	t1_cb (EV_P_ struct ev_timer *w, int revents)	1047	t1_cb (EV_P_ struct ev_timer *w, int revents)
961	{	1048	{
962	struct my_biggy big = (struct my_biggy *	1049	struct my_biggy big = (struct my_biggy *
963	(((char *)w) - offsetof (struct my_biggy, t1));	1050	(((char *)w) - offsetof (struct my_biggy, t1));
964	}	1051	}
965		1052
966	static void	1053	static void
967	t2_cb (EV_P_ struct ev_timer *w, int revents)	1054	t2_cb (EV_P_ struct ev_timer *w, int revents)
968	{	1055	{
969	struct my_biggy big = (struct my_biggy *	1056	struct my_biggy big = (struct my_biggy *
970	(((char *)w) - offsetof (struct my_biggy, t2));	1057	(((char *)w) - offsetof (struct my_biggy, t2));
971	}	1058	}
972		1059
973		1060
974	=head1 WATCHER TYPES	1061	=head1 WATCHER TYPES
975		1062
976	This section describes each watcher in detail, but will not repeat	1063	This section describes each watcher in detail, but will not repeat
…		…
1005	If you must do this, then force the use of a known-to-be-good backend	1092	If you must do this, then force the use of a known-to-be-good backend
1006	(at the time of this writing, this includes only C<EVBACKEND_SELECT> and	1093	(at the time of this writing, this includes only C<EVBACKEND_SELECT> and
1007	C<EVBACKEND_POLL>).	1094	C<EVBACKEND_POLL>).
1008		1095
1009	Another thing you have to watch out for is that it is quite easy to	1096	Another thing you have to watch out for is that it is quite easy to
1010	receive "spurious" readyness notifications, that is your callback might	1097	receive "spurious" readiness notifications, that is your callback might
1011	be called with C<EV_READ> but a subsequent C<read>(2) will actually block	1098	be called with C<EV_READ> but a subsequent C<read>(2) will actually block
1012	because there is no data. Not only are some backends known to create a	1099	because there is no data. Not only are some backends known to create a
1013	lot of those (for example solaris ports), it is very easy to get into	1100	lot of those (for example Solaris ports), it is very easy to get into
1014	this situation even with a relatively standard program structure. Thus	1101	this situation even with a relatively standard program structure. Thus
1015	it is best to always use non-blocking I/O: An extra C<read>(2) returning	1102	it is best to always use non-blocking I/O: An extra C<read>(2) returning
1016	C<EAGAIN> is far preferable to a program hanging until some data arrives.	1103	C<EAGAIN> is far preferable to a program hanging until some data arrives.
1017		1104
1018	If you cannot run the fd in non-blocking mode (for example you should not	1105	If you cannot run the fd in non-blocking mode (for example you should not
1019	play around with an Xlib connection), then you have to seperately re-test	1106	play around with an Xlib connection), then you have to separately re-test
1020	whether a file descriptor is really ready with a known-to-be good interface	1107	whether a file descriptor is really ready with a known-to-be good interface
1021	such as poll (fortunately in our Xlib example, Xlib already does this on	1108	such as poll (fortunately in our Xlib example, Xlib already does this on
1022	its own, so its quite safe to use).	1109	its own, so its quite safe to use).
1023		1110
1024	=head3 The special problem of disappearing file descriptors	1111	=head3 The special problem of disappearing file descriptors
…		…
1062	To support fork in your programs, you either have to call	1149	To support fork in your programs, you either have to call
1063	C<ev_default_fork ()> or C<ev_loop_fork ()> after a fork in the child,	1150	C<ev_default_fork ()> or C<ev_loop_fork ()> after a fork in the child,
1064	enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or	1151	enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or
1065	C<EVBACKEND_POLL>.	1152	C<EVBACKEND_POLL>.
1066		1153
		1154	=head3 The special problem of SIGPIPE
		1155
		1156	While not really specific to libev, it is easy to forget about SIGPIPE:
		1157	when writing to a pipe whose other end has been closed, your program gets
		1158	send a SIGPIPE, which, by default, aborts your program. For most programs
		1159	this is sensible behaviour, for daemons, this is usually undesirable.
		1160
		1161	So when you encounter spurious, unexplained daemon exits, make sure you
		1162	ignore SIGPIPE (and maybe make sure you log the exit status of your daemon
		1163	somewhere, as that would have given you a big clue).
		1164
1067		1165
1068	=head3 Watcher-Specific Functions	1166	=head3 Watcher-Specific Functions
1069		1167
1070	=over 4	1168	=over 4
1071		1169
1072	=item ev_io_init (ev_io *, callback, int fd, int events)	1170	=item ev_io_init (ev_io *, callback, int fd, int events)
1073		1171
1074	=item ev_io_set (ev_io *, int fd, int events)	1172	=item ev_io_set (ev_io *, int fd, int events)
1075		1173
1076	Configures an C<ev_io> watcher. The C<fd> is the file descriptor to	1174	Configures an C<ev_io> watcher. The C<fd> is the file descriptor to
1077	rceeive events for and events is either C<EV_READ>, C<EV_WRITE> or	1175	receive events for and events is either C<EV_READ>, C<EV_WRITE> or
1078	C<EV_READ | EV_WRITE> to receive the given events.	1176	C<EV_READ | EV_WRITE> to receive the given events.
1079		1177
1080	=item int fd [read-only]	1178	=item int fd [read-only]
1081		1179
1082	The file descriptor being watched.	1180	The file descriptor being watched.
…		…
1091		1189
1092	Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well	1190	Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well
1093	readable, but only once. Since it is likely line-buffered, you could	1191	readable, but only once. Since it is likely line-buffered, you could
1094	attempt to read a whole line in the callback.	1192	attempt to read a whole line in the callback.
1095		1193
1096	static void	1194	static void
1097	stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents)	1195	stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents)
1098	{	1196	{
1099	ev_io_stop (loop, w);	1197	ev_io_stop (loop, w);
1100	.. read from stdin here (or from w->fd) and haqndle any I/O errors	1198	.. read from stdin here (or from w->fd) and haqndle any I/O errors
1101	}	1199	}
1102		1200
1103	...	1201	...
1104	struct ev_loop *loop = ev_default_init (0);	1202	struct ev_loop *loop = ev_default_init (0);
1105	struct ev_io stdin_readable;	1203	struct ev_io stdin_readable;
1106	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);	1204	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);
1107	ev_io_start (loop, &stdin_readable);	1205	ev_io_start (loop, &stdin_readable);
1108	ev_loop (loop, 0);	1206	ev_loop (loop, 0);
1109		1207
1110		1208
1111	=head2 C<ev_timer> - relative and optionally repeating timeouts	1209	=head2 C<ev_timer> - relative and optionally repeating timeouts
1112		1210
1113	Timer watchers are simple relative timers that generate an event after a	1211	Timer watchers are simple relative timers that generate an event after a
1114	given time, and optionally repeating in regular intervals after that.	1212	given time, and optionally repeating in regular intervals after that.
1115		1213
1116	The timers are based on real time, that is, if you register an event that	1214	The timers are based on real time, that is, if you register an event that
1117	times out after an hour and you reset your system clock to last years	1215	times out after an hour and you reset your system clock to January last
1118	time, it will still time out after (roughly) and hour. "Roughly" because	1216	year, it will still time out after (roughly) and hour. "Roughly" because
1119	detecting time jumps is hard, and some inaccuracies are unavoidable (the	1217	detecting time jumps is hard, and some inaccuracies are unavoidable (the
1120	monotonic clock option helps a lot here).	1218	monotonic clock option helps a lot here).
		1219
		1220	The callback is guaranteed to be invoked only after its timeout has passed,
		1221	but if multiple timers become ready during the same loop iteration then
		1222	order of execution is undefined.
		1223
		1224	=head3 The special problem of time updates
		1225
		1226	Establishing the current time is a costly operation (it usually takes at
		1227	least two system calls): EV therefore updates its idea of the current
		1228	time only before and after C<ev_loop> polls for new events, which causes
		1229	a growing difference between C<ev_now ()> and C<ev_time ()> when handling
		1230	lots of events.
1121		1231
1122	The relative timeouts are calculated relative to the C<ev_now ()>	1232	The relative timeouts are calculated relative to the C<ev_now ()>
1123	time. This is usually the right thing as this timestamp refers to the time	1233	time. This is usually the right thing as this timestamp refers to the time
1124	of the event triggering whatever timeout you are modifying/starting. If	1234	of the event triggering whatever timeout you are modifying/starting. If
1125	you suspect event processing to be delayed and you I<need> to base the timeout	1235	you suspect event processing to be delayed and you I<need> to base the
1126	on the current time, use something like this to adjust for this:	1236	timeout on the current time, use something like this to adjust for this:
1127		1237
1128	ev_timer_set (&timer, after + ev_now () - ev_time (), 0.);	1238	ev_timer_set (&timer, after + ev_now () - ev_time (), 0.);
1129		1239
1130	The callback is guarenteed to be invoked only when its timeout has passed,	1240	If the event loop is suspended for a long time, you can also force an
1131	but if multiple timers become ready during the same loop iteration then	1241	update of the time returned by C<ev_now ()> by calling C<ev_now_update
1132	order of execution is undefined.	1242	()>.
1133		1243
1134	=head3 Watcher-Specific Functions and Data Members	1244	=head3 Watcher-Specific Functions and Data Members
1135		1245
1136	=over 4	1246	=over 4
1137		1247
1138	=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)	1248	=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
1139		1249
1140	=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)	1250	=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)
1141		1251
1142	Configure the timer to trigger after C<after> seconds. If C<repeat> is	1252	Configure the timer to trigger after C<after> seconds. If C<repeat>
1143	C<0.>, then it will automatically be stopped. If it is positive, then the	1253	is C<0.>, then it will automatically be stopped once the timeout is
1144	timer will automatically be configured to trigger again C<repeat> seconds	1254	reached. If it is positive, then the timer will automatically be
1145	later, again, and again, until stopped manually.	1255	configured to trigger again C<repeat> seconds later, again, and again,
		1256	until stopped manually.
1146		1257
1147	The timer itself will do a best-effort at avoiding drift, that is, if you	1258	The timer itself will do a best-effort at avoiding drift, that is, if
1148	configure a timer to trigger every 10 seconds, then it will trigger at	1259	you configure a timer to trigger every 10 seconds, then it will normally
1149	exactly 10 second intervals. If, however, your program cannot keep up with	1260	trigger at exactly 10 second intervals. If, however, your program cannot
1150	the timer (because it takes longer than those 10 seconds to do stuff) the	1261	keep up with the timer (because it takes longer than those 10 seconds to
1151	timer will not fire more than once per event loop iteration.	1262	do stuff) the timer will not fire more than once per event loop iteration.
1152		1263
1153	=item ev_timer_again (loop)	1264	=item ev_timer_again (loop, ev_timer *)
1154		1265
1155	This will act as if the timer timed out and restart it again if it is	1266	This will act as if the timer timed out and restart it again if it is
1156	repeating. The exact semantics are:	1267	repeating. The exact semantics are:
1157		1268
1158	If the timer is pending, its pending status is cleared.	1269	If the timer is pending, its pending status is cleared.
1159		1270
1160	If the timer is started but nonrepeating, stop it (as if it timed out).	1271	If the timer is started but non-repeating, stop it (as if it timed out).
1161		1272
1162	If the timer is repeating, either start it if necessary (with the	1273	If the timer is repeating, either start it if necessary (with the
1163	C<repeat> value), or reset the running timer to the C<repeat> value.	1274	C<repeat> value), or reset the running timer to the C<repeat> value.
1164		1275
1165	This sounds a bit complicated, but here is a useful and typical	1276	This sounds a bit complicated, but here is a useful and typical
1166	example: Imagine you have a tcp connection and you want a so-called idle	1277	example: Imagine you have a TCP connection and you want a so-called idle
1167	timeout, that is, you want to be called when there have been, say, 60	1278	timeout, that is, you want to be called when there have been, say, 60
1168	seconds of inactivity on the socket. The easiest way to do this is to	1279	seconds of inactivity on the socket. The easiest way to do this is to
1169	configure an C<ev_timer> with a C<repeat> value of C<60> and then call	1280	configure an C<ev_timer> with a C<repeat> value of C<60> and then call
1170	C<ev_timer_again> each time you successfully read or write some data. If	1281	C<ev_timer_again> each time you successfully read or write some data. If
1171	you go into an idle state where you do not expect data to travel on the	1282	you go into an idle state where you do not expect data to travel on the
…		…
1197		1308
1198	=head3 Examples	1309	=head3 Examples
1199		1310
1200	Example: Create a timer that fires after 60 seconds.	1311	Example: Create a timer that fires after 60 seconds.
1201		1312
1202	static void	1313	static void
1203	one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents)	1314	one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents)
1204	{	1315	{
1205	.. one minute over, w is actually stopped right here	1316	.. one minute over, w is actually stopped right here
1206	}	1317	}
1207		1318
1208	struct ev_timer mytimer;	1319	struct ev_timer mytimer;
1209	ev_timer_init (&mytimer, one_minute_cb, 60., 0.);	1320	ev_timer_init (&mytimer, one_minute_cb, 60., 0.);
1210	ev_timer_start (loop, &mytimer);	1321	ev_timer_start (loop, &mytimer);
1211		1322
1212	Example: Create a timeout timer that times out after 10 seconds of	1323	Example: Create a timeout timer that times out after 10 seconds of
1213	inactivity.	1324	inactivity.
1214		1325
1215	static void	1326	static void
1216	timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents)	1327	timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents)
1217	{	1328	{
1218	.. ten seconds without any activity	1329	.. ten seconds without any activity
1219	}	1330	}
1220		1331
1221	struct ev_timer mytimer;	1332	struct ev_timer mytimer;
1222	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */	1333	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */
1223	ev_timer_again (&mytimer); /* start timer */	1334	ev_timer_again (&mytimer); /* start timer */
1224	ev_loop (loop, 0);	1335	ev_loop (loop, 0);
1225		1336
1226	// and in some piece of code that gets executed on any "activity":	1337	// and in some piece of code that gets executed on any "activity":
1227	// reset the timeout to start ticking again at 10 seconds	1338	// reset the timeout to start ticking again at 10 seconds
1228	ev_timer_again (&mytimer);	1339	ev_timer_again (&mytimer);
1229		1340
1230		1341
1231	=head2 C<ev_periodic> - to cron or not to cron?	1342	=head2 C<ev_periodic> - to cron or not to cron?
1232		1343
1233	Periodic watchers are also timers of a kind, but they are very versatile	1344	Periodic watchers are also timers of a kind, but they are very versatile
1234	(and unfortunately a bit complex).	1345	(and unfortunately a bit complex).
1235		1346
1236	Unlike C<ev_timer>'s, they are not based on real time (or relative time)	1347	Unlike C<ev_timer>'s, they are not based on real time (or relative time)
1237	but on wallclock time (absolute time). You can tell a periodic watcher	1348	but on wall clock time (absolute time). You can tell a periodic watcher
1238	to trigger "at" some specific point in time. For example, if you tell a	1349	to trigger after some specific point in time. For example, if you tell a
1239	periodic watcher to trigger in 10 seconds (by specifiying e.g. C<ev_now ()	1350	periodic watcher to trigger in 10 seconds (by specifying e.g. C<ev_now ()
1240	+ 10.>) and then reset your system clock to the last year, then it will	1351	+ 10.>, that is, an absolute time not a delay) and then reset your system
		1352	clock to January of the previous year, then it will take more than year
1241	take a year to trigger the event (unlike an C<ev_timer>, which would trigger	1353	to trigger the event (unlike an C<ev_timer>, which would still trigger
1242	roughly 10 seconds later).	1354	roughly 10 seconds later as it uses a relative timeout).
1243		1355
1244	They can also be used to implement vastly more complex timers, such as	1356	C<ev_periodic>s can also be used to implement vastly more complex timers,
1245	triggering an event on each midnight, local time or other, complicated,	1357	such as triggering an event on each "midnight, local time", or other
1246	rules.	1358	complicated, rules.
1247		1359
1248	As with timers, the callback is guarenteed to be invoked only when the	1360	As with timers, the callback is guaranteed to be invoked only when the
1249	time (C<at>) has been passed, but if multiple periodic timers become ready	1361	time (C<at>) has passed, but if multiple periodic timers become ready
1250	during the same loop iteration then order of execution is undefined.	1362	during the same loop iteration then order of execution is undefined.
1251		1363
1252	=head3 Watcher-Specific Functions and Data Members	1364	=head3 Watcher-Specific Functions and Data Members
1253		1365
1254	=over 4	1366	=over 4
…		…
1262		1374
1263	=over 4	1375	=over 4
1264		1376
1265	=item * absolute timer (at = time, interval = reschedule_cb = 0)	1377	=item * absolute timer (at = time, interval = reschedule_cb = 0)
1266		1378
1267	In this configuration the watcher triggers an event at the wallclock time	1379	In this configuration the watcher triggers an event after the wall clock
1268	C<at> and doesn't repeat. It will not adjust when a time jump occurs,	1380	time C<at> has passed and doesn't repeat. It will not adjust when a time
1269	that is, if it is to be run at January 1st 2011 then it will run when the	1381	jump occurs, that is, if it is to be run at January 1st 2011 then it will
1270	system time reaches or surpasses this time.	1382	run when the system time reaches or surpasses this time.
1271		1383
1272	=item * non-repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)	1384	=item * repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)
1273		1385
1274	In this mode the watcher will always be scheduled to time out at the next	1386	In this mode the watcher will always be scheduled to time out at the next
1275	C<at + N * interval> time (for some integer N, which can also be negative)	1387	C<at + N * interval> time (for some integer N, which can also be negative)
1276	and then repeat, regardless of any time jumps.	1388	and then repeat, regardless of any time jumps.
1277		1389
1278	This can be used to create timers that do not drift with respect to system	1390	This can be used to create timers that do not drift with respect to system
1279	time:	1391	time, for example, here is a C<ev_periodic> that triggers each hour, on
		1392	the hour:
1280		1393
1281	ev_periodic_set (&periodic, 0., 3600., 0);	1394	ev_periodic_set (&periodic, 0., 3600., 0);
1282		1395
1283	This doesn't mean there will always be 3600 seconds in between triggers,	1396	This doesn't mean there will always be 3600 seconds in between triggers,
1284	but only that the the callback will be called when the system time shows a	1397	but only that the callback will be called when the system time shows a
1285	full hour (UTC), or more correctly, when the system time is evenly divisible	1398	full hour (UTC), or more correctly, when the system time is evenly divisible
1286	by 3600.	1399	by 3600.
1287		1400
1288	Another way to think about it (for the mathematically inclined) is that	1401	Another way to think about it (for the mathematically inclined) is that
1289	C<ev_periodic> will try to run the callback in this mode at the next possible	1402	C<ev_periodic> will try to run the callback in this mode at the next possible
1290	time where C<time = at (mod interval)>, regardless of any time jumps.	1403	time where C<time = at (mod interval)>, regardless of any time jumps.
1291		1404
1292	For numerical stability it is preferable that the C<at> value is near	1405	For numerical stability it is preferable that the C<at> value is near
1293	C<ev_now ()> (the current time), but there is no range requirement for	1406	C<ev_now ()> (the current time), but there is no range requirement for
1294	this value.	1407	this value, and in fact is often specified as zero.
		1408
		1409	Note also that there is an upper limit to how often a timer can fire (CPU
		1410	speed for example), so if C<interval> is very small then timing stability
		1411	will of course deteriorate. Libev itself tries to be exact to be about one
		1412	millisecond (if the OS supports it and the machine is fast enough).
1295		1413
1296	=item * manual reschedule mode (at and interval ignored, reschedule_cb = callback)	1414	=item * manual reschedule mode (at and interval ignored, reschedule_cb = callback)
1297		1415
1298	In this mode the values for C<interval> and C<at> are both being	1416	In this mode the values for C<interval> and C<at> are both being
1299	ignored. Instead, each time the periodic watcher gets scheduled, the	1417	ignored. Instead, each time the periodic watcher gets scheduled, the
1300	reschedule callback will be called with the watcher as first, and the	1418	reschedule callback will be called with the watcher as first, and the
1301	current time as second argument.	1419	current time as second argument.
1302		1420
1303	NOTE: I<This callback MUST NOT stop or destroy any periodic watcher,	1421	NOTE: I<This callback MUST NOT stop or destroy any periodic watcher,
1304	ever, or make any event loop modifications>. If you need to stop it,	1422	ever, or make ANY event loop modifications whatsoever>.
1305	return C<now + 1e30> (or so, fudge fudge) and stop it afterwards (e.g. by
1306	starting an C<ev_prepare> watcher, which is legal).
1307		1423
		1424	If you need to stop it, return C<now + 1e30> (or so, fudge fudge) and stop
		1425	it afterwards (e.g. by starting an C<ev_prepare> watcher, which is the
		1426	only event loop modification you are allowed to do).
		1427
1308	Its prototype is C<ev_tstamp (*reschedule_cb)(struct ev_periodic *w,	1428	The callback prototype is C<ev_tstamp (*reschedule_cb)(struct ev_periodic
1309	ev_tstamp now)>, e.g.:	1429	*w, ev_tstamp now)>, e.g.:
1310		1430
1311	static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)	1431	static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)
1312	{	1432	{
1313	return now + 60.;	1433	return now + 60.;
1314	}	1434	}
…		…
1316	It must return the next time to trigger, based on the passed time value	1436	It must return the next time to trigger, based on the passed time value
1317	(that is, the lowest time value larger than to the second argument). It	1437	(that is, the lowest time value larger than to the second argument). It
1318	will usually be called just before the callback will be triggered, but	1438	will usually be called just before the callback will be triggered, but
1319	might be called at other times, too.	1439	might be called at other times, too.
1320		1440
1321	NOTE: I<< This callback must always return a time that is later than the	1441	NOTE: I<< This callback must always return a time that is higher than or
1322	passed C<now> value >>. Not even C<now> itself will do, it I<must> be larger.	1442	equal to the passed C<now> value >>.
1323		1443
1324	This can be used to create very complex timers, such as a timer that	1444	This can be used to create very complex timers, such as a timer that
1325	triggers on each midnight, local time. To do this, you would calculate the	1445	triggers on "next midnight, local time". To do this, you would calculate the
1326	next midnight after C<now> and return the timestamp value for this. How	1446	next midnight after C<now> and return the timestamp value for this. How
1327	you do this is, again, up to you (but it is not trivial, which is the main	1447	you do this is, again, up to you (but it is not trivial, which is the main
1328	reason I omitted it as an example).	1448	reason I omitted it as an example).
1329		1449
1330	=back	1450	=back
…		…
1334	Simply stops and restarts the periodic watcher again. This is only useful	1454	Simply stops and restarts the periodic watcher again. This is only useful
1335	when you changed some parameters or the reschedule callback would return	1455	when you changed some parameters or the reschedule callback would return
1336	a different time than the last time it was called (e.g. in a crond like	1456	a different time than the last time it was called (e.g. in a crond like
1337	program when the crontabs have changed).	1457	program when the crontabs have changed).
1338		1458
		1459	=item ev_tstamp ev_periodic_at (ev_periodic *)
		1460
		1461	When active, returns the absolute time that the watcher is supposed to
		1462	trigger next.
		1463
1339	=item ev_tstamp offset [read-write]	1464	=item ev_tstamp offset [read-write]
1340		1465
1341	When repeating, this contains the offset value, otherwise this is the	1466	When repeating, this contains the offset value, otherwise this is the
1342	absolute point in time (the C<at> value passed to C<ev_periodic_set>).	1467	absolute point in time (the C<at> value passed to C<ev_periodic_set>).
1343		1468
…		…
1354		1479
1355	The current reschedule callback, or C<0>, if this functionality is	1480	The current reschedule callback, or C<0>, if this functionality is
1356	switched off. Can be changed any time, but changes only take effect when	1481	switched off. Can be changed any time, but changes only take effect when
1357	the periodic timer fires or C<ev_periodic_again> is being called.	1482	the periodic timer fires or C<ev_periodic_again> is being called.
1358		1483
1359	=item ev_tstamp at [read-only]
1360
1361	When active, contains the absolute time that the watcher is supposed to
1362	trigger next.
1363
1364	=back	1484	=back
1365		1485
1366	=head3 Examples	1486	=head3 Examples
1367		1487
1368	Example: Call a callback every hour, or, more precisely, whenever the	1488	Example: Call a callback every hour, or, more precisely, whenever the
1369	system clock is divisible by 3600. The callback invocation times have	1489	system clock is divisible by 3600. The callback invocation times have
1370	potentially a lot of jittering, but good long-term stability.	1490	potentially a lot of jitter, but good long-term stability.
1371		1491
1372	static void	1492	static void
1373	clock_cb (struct ev_loop *loop, struct ev_io *w, int revents)	1493	clock_cb (struct ev_loop *loop, struct ev_io *w, int revents)
1374	{	1494	{
1375	... its now a full hour (UTC, or TAI or whatever your clock follows)	1495	... its now a full hour (UTC, or TAI or whatever your clock follows)
1376	}	1496	}
1377		1497
1378	struct ev_periodic hourly_tick;	1498	struct ev_periodic hourly_tick;
1379	ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);	1499	ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);
1380	ev_periodic_start (loop, &hourly_tick);	1500	ev_periodic_start (loop, &hourly_tick);
1381		1501
1382	Example: The same as above, but use a reschedule callback to do it:	1502	Example: The same as above, but use a reschedule callback to do it:
1383		1503
1384	#include <math.h>	1504	#include <math.h>
1385		1505
1386	static ev_tstamp	1506	static ev_tstamp
1387	my_scheduler_cb (struct ev_periodic *w, ev_tstamp now)	1507	my_scheduler_cb (struct ev_periodic *w, ev_tstamp now)
1388	{	1508	{
1389	return fmod (now, 3600.) + 3600.;	1509	return fmod (now, 3600.) + 3600.;
1390	}	1510	}
1391		1511
1392	ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);	1512	ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);
1393		1513
1394	Example: Call a callback every hour, starting now:	1514	Example: Call a callback every hour, starting now:
1395		1515
1396	struct ev_periodic hourly_tick;	1516	struct ev_periodic hourly_tick;
1397	ev_periodic_init (&hourly_tick, clock_cb,	1517	ev_periodic_init (&hourly_tick, clock_cb,
1398	fmod (ev_now (loop), 3600.), 3600., 0);	1518	fmod (ev_now (loop), 3600.), 3600., 0);
1399	ev_periodic_start (loop, &hourly_tick);	1519	ev_periodic_start (loop, &hourly_tick);
1400		1520
1401		1521
1402	=head2 C<ev_signal> - signal me when a signal gets signalled!	1522	=head2 C<ev_signal> - signal me when a signal gets signalled!
1403		1523
1404	Signal watchers will trigger an event when the process receives a specific	1524	Signal watchers will trigger an event when the process receives a specific
…		…
1411	with the kernel (thus it coexists with your own signal handlers as long	1531	with the kernel (thus it coexists with your own signal handlers as long
1412	as you don't register any with libev). Similarly, when the last signal	1532	as you don't register any with libev). Similarly, when the last signal
1413	watcher for a signal is stopped libev will reset the signal handler to	1533	watcher for a signal is stopped libev will reset the signal handler to
1414	SIG_DFL (regardless of what it was set to before).	1534	SIG_DFL (regardless of what it was set to before).
1415		1535
		1536	If possible and supported, libev will install its handlers with
		1537	C<SA_RESTART> behaviour enabled, so system calls should not be unduly
		1538	interrupted. If you have a problem with system calls getting interrupted by
		1539	signals you can block all signals in an C<ev_check> watcher and unblock
		1540	them in an C<ev_prepare> watcher.
		1541
1416	=head3 Watcher-Specific Functions and Data Members	1542	=head3 Watcher-Specific Functions and Data Members
1417		1543
1418	=over 4	1544	=over 4
1419		1545
1420	=item ev_signal_init (ev_signal *, callback, int signum)	1546	=item ev_signal_init (ev_signal *, callback, int signum)
…		…
1428		1554
1429	The signal the watcher watches out for.	1555	The signal the watcher watches out for.
1430		1556
1431	=back	1557	=back
1432		1558
		1559	=head3 Examples
		1560
		1561	Example: Try to exit cleanly on SIGINT and SIGTERM.
		1562
		1563	static void
		1564	sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)
		1565	{
		1566	ev_unloop (loop, EVUNLOOP_ALL);
		1567	}
		1568
		1569	struct ev_signal signal_watcher;
		1570	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
		1571	ev_signal_start (loop, &sigint_cb);
		1572
1433		1573
1434	=head2 C<ev_child> - watch out for process status changes	1574	=head2 C<ev_child> - watch out for process status changes
1435		1575
1436	Child watchers trigger when your process receives a SIGCHLD in response to	1576	Child watchers trigger when your process receives a SIGCHLD in response to
1437	some child status changes (most typically when a child of yours dies).	1577	some child status changes (most typically when a child of yours dies). It
		1578	is permissible to install a child watcher I<after> the child has been
		1579	forked (which implies it might have already exited), as long as the event
		1580	loop isn't entered (or is continued from a watcher).
		1581
		1582	Only the default event loop is capable of handling signals, and therefore
		1583	you can only register child watchers in the default event loop.
		1584
		1585	=head3 Process Interaction
		1586
		1587	Libev grabs C<SIGCHLD> as soon as the default event loop is
		1588	initialised. This is necessary to guarantee proper behaviour even if
		1589	the first child watcher is started after the child exits. The occurrence
		1590	of C<SIGCHLD> is recorded asynchronously, but child reaping is done
		1591	synchronously as part of the event loop processing. Libev always reaps all
		1592	children, even ones not watched.
		1593
		1594	=head3 Overriding the Built-In Processing
		1595
		1596	Libev offers no special support for overriding the built-in child
		1597	processing, but if your application collides with libev's default child
		1598	handler, you can override it easily by installing your own handler for
		1599	C<SIGCHLD> after initialising the default loop, and making sure the
		1600	default loop never gets destroyed. You are encouraged, however, to use an
		1601	event-based approach to child reaping and thus use libev's support for
		1602	that, so other libev users can use C<ev_child> watchers freely.
		1603
		1604	=head3 Stopping the Child Watcher
		1605
		1606	Currently, the child watcher never gets stopped, even when the
		1607	child terminates, so normally one needs to stop the watcher in the
		1608	callback. Future versions of libev might stop the watcher automatically
		1609	when a child exit is detected.
1438		1610
1439	=head3 Watcher-Specific Functions and Data Members	1611	=head3 Watcher-Specific Functions and Data Members
1440		1612
1441	=over 4	1613	=over 4
1442		1614
…		…
1468		1640
1469	=back	1641	=back
1470		1642
1471	=head3 Examples	1643	=head3 Examples
1472		1644
1473	Example: Try to exit cleanly on SIGINT and SIGTERM.	1645	Example: C<fork()> a new process and install a child handler to wait for
		1646	its completion.
1474		1647
		1648	ev_child cw;
		1649
1475	static void	1650	static void
1476	sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)	1651	child_cb (EV_P_ struct ev_child *w, int revents)
1477	{	1652	{
1478	ev_unloop (loop, EVUNLOOP_ALL);	1653	ev_child_stop (EV_A_ w);
		1654	printf ("process %d exited with status %x\n", w->rpid, w->rstatus);
1479	}	1655	}
1480		1656
1481	struct ev_signal signal_watcher;	1657	pid_t pid = fork ();
1482	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);	1658
1483	ev_signal_start (loop, &sigint_cb);	1659	if (pid < 0)
		1660	// error
		1661	else if (pid == 0)
		1662	{
		1663	// the forked child executes here
		1664	exit (1);
		1665	}
		1666	else
		1667	{
		1668	ev_child_init (&cw, child_cb, pid, 0);
		1669	ev_child_start (EV_DEFAULT_ &cw);
		1670	}
1484		1671
1485		1672
1486	=head2 C<ev_stat> - did the file attributes just change?	1673	=head2 C<ev_stat> - did the file attributes just change?
1487		1674
1488	This watches a filesystem path for attribute changes. That is, it calls	1675	This watches a file system path for attribute changes. That is, it calls
1489	C<stat> regularly (or when the OS says it changed) and sees if it changed	1676	C<stat> regularly (or when the OS says it changed) and sees if it changed
1490	compared to the last time, invoking the callback if it did.	1677	compared to the last time, invoking the callback if it did.
1491		1678
1492	The path does not need to exist: changing from "path exists" to "path does	1679	The path does not need to exist: changing from "path exists" to "path does
1493	not exist" is a status change like any other. The condition "path does	1680	not exist" is a status change like any other. The condition "path does
…		…
1511	as even with OS-supported change notifications, this can be	1698	as even with OS-supported change notifications, this can be
1512	resource-intensive.	1699	resource-intensive.
1513		1700
1514	At the time of this writing, only the Linux inotify interface is	1701	At the time of this writing, only the Linux inotify interface is
1515	implemented (implementing kqueue support is left as an exercise for the	1702	implemented (implementing kqueue support is left as an exercise for the
		1703	reader, note, however, that the author sees no way of implementing ev_stat
1516	reader). Inotify will be used to give hints only and should not change the	1704	semantics with kqueue). Inotify will be used to give hints only and should
1517	semantics of C<ev_stat> watchers, which means that libev sometimes needs	1705	not change the semantics of C<ev_stat> watchers, which means that libev
1518	to fall back to regular polling again even with inotify, but changes are	1706	sometimes needs to fall back to regular polling again even with inotify,
1519	usually detected immediately, and if the file exists there will be no	1707	but changes are usually detected immediately, and if the file exists there
1520	polling.	1708	will be no polling.
		1709
		1710	=head3 ABI Issues (Largefile Support)
		1711
		1712	Libev by default (unless the user overrides this) uses the default
		1713	compilation environment, which means that on systems with large file
		1714	support disabled by default, you get the 32 bit version of the stat
		1715	structure. When using the library from programs that change the ABI to
		1716	use 64 bit file offsets the programs will fail. In that case you have to
		1717	compile libev with the same flags to get binary compatibility. This is
		1718	obviously the case with any flags that change the ABI, but the problem is
		1719	most noticeably disabled with ev_stat and large file support.
		1720
		1721	The solution for this is to lobby your distribution maker to make large
		1722	file interfaces available by default (as e.g. FreeBSD does) and not
		1723	optional. Libev cannot simply switch on large file support because it has
		1724	to exchange stat structures with application programs compiled using the
		1725	default compilation environment.
1521		1726
1522	=head3 Inotify	1727	=head3 Inotify
1523		1728
1524	When C<inotify (7)> support has been compiled into libev (generally only	1729	When C<inotify (7)> support has been compiled into libev (generally only
1525	available on Linux) and present at runtime, it will be used to speed up	1730	available on Linux) and present at runtime, it will be used to speed up
1526	change detection where possible. The inotify descriptor will be created lazily	1731	change detection where possible. The inotify descriptor will be created lazily
1527	when the first C<ev_stat> watcher is being started.	1732	when the first C<ev_stat> watcher is being started.
1528		1733
1529	Inotify presense does not change the semantics of C<ev_stat> watchers	1734	Inotify presence does not change the semantics of C<ev_stat> watchers
1530	except that changes might be detected earlier, and in some cases, to avoid	1735	except that changes might be detected earlier, and in some cases, to avoid
1531	making regular C<stat> calls. Even in the presense of inotify support	1736	making regular C<stat> calls. Even in the presence of inotify support
1532	there are many cases where libev has to resort to regular C<stat> polling.	1737	there are many cases where libev has to resort to regular C<stat> polling.
1533		1738
1534	(There is no support for kqueue, as apparently it cannot be used to	1739	(There is no support for kqueue, as apparently it cannot be used to
1535	implement this functionality, due to the requirement of having a file	1740	implement this functionality, due to the requirement of having a file
1536	descriptor open on the object at all times).	1741	descriptor open on the object at all times).
1537		1742
1538	=head3 The special problem of stat time resolution	1743	=head3 The special problem of stat time resolution
1539		1744
1540	The C<stat ()> syscall only supports full-second resolution portably, and	1745	The C<stat ()> system call only supports full-second resolution portably, and
1541	even on systems where the resolution is higher, many filesystems still	1746	even on systems where the resolution is higher, many file systems still
1542	only support whole seconds.	1747	only support whole seconds.
1543		1748
1544	That means that, if the time is the only thing that changes, you might	1749	That means that, if the time is the only thing that changes, you can
1545	miss updates: on the first update, C<ev_stat> detects a change and calls	1750	easily miss updates: on the first update, C<ev_stat> detects a change and
1546	your callback, which does something. When there is another update within	1751	calls your callback, which does something. When there is another update
1547	the same second, C<ev_stat> will be unable to detect it.	1752	within the same second, C<ev_stat> will be unable to detect it as the stat
		1753	data does not change.
1548		1754
1549	The solution to this is to delay acting on a change for a second (or till	1755	The solution to this is to delay acting on a change for slightly more
1550	the next second boundary), using a roughly one-second delay C<ev_timer>	1756	than a second (or till slightly after the next full second boundary), using
1551	(C<ev_timer_set (w, 0., 1.01); ev_timer_again (loop, w)>). The C<.01>	1757	a roughly one-second-delay C<ev_timer> (e.g. C<ev_timer_set (w, 0., 1.02);
1552	is added to work around small timing inconsistencies of some operating	1758	ev_timer_again (loop, w)>).
1553	systems.	1759
		1760	The C<.02> offset is added to work around small timing inconsistencies
		1761	of some operating systems (where the second counter of the current time
		1762	might be be delayed. One such system is the Linux kernel, where a call to
		1763	C<gettimeofday> might return a timestamp with a full second later than
		1764	a subsequent C<time> call - if the equivalent of C<time ()> is used to
		1765	update file times then there will be a small window where the kernel uses
		1766	the previous second to update file times but libev might already execute
		1767	the timer callback).
1554		1768
1555	=head3 Watcher-Specific Functions and Data Members	1769	=head3 Watcher-Specific Functions and Data Members
1556		1770
1557	=over 4	1771	=over 4
1558		1772
…		…
1564	C<path>. The C<interval> is a hint on how quickly a change is expected to	1778	C<path>. The C<interval> is a hint on how quickly a change is expected to
1565	be detected and should normally be specified as C<0> to let libev choose	1779	be detected and should normally be specified as C<0> to let libev choose
1566	a suitable value. The memory pointed to by C<path> must point to the same	1780	a suitable value. The memory pointed to by C<path> must point to the same
1567	path for as long as the watcher is active.	1781	path for as long as the watcher is active.
1568		1782
1569	The callback will be receive C<EV_STAT> when a change was detected,	1783	The callback will receive C<EV_STAT> when a change was detected, relative
1570	relative to the attributes at the time the watcher was started (or the	1784	to the attributes at the time the watcher was started (or the last change
1571	last change was detected).	1785	was detected).
1572		1786
1573	=item ev_stat_stat (ev_stat *)	1787	=item ev_stat_stat (loop, ev_stat *)
1574		1788
1575	Updates the stat buffer immediately with new values. If you change the	1789	Updates the stat buffer immediately with new values. If you change the
1576	watched path in your callback, you could call this fucntion to avoid	1790	watched path in your callback, you could call this function to avoid
1577	detecting this change (while introducing a race condition). Can also be	1791	detecting this change (while introducing a race condition if you are not
1578	useful simply to find out the new values.	1792	the only one changing the path). Can also be useful simply to find out the
		1793	new values.
1579		1794
1580	=item ev_statdata attr [read-only]	1795	=item ev_statdata attr [read-only]
1581		1796
1582	The most-recently detected attributes of the file. Although the type is of	1797	The most-recently detected attributes of the file. Although the type is
1583	C<ev_statdata>, this is usually the (or one of the) C<struct stat> types	1798	C<ev_statdata>, this is usually the (or one of the) C<struct stat> types
1584	suitable for your system. If the C<st_nlink> member is C<0>, then there	1799	suitable for your system, but you can only rely on the POSIX-standardised
		1800	members to be present. If the C<st_nlink> member is C<0>, then there was
1585	was some error while C<stat>ing the file.	1801	some error while C<stat>ing the file.
1586		1802
1587	=item ev_statdata prev [read-only]	1803	=item ev_statdata prev [read-only]
1588		1804
1589	The previous attributes of the file. The callback gets invoked whenever	1805	The previous attributes of the file. The callback gets invoked whenever
1590	C<prev> != C<attr>.	1806	C<prev> != C<attr>, or, more precisely, one or more of these members
		1807	differ: C<st_dev>, C<st_ino>, C<st_mode>, C<st_nlink>, C<st_uid>,
		1808	C<st_gid>, C<st_rdev>, C<st_size>, C<st_atime>, C<st_mtime>, C<st_ctime>.
1591		1809
1592	=item ev_tstamp interval [read-only]	1810	=item ev_tstamp interval [read-only]
1593		1811
1594	The specified interval.	1812	The specified interval.
1595		1813
1596	=item const char *path [read-only]	1814	=item const char *path [read-only]
1597		1815
1598	The filesystem path that is being watched.	1816	The file system path that is being watched.
1599		1817
1600	=back	1818	=back
1601		1819
1602	=head3 Examples	1820	=head3 Examples
1603		1821
1604	Example: Watch C</etc/passwd> for attribute changes.	1822	Example: Watch C</etc/passwd> for attribute changes.
1605		1823
1606	static void	1824	static void
1607	passwd_cb (struct ev_loop *loop, ev_stat *w, int revents)	1825	passwd_cb (struct ev_loop *loop, ev_stat *w, int revents)
1608	{	1826	{
1609	/* /etc/passwd changed in some way */	1827	/* /etc/passwd changed in some way */
1610	if (w->attr.st_nlink)	1828	if (w->attr.st_nlink)
1611	{	1829	{
1612	printf ("passwd current size %ld\n", (long)w->attr.st_size);	1830	printf ("passwd current size %ld\n", (long)w->attr.st_size);
1613	printf ("passwd current atime %ld\n", (long)w->attr.st_mtime);	1831	printf ("passwd current atime %ld\n", (long)w->attr.st_mtime);
1614	printf ("passwd current mtime %ld\n", (long)w->attr.st_mtime);	1832	printf ("passwd current mtime %ld\n", (long)w->attr.st_mtime);
1615	}	1833	}
1616	else	1834	else
1617	/* you shalt not abuse printf for puts */	1835	/* you shalt not abuse printf for puts */
1618	puts ("wow, /etc/passwd is not there, expect problems. "	1836	puts ("wow, /etc/passwd is not there, expect problems. "
1619	"if this is windows, they already arrived\n");	1837	"if this is windows, they already arrived\n");
1620	}	1838	}
1621		1839
1622	...	1840	...
1623	ev_stat passwd;	1841	ev_stat passwd;
1624		1842
1625	ev_stat_init (&passwd, passwd_cb, "/etc/passwd", 0.);	1843	ev_stat_init (&passwd, passwd_cb, "/etc/passwd", 0.);
1626	ev_stat_start (loop, &passwd);	1844	ev_stat_start (loop, &passwd);
1627		1845
1628	Example: Like above, but additionally use a one-second delay so we do not	1846	Example: Like above, but additionally use a one-second delay so we do not
1629	miss updates (however, frequent updates will delay processing, too, so	1847	miss updates (however, frequent updates will delay processing, too, so
1630	one might do the work both on C<ev_stat> callback invocation I<and> on	1848	one might do the work both on C<ev_stat> callback invocation I<and> on
1631	C<ev_timer> callback invocation).	1849	C<ev_timer> callback invocation).
1632		1850
1633	static ev_stat passwd;	1851	static ev_stat passwd;
1634	static ev_timer timer;	1852	static ev_timer timer;
1635		1853
1636	static void	1854	static void
1637	timer_cb (EV_P_ ev_timer *w, int revents)	1855	timer_cb (EV_P_ ev_timer *w, int revents)
1638	{	1856	{
1639	ev_timer_stop (EV_A_ w);	1857	ev_timer_stop (EV_A_ w);
1640		1858
1641	/* now it's one second after the most recent passwd change */	1859	/* now it's one second after the most recent passwd change */
1642	}	1860	}
1643		1861
1644	static void	1862	static void
1645	stat_cb (EV_P_ ev_stat *w, int revents)	1863	stat_cb (EV_P_ ev_stat *w, int revents)
1646	{	1864	{
1647	/* reset the one-second timer */	1865	/* reset the one-second timer */
1648	ev_timer_again (EV_A_ &timer);	1866	ev_timer_again (EV_A_ &timer);
1649	}	1867	}
1650		1868
1651	...	1869	...
1652	ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.);	1870	ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.);
1653	ev_stat_start (loop, &passwd);	1871	ev_stat_start (loop, &passwd);
1654	ev_timer_init (&timer, timer_cb, 0., 1.01);	1872	ev_timer_init (&timer, timer_cb, 0., 1.02);
1655		1873
1656		1874
1657	=head2 C<ev_idle> - when you've got nothing better to do...	1875	=head2 C<ev_idle> - when you've got nothing better to do...
1658		1876
1659	Idle watchers trigger events when no other events of the same or higher	1877	Idle watchers trigger events when no other events of the same or higher
…		…
1690	=head3 Examples	1908	=head3 Examples
1691		1909
1692	Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the	1910	Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the
1693	callback, free it. Also, use no error checking, as usual.	1911	callback, free it. Also, use no error checking, as usual.
1694		1912
1695	static void	1913	static void
1696	idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents)	1914	idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents)
1697	{	1915	{
1698	free (w);	1916	free (w);
1699	// now do something you wanted to do when the program has	1917	// now do something you wanted to do when the program has
1700	// no longer anything immediate to do.	1918	// no longer anything immediate to do.
1701	}	1919	}
1702		1920
1703	struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle));	1921	struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle));
1704	ev_idle_init (idle_watcher, idle_cb);	1922	ev_idle_init (idle_watcher, idle_cb);
1705	ev_idle_start (loop, idle_cb);	1923	ev_idle_start (loop, idle_cb);
1706		1924
1707		1925
1708	=head2 C<ev_prepare> and C<ev_check> - customise your event loop!	1926	=head2 C<ev_prepare> and C<ev_check> - customise your event loop!
1709		1927
1710	Prepare and check watchers are usually (but not always) used in tandem:	1928	Prepare and check watchers are usually (but not always) used in tandem:
…		…
1729		1947
1730	This is done by examining in each prepare call which file descriptors need	1948	This is done by examining in each prepare call which file descriptors need
1731	to be watched by the other library, registering C<ev_io> watchers for	1949	to be watched by the other library, registering C<ev_io> watchers for
1732	them and starting an C<ev_timer> watcher for any timeouts (many libraries	1950	them and starting an C<ev_timer> watcher for any timeouts (many libraries
1733	provide just this functionality). Then, in the check watcher you check for	1951	provide just this functionality). Then, in the check watcher you check for
1734	any events that occured (by checking the pending status of all watchers	1952	any events that occurred (by checking the pending status of all watchers
1735	and stopping them) and call back into the library. The I/O and timer	1953	and stopping them) and call back into the library. The I/O and timer
1736	callbacks will never actually be called (but must be valid nevertheless,	1954	callbacks will never actually be called (but must be valid nevertheless,
1737	because you never know, you know?).	1955	because you never know, you know?).
1738		1956
1739	As another example, the Perl Coro module uses these hooks to integrate	1957	As another example, the Perl Coro module uses these hooks to integrate
…		…
1747		1965
1748	It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>)	1966	It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>)
1749	priority, to ensure that they are being run before any other watchers	1967	priority, to ensure that they are being run before any other watchers
1750	after the poll. Also, C<ev_check> watchers (and C<ev_prepare> watchers,	1968	after the poll. Also, C<ev_check> watchers (and C<ev_prepare> watchers,
1751	too) should not activate ("feed") events into libev. While libev fully	1969	too) should not activate ("feed") events into libev. While libev fully
1752	supports this, they will be called before other C<ev_check> watchers	1970	supports this, they might get executed before other C<ev_check> watchers
1753	did their job. As C<ev_check> watchers are often used to embed other	1971	did their job. As C<ev_check> watchers are often used to embed other
1754	(non-libev) event loops those other event loops might be in an unusable	1972	(non-libev) event loops those other event loops might be in an unusable
1755	state until their C<ev_check> watcher ran (always remind yourself to	1973	state until their C<ev_check> watcher ran (always remind yourself to
1756	coexist peacefully with others).	1974	coexist peacefully with others).
1757		1975
…		…
1772	=head3 Examples	1990	=head3 Examples
1773		1991
1774	There are a number of principal ways to embed other event loops or modules	1992	There are a number of principal ways to embed other event loops or modules
1775	into libev. Here are some ideas on how to include libadns into libev	1993	into libev. Here are some ideas on how to include libadns into libev
1776	(there is a Perl module named C<EV::ADNS> that does this, which you could	1994	(there is a Perl module named C<EV::ADNS> that does this, which you could
1777	use for an actually working example. Another Perl module named C<EV::Glib>	1995	use as a working example. Another Perl module named C<EV::Glib> embeds a
1778	embeds a Glib main context into libev, and finally, C<Glib::EV> embeds EV	1996	Glib main context into libev, and finally, C<Glib::EV> embeds EV into the
1779	into the Glib event loop).	1997	Glib event loop).
1780		1998
1781	Method 1: Add IO watchers and a timeout watcher in a prepare handler,	1999	Method 1: Add IO watchers and a timeout watcher in a prepare handler,
1782	and in a check watcher, destroy them and call into libadns. What follows	2000	and in a check watcher, destroy them and call into libadns. What follows
1783	is pseudo-code only of course. This requires you to either use a low	2001	is pseudo-code only of course. This requires you to either use a low
1784	priority for the check watcher or use C<ev_clear_pending> explicitly, as	2002	priority for the check watcher or use C<ev_clear_pending> explicitly, as
1785	the callbacks for the IO/timeout watchers might not have been called yet.	2003	the callbacks for the IO/timeout watchers might not have been called yet.
1786		2004
1787	static ev_io iow [nfd];	2005	static ev_io iow [nfd];
1788	static ev_timer tw;	2006	static ev_timer tw;
1789		2007
1790	static void	2008	static void
1791	io_cb (ev_loop *loop, ev_io *w, int revents)	2009	io_cb (ev_loop *loop, ev_io *w, int revents)
1792	{	2010	{
1793	}	2011	}
1794		2012
1795	// create io watchers for each fd and a timer before blocking	2013	// create io watchers for each fd and a timer before blocking
1796	static void	2014	static void
1797	adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents)	2015	adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents)
1798	{	2016	{
1799	int timeout = 3600000;	2017	int timeout = 3600000;
1800	struct pollfd fds [nfd];	2018	struct pollfd fds [nfd];
1801	// actual code will need to loop here and realloc etc.	2019	// actual code will need to loop here and realloc etc.
1802	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));	2020	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
1803		2021
1804	/* the callback is illegal, but won't be called as we stop during check */	2022	/* the callback is illegal, but won't be called as we stop during check */
1805	ev_timer_init (&tw, 0, timeout * 1e-3);	2023	ev_timer_init (&tw, 0, timeout * 1e-3);
1806	ev_timer_start (loop, &tw);	2024	ev_timer_start (loop, &tw);
1807		2025
1808	// create one ev_io per pollfd	2026	// create one ev_io per pollfd
1809	for (int i = 0; i < nfd; ++i)	2027	for (int i = 0; i < nfd; ++i)
1810	{	2028	{
1811	ev_io_init (iow + i, io_cb, fds [i].fd,	2029	ev_io_init (iow + i, io_cb, fds [i].fd,
1812	((fds [i].events & POLLIN ? EV_READ : 0)	2030	((fds [i].events & POLLIN ? EV_READ : 0)
1813	| (fds [i].events & POLLOUT ? EV_WRITE : 0)));	2031	| (fds [i].events & POLLOUT ? EV_WRITE : 0)));
1814		2032
1815	fds [i].revents = 0;	2033	fds [i].revents = 0;
1816	ev_io_start (loop, iow + i);	2034	ev_io_start (loop, iow + i);
1817	}	2035	}
1818	}	2036	}
1819		2037
1820	// stop all watchers after blocking	2038	// stop all watchers after blocking
1821	static void	2039	static void
1822	adns_check_cb (ev_loop *loop, ev_check *w, int revents)	2040	adns_check_cb (ev_loop *loop, ev_check *w, int revents)
1823	{	2041	{
1824	ev_timer_stop (loop, &tw);	2042	ev_timer_stop (loop, &tw);
1825		2043
1826	for (int i = 0; i < nfd; ++i)	2044	for (int i = 0; i < nfd; ++i)
1827	{	2045	{
1828	// set the relevant poll flags	2046	// set the relevant poll flags
1829	// could also call adns_processreadable etc. here	2047	// could also call adns_processreadable etc. here
1830	struct pollfd *fd = fds + i;	2048	struct pollfd *fd = fds + i;
1831	int revents = ev_clear_pending (iow + i);	2049	int revents = ev_clear_pending (iow + i);
1832	if (revents & EV_READ ) fd->revents |= fd->events & POLLIN;	2050	if (revents & EV_READ ) fd->revents |= fd->events & POLLIN;
1833	if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT;	2051	if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT;
1834		2052
1835	// now stop the watcher	2053	// now stop the watcher
1836	ev_io_stop (loop, iow + i);	2054	ev_io_stop (loop, iow + i);
1837	}	2055	}
1838		2056
1839	adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));	2057	adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));
1840	}	2058	}
1841		2059
1842	Method 2: This would be just like method 1, but you run C<adns_afterpoll>	2060	Method 2: This would be just like method 1, but you run C<adns_afterpoll>
1843	in the prepare watcher and would dispose of the check watcher.	2061	in the prepare watcher and would dispose of the check watcher.
1844		2062
1845	Method 3: If the module to be embedded supports explicit event	2063	Method 3: If the module to be embedded supports explicit event
1846	notification (adns does), you can also make use of the actual watcher	2064	notification (libadns does), you can also make use of the actual watcher
1847	callbacks, and only destroy/create the watchers in the prepare watcher.	2065	callbacks, and only destroy/create the watchers in the prepare watcher.
1848		2066
1849	static void	2067	static void
1850	timer_cb (EV_P_ ev_timer *w, int revents)	2068	timer_cb (EV_P_ ev_timer *w, int revents)
1851	{	2069	{
1852	adns_state ads = (adns_state)w->data;	2070	adns_state ads = (adns_state)w->data;
1853	update_now (EV_A);	2071	update_now (EV_A);
1854		2072
1855	adns_processtimeouts (ads, &tv_now);	2073	adns_processtimeouts (ads, &tv_now);
1856	}	2074	}
1857		2075
1858	static void	2076	static void
1859	io_cb (EV_P_ ev_io *w, int revents)	2077	io_cb (EV_P_ ev_io *w, int revents)
1860	{	2078	{
1861	adns_state ads = (adns_state)w->data;	2079	adns_state ads = (adns_state)w->data;
1862	update_now (EV_A);	2080	update_now (EV_A);
1863		2081
1864	if (revents & EV_READ ) adns_processreadable (ads, w->fd, &tv_now);	2082	if (revents & EV_READ ) adns_processreadable (ads, w->fd, &tv_now);
1865	if (revents & EV_WRITE) adns_processwriteable (ads, w->fd, &tv_now);	2083	if (revents & EV_WRITE) adns_processwriteable (ads, w->fd, &tv_now);
1866	}	2084	}
1867		2085
1868	// do not ever call adns_afterpoll	2086	// do not ever call adns_afterpoll
1869		2087
1870	Method 4: Do not use a prepare or check watcher because the module you	2088	Method 4: Do not use a prepare or check watcher because the module you
1871	want to embed is too inflexible to support it. Instead, youc na override	2089	want to embed is too inflexible to support it. Instead, you can override
1872	their poll function. The drawback with this solution is that the main	2090	their poll function. The drawback with this solution is that the main
1873	loop is now no longer controllable by EV. The C<Glib::EV> module does	2091	loop is now no longer controllable by EV. The C<Glib::EV> module does
1874	this.	2092	this.
1875		2093
1876	static gint	2094	static gint
1877	event_poll_func (GPollFD *fds, guint nfds, gint timeout)	2095	event_poll_func (GPollFD *fds, guint nfds, gint timeout)
1878	{	2096	{
1879	int got_events = 0;	2097	int got_events = 0;
1880		2098
1881	for (n = 0; n < nfds; ++n)	2099	for (n = 0; n < nfds; ++n)
1882	// create/start io watcher that sets the relevant bits in fds[n] and increment got_events	2100	// create/start io watcher that sets the relevant bits in fds[n] and increment got_events
1883		2101
1884	if (timeout >= 0)	2102	if (timeout >= 0)
1885	// create/start timer	2103	// create/start timer
1886		2104
1887	// poll	2105	// poll
1888	ev_loop (EV_A_ 0);	2106	ev_loop (EV_A_ 0);
1889		2107
1890	// stop timer again	2108	// stop timer again
1891	if (timeout >= 0)	2109	if (timeout >= 0)
1892	ev_timer_stop (EV_A_ &to);	2110	ev_timer_stop (EV_A_ &to);
1893		2111
1894	// stop io watchers again - their callbacks should have set	2112	// stop io watchers again - their callbacks should have set
1895	for (n = 0; n < nfds; ++n)	2113	for (n = 0; n < nfds; ++n)
1896	ev_io_stop (EV_A_ iow [n]);	2114	ev_io_stop (EV_A_ iow [n]);
1897		2115
1898	return got_events;	2116	return got_events;
1899	}	2117	}
1900		2118
1901		2119
1902	=head2 C<ev_embed> - when one backend isn't enough...	2120	=head2 C<ev_embed> - when one backend isn't enough...
1903		2121
1904	This is a rather advanced watcher type that lets you embed one event loop	2122	This is a rather advanced watcher type that lets you embed one event loop
…		…
1960		2178
1961	Configures the watcher to embed the given loop, which must be	2179	Configures the watcher to embed the given loop, which must be
1962	embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be	2180	embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be
1963	invoked automatically, otherwise it is the responsibility of the callback	2181	invoked automatically, otherwise it is the responsibility of the callback
1964	to invoke it (it will continue to be called until the sweep has been done,	2182	to invoke it (it will continue to be called until the sweep has been done,
1965	if you do not want thta, you need to temporarily stop the embed watcher).	2183	if you do not want that, you need to temporarily stop the embed watcher).
1966		2184
1967	=item ev_embed_sweep (loop, ev_embed *)	2185	=item ev_embed_sweep (loop, ev_embed *)
1968		2186
1969	Make a single, non-blocking sweep over the embedded loop. This works	2187	Make a single, non-blocking sweep over the embedded loop. This works
1970	similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most	2188	similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most
1971	apropriate way for embedded loops.	2189	appropriate way for embedded loops.
1972		2190
1973	=item struct ev_loop *other [read-only]	2191	=item struct ev_loop *other [read-only]
1974		2192
1975	The embedded event loop.	2193	The embedded event loop.
1976		2194
…		…
1978		2196
1979	=head3 Examples	2197	=head3 Examples
1980		2198
1981	Example: Try to get an embeddable event loop and embed it into the default	2199	Example: Try to get an embeddable event loop and embed it into the default
1982	event loop. If that is not possible, use the default loop. The default	2200	event loop. If that is not possible, use the default loop. The default
1983	loop is stored in C<loop_hi>, while the mebeddable loop is stored in	2201	loop is stored in C<loop_hi>, while the embeddable loop is stored in
1984	C<loop_lo> (which is C<loop_hi> in the acse no embeddable loop can be	2202	C<loop_lo> (which is C<loop_hi> in the case no embeddable loop can be
1985	used).	2203	used).
1986		2204
1987	struct ev_loop *loop_hi = ev_default_init (0);	2205	struct ev_loop *loop_hi = ev_default_init (0);
1988	struct ev_loop *loop_lo = 0;	2206	struct ev_loop *loop_lo = 0;
1989	struct ev_embed embed;	2207	struct ev_embed embed;
1990		2208
1991	// see if there is a chance of getting one that works	2209	// see if there is a chance of getting one that works
1992	// (remember that a flags value of 0 means autodetection)	2210	// (remember that a flags value of 0 means autodetection)
1993	loop_lo = ev_embeddable_backends () & ev_recommended_backends ()	2211	loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
1994	? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())	2212	? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
1995	: 0;	2213	: 0;
1996		2214
1997	// if we got one, then embed it, otherwise default to loop_hi	2215	// if we got one, then embed it, otherwise default to loop_hi
1998	if (loop_lo)	2216	if (loop_lo)
1999	{	2217	{
2000	ev_embed_init (&embed, 0, loop_lo);	2218	ev_embed_init (&embed, 0, loop_lo);
2001	ev_embed_start (loop_hi, &embed);	2219	ev_embed_start (loop_hi, &embed);
2002	}	2220	}
2003	else	2221	else
2004	loop_lo = loop_hi;	2222	loop_lo = loop_hi;
2005		2223
2006	Example: Check if kqueue is available but not recommended and create	2224	Example: Check if kqueue is available but not recommended and create
2007	a kqueue backend for use with sockets (which usually work with any	2225	a kqueue backend for use with sockets (which usually work with any
2008	kqueue implementation). Store the kqueue/socket-only event loop in	2226	kqueue implementation). Store the kqueue/socket-only event loop in
2009	C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).	2227	C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).
2010		2228
2011	struct ev_loop *loop = ev_default_init (0);	2229	struct ev_loop *loop = ev_default_init (0);
2012	struct ev_loop *loop_socket = 0;	2230	struct ev_loop *loop_socket = 0;
2013	struct ev_embed embed;	2231	struct ev_embed embed;
2014		2232
2015	if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)	2233	if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
2016	if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))	2234	if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
2017	{	2235	{
2018	ev_embed_init (&embed, 0, loop_socket);	2236	ev_embed_init (&embed, 0, loop_socket);
2019	ev_embed_start (loop, &embed);	2237	ev_embed_start (loop, &embed);
2020	}	2238	}
2021		2239
2022	if (!loop_socket)	2240	if (!loop_socket)
2023	loop_socket = loop;	2241	loop_socket = loop;
2024		2242
2025	// now use loop_socket for all sockets, and loop for everything else	2243	// now use loop_socket for all sockets, and loop for everything else
2026		2244
2027		2245
2028	=head2 C<ev_fork> - the audacity to resume the event loop after a fork	2246	=head2 C<ev_fork> - the audacity to resume the event loop after a fork
2029		2247
2030	Fork watchers are called when a C<fork ()> was detected (usually because	2248	Fork watchers are called when a C<fork ()> was detected (usually because
…		…
2046	believe me.	2264	believe me.
2047		2265
2048	=back	2266	=back
2049		2267
2050		2268
		2269	=head2 C<ev_async> - how to wake up another event loop
		2270
		2271	In general, you cannot use an C<ev_loop> from multiple threads or other
		2272	asynchronous sources such as signal handlers (as opposed to multiple event
		2273	loops - those are of course safe to use in different threads).
		2274
		2275	Sometimes, however, you need to wake up another event loop you do not
		2276	control, for example because it belongs to another thread. This is what
		2277	C<ev_async> watchers do: as long as the C<ev_async> watcher is active, you
		2278	can signal it by calling C<ev_async_send>, which is thread- and signal
		2279	safe.
		2280
		2281	This functionality is very similar to C<ev_signal> watchers, as signals,
		2282	too, are asynchronous in nature, and signals, too, will be compressed
		2283	(i.e. the number of callback invocations may be less than the number of
		2284	C<ev_async_sent> calls).
		2285
		2286	Unlike C<ev_signal> watchers, C<ev_async> works with any event loop, not
		2287	just the default loop.
		2288
		2289	=head3 Queueing
		2290
		2291	C<ev_async> does not support queueing of data in any way. The reason
		2292	is that the author does not know of a simple (or any) algorithm for a
		2293	multiple-writer-single-reader queue that works in all cases and doesn't
		2294	need elaborate support such as pthreads.
		2295
		2296	That means that if you want to queue data, you have to provide your own
		2297	queue. But at least I can tell you would implement locking around your
		2298	queue:
		2299
		2300	=over 4
		2301
		2302	=item queueing from a signal handler context
		2303
		2304	To implement race-free queueing, you simply add to the queue in the signal
		2305	handler but you block the signal handler in the watcher callback. Here is an example that does that for
		2306	some fictitious SIGUSR1 handler:
		2307
		2308	static ev_async mysig;
		2309
		2310	static void
		2311	sigusr1_handler (void)
		2312	{
		2313	sometype data;
		2314
		2315	// no locking etc.
		2316	queue_put (data);
		2317	ev_async_send (EV_DEFAULT_ &mysig);
		2318	}
		2319
		2320	static void
		2321	mysig_cb (EV_P_ ev_async *w, int revents)
		2322	{
		2323	sometype data;
		2324	sigset_t block, prev;
		2325
		2326	sigemptyset (&block);
		2327	sigaddset (&block, SIGUSR1);
		2328	sigprocmask (SIG_BLOCK, &block, &prev);
		2329
		2330	while (queue_get (&data))
		2331	process (data);
		2332
		2333	if (sigismember (&prev, SIGUSR1)
		2334	sigprocmask (SIG_UNBLOCK, &block, 0);
		2335	}
		2336
		2337	(Note: pthreads in theory requires you to use C<pthread_setmask>
		2338	instead of C<sigprocmask> when you use threads, but libev doesn't do it
		2339	either...).
		2340
		2341	=item queueing from a thread context
		2342
		2343	The strategy for threads is different, as you cannot (easily) block
		2344	threads but you can easily preempt them, so to queue safely you need to
		2345	employ a traditional mutex lock, such as in this pthread example:
		2346
		2347	static ev_async mysig;
		2348	static pthread_mutex_t mymutex = PTHREAD_MUTEX_INITIALIZER;
		2349
		2350	static void
		2351	otherthread (void)
		2352	{
		2353	// only need to lock the actual queueing operation
		2354	pthread_mutex_lock (&mymutex);
		2355	queue_put (data);
		2356	pthread_mutex_unlock (&mymutex);
		2357
		2358	ev_async_send (EV_DEFAULT_ &mysig);
		2359	}
		2360
		2361	static void
		2362	mysig_cb (EV_P_ ev_async *w, int revents)
		2363	{
		2364	pthread_mutex_lock (&mymutex);
		2365
		2366	while (queue_get (&data))
		2367	process (data);
		2368
		2369	pthread_mutex_unlock (&mymutex);
		2370	}
		2371
		2372	=back
		2373
		2374
		2375	=head3 Watcher-Specific Functions and Data Members
		2376
		2377	=over 4
		2378
		2379	=item ev_async_init (ev_async *, callback)
		2380
		2381	Initialises and configures the async watcher - it has no parameters of any
		2382	kind. There is a C<ev_asynd_set> macro, but using it is utterly pointless,
		2383	believe me.
		2384
		2385	=item ev_async_send (loop, ev_async *)
		2386
		2387	Sends/signals/activates the given C<ev_async> watcher, that is, feeds
		2388	an C<EV_ASYNC> event on the watcher into the event loop. Unlike
		2389	C<ev_feed_event>, this call is safe to do in other threads, signal or
		2390	similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding
		2391	section below on what exactly this means).
		2392
		2393	This call incurs the overhead of a system call only once per loop iteration,
		2394	so while the overhead might be noticeable, it doesn't apply to repeated
		2395	calls to C<ev_async_send>.
		2396
		2397	=item bool = ev_async_pending (ev_async *)
		2398
		2399	Returns a non-zero value when C<ev_async_send> has been called on the
		2400	watcher but the event has not yet been processed (or even noted) by the
		2401	event loop.
		2402
		2403	C<ev_async_send> sets a flag in the watcher and wakes up the loop. When
		2404	the loop iterates next and checks for the watcher to have become active,
		2405	it will reset the flag again. C<ev_async_pending> can be used to very
		2406	quickly check whether invoking the loop might be a good idea.
		2407
		2408	Not that this does I<not> check whether the watcher itself is pending, only
		2409	whether it has been requested to make this watcher pending.
		2410
		2411	=back
		2412
		2413
2051	=head1 OTHER FUNCTIONS	2414	=head1 OTHER FUNCTIONS
2052		2415
2053	There are some other functions of possible interest. Described. Here. Now.	2416	There are some other functions of possible interest. Described. Here. Now.
2054		2417
2055	=over 4	2418	=over 4
…		…
2062	or timeout without having to allocate/configure/start/stop/free one or	2425	or timeout without having to allocate/configure/start/stop/free one or
2063	more watchers yourself.	2426	more watchers yourself.
2064		2427
2065	If C<fd> is less than 0, then no I/O watcher will be started and events	2428	If C<fd> is less than 0, then no I/O watcher will be started and events
2066	is being ignored. Otherwise, an C<ev_io> watcher for the given C<fd> and	2429	is being ignored. Otherwise, an C<ev_io> watcher for the given C<fd> and
2067	C<events> set will be craeted and started.	2430	C<events> set will be created and started.
2068		2431
2069	If C<timeout> is less than 0, then no timeout watcher will be	2432	If C<timeout> is less than 0, then no timeout watcher will be
2070	started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and	2433	started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and
2071	repeat = 0) will be started. While C<0> is a valid timeout, it is of	2434	repeat = 0) will be started. While C<0> is a valid timeout, it is of
2072	dubious value.	2435	dubious value.
…		…
2074	The callback has the type C<void (*cb)(int revents, void *arg)> and gets	2437	The callback has the type C<void (*cb)(int revents, void *arg)> and gets
2075	passed an C<revents> set like normal event callbacks (a combination of	2438	passed an C<revents> set like normal event callbacks (a combination of
2076	C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg>	2439	C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg>
2077	value passed to C<ev_once>:	2440	value passed to C<ev_once>:
2078		2441
2079	static void stdin_ready (int revents, void *arg)	2442	static void stdin_ready (int revents, void *arg)
2080	{	2443	{
2081	if (revents & EV_TIMEOUT)	2444	if (revents & EV_TIMEOUT)
2082	/* doh, nothing entered */;	2445	/* doh, nothing entered */;
2083	else if (revents & EV_READ)	2446	else if (revents & EV_READ)
2084	/* stdin might have data for us, joy! */;	2447	/* stdin might have data for us, joy! */;
2085	}	2448	}
2086		2449
2087	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);	2450	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
2088		2451
2089	=item ev_feed_event (ev_loop *, watcher *, int revents)	2452	=item ev_feed_event (ev_loop *, watcher *, int revents)
2090		2453
2091	Feeds the given event set into the event loop, as if the specified event	2454	Feeds the given event set into the event loop, as if the specified event
2092	had happened for the specified watcher (which must be a pointer to an	2455	had happened for the specified watcher (which must be a pointer to an
…		…
2097	Feed an event on the given fd, as if a file descriptor backend detected	2460	Feed an event on the given fd, as if a file descriptor backend detected
2098	the given events it.	2461	the given events it.
2099		2462
2100	=item ev_feed_signal_event (ev_loop *loop, int signum)	2463	=item ev_feed_signal_event (ev_loop *loop, int signum)
2101		2464
2102	Feed an event as if the given signal occured (C<loop> must be the default	2465	Feed an event as if the given signal occurred (C<loop> must be the default
2103	loop!).	2466	loop!).
2104		2467
2105	=back	2468	=back
2106		2469
2107		2470
…		…
2123		2486
2124	=item * Priorities are not currently supported. Initialising priorities	2487	=item * Priorities are not currently supported. Initialising priorities
2125	will fail and all watchers will have the same priority, even though there	2488	will fail and all watchers will have the same priority, even though there
2126	is an ev_pri field.	2489	is an ev_pri field.
2127		2490
		2491	=item * In libevent, the last base created gets the signals, in libev, the
		2492	first base created (== the default loop) gets the signals.
		2493
2128	=item * Other members are not supported.	2494	=item * Other members are not supported.
2129		2495
2130	=item * The libev emulation is I<not> ABI compatible to libevent, you need	2496	=item * The libev emulation is I<not> ABI compatible to libevent, you need
2131	to use the libev header file and library.	2497	to use the libev header file and library.
2132		2498
2133	=back	2499	=back
2134		2500
2135	=head1 C++ SUPPORT	2501	=head1 C++ SUPPORT
2136		2502
2137	Libev comes with some simplistic wrapper classes for C++ that mainly allow	2503	Libev comes with some simplistic wrapper classes for C++ that mainly allow
2138	you to use some convinience methods to start/stop watchers and also change	2504	you to use some convenience methods to start/stop watchers and also change
2139	the callback model to a model using method callbacks on objects.	2505	the callback model to a model using method callbacks on objects.
2140		2506
2141	To use it,	2507	To use it,
2142		2508
2143	#include <ev++.h>	2509	#include <ev++.h>
2144		2510
2145	This automatically includes F<ev.h> and puts all of its definitions (many	2511	This automatically includes F<ev.h> and puts all of its definitions (many
2146	of them macros) into the global namespace. All C++ specific things are	2512	of them macros) into the global namespace. All C++ specific things are
2147	put into the C<ev> namespace. It should support all the same embedding	2513	put into the C<ev> namespace. It should support all the same embedding
2148	options as F<ev.h>, most notably C<EV_MULTIPLICITY>.	2514	options as F<ev.h>, most notably C<EV_MULTIPLICITY>.
…		…
2215	your compiler is good :), then the method will be fully inlined into the	2581	your compiler is good :), then the method will be fully inlined into the
2216	thunking function, making it as fast as a direct C callback.	2582	thunking function, making it as fast as a direct C callback.
2217		2583
2218	Example: simple class declaration and watcher initialisation	2584	Example: simple class declaration and watcher initialisation
2219		2585
2220	struct myclass	2586	struct myclass
2221	{	2587	{
2222	void io_cb (ev::io &w, int revents) { }	2588	void io_cb (ev::io &w, int revents) { }
2223	}	2589	}
2224		2590
2225	myclass obj;	2591	myclass obj;
2226	ev::io iow;	2592	ev::io iow;
2227	iow.set <myclass, &myclass::io_cb> (&obj);	2593	iow.set <myclass, &myclass::io_cb> (&obj);
2228		2594
2229	=item w->set<function> (void *data = 0)	2595	=item w->set<function> (void *data = 0)
2230		2596
2231	Also sets a callback, but uses a static method or plain function as	2597	Also sets a callback, but uses a static method or plain function as
2232	callback. The optional C<data> argument will be stored in the watcher's	2598	callback. The optional C<data> argument will be stored in the watcher's
…		…
2236		2602
2237	See the method-C<set> above for more details.	2603	See the method-C<set> above for more details.
2238		2604
2239	Example:	2605	Example:
2240		2606
2241	static void io_cb (ev::io &w, int revents) { }	2607	static void io_cb (ev::io &w, int revents) { }
2242	iow.set <io_cb> ();	2608	iow.set <io_cb> ();
2243		2609
2244	=item w->set (struct ev_loop *)	2610	=item w->set (struct ev_loop *)
2245		2611
2246	Associates a different C<struct ev_loop> with this watcher. You can only	2612	Associates a different C<struct ev_loop> with this watcher. You can only
2247	do this when the watcher is inactive (and not pending either).	2613	do this when the watcher is inactive (and not pending either).
2248		2614
2249	=item w->set ([args])	2615	=item w->set ([arguments])
2250		2616
2251	Basically the same as C<ev_TYPE_set>, with the same args. Must be	2617	Basically the same as C<ev_TYPE_set>, with the same arguments. Must be
2252	called at least once. Unlike the C counterpart, an active watcher gets	2618	called at least once. Unlike the C counterpart, an active watcher gets
2253	automatically stopped and restarted when reconfiguring it with this	2619	automatically stopped and restarted when reconfiguring it with this
2254	method.	2620	method.
2255		2621
2256	=item w->start ()	2622	=item w->start ()
…		…
2280	=back	2646	=back
2281		2647
2282	Example: Define a class with an IO and idle watcher, start one of them in	2648	Example: Define a class with an IO and idle watcher, start one of them in
2283	the constructor.	2649	the constructor.
2284		2650
2285	class myclass	2651	class myclass
2286	{	2652	{
2287	ev::io io; void io_cb (ev::io &w, int revents);	2653	ev::io io; void io_cb (ev::io &w, int revents);
2288	ev:idle idle void idle_cb (ev::idle &w, int revents);	2654	ev:idle idle void idle_cb (ev::idle &w, int revents);
2289		2655
2290	myclass (int fd)	2656	myclass (int fd)
2291	{	2657	{
2292	io .set <myclass, &myclass::io_cb > (this);	2658	io .set <myclass, &myclass::io_cb > (this);
2293	idle.set <myclass, &myclass::idle_cb> (this);	2659	idle.set <myclass, &myclass::idle_cb> (this);
2294		2660
2295	io.start (fd, ev::READ);	2661	io.start (fd, ev::READ);
2296	}	2662	}
2297	};	2663	};
		2664
		2665
		2666	=head1 OTHER LANGUAGE BINDINGS
		2667
		2668	Libev does not offer other language bindings itself, but bindings for a
		2669	number of languages exist in the form of third-party packages. If you know
		2670	any interesting language binding in addition to the ones listed here, drop
		2671	me a note.
		2672
		2673	=over 4
		2674
		2675	=item Perl
		2676
		2677	The EV module implements the full libev API and is actually used to test
		2678	libev. EV is developed together with libev. Apart from the EV core module,
		2679	there are additional modules that implement libev-compatible interfaces
		2680	to C<libadns> (C<EV::ADNS>), C<Net::SNMP> (C<Net::SNMP::EV>) and the
		2681	C<libglib> event core (C<Glib::EV> and C<EV::Glib>).
		2682
		2683	It can be found and installed via CPAN, its homepage is at
		2684	L<http://software.schmorp.de/pkg/EV>.
		2685
		2686	=item Python
		2687
		2688	Python bindings can be found at L<http://code.google.com/p/pyev/>. It
		2689	seems to be quite complete and well-documented. Note, however, that the
		2690	patch they require for libev is outright dangerous as it breaks the ABI
		2691	for everybody else, and therefore, should never be applied in an installed
		2692	libev (if python requires an incompatible ABI then it needs to embed
		2693	libev).
		2694
		2695	=item Ruby
		2696
		2697	Tony Arcieri has written a ruby extension that offers access to a subset
		2698	of the libev API and adds file handle abstractions, asynchronous DNS and
		2699	more on top of it. It can be found via gem servers. Its homepage is at
		2700	L<http://rev.rubyforge.org/>.
		2701
		2702	=item D
		2703
		2704	Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to
		2705	be found at L<http://proj.llucax.com.ar/wiki/evd>.
		2706
		2707	=back
2298		2708
2299		2709
2300	=head1 MACRO MAGIC	2710	=head1 MACRO MAGIC
2301		2711
2302	Libev can be compiled with a variety of options, the most fundamantal	2712	Libev can be compiled with a variety of options, the most fundamental
2303	of which is C<EV_MULTIPLICITY>. This option determines whether (most)	2713	of which is C<EV_MULTIPLICITY>. This option determines whether (most)
2304	functions and callbacks have an initial C<struct ev_loop *> argument.	2714	functions and callbacks have an initial C<struct ev_loop *> argument.
2305		2715
2306	To make it easier to write programs that cope with either variant, the	2716	To make it easier to write programs that cope with either variant, the
2307	following macros are defined:	2717	following macros are defined:
…		…
2312		2722
2313	This provides the loop I<argument> for functions, if one is required ("ev	2723	This provides the loop I<argument> for functions, if one is required ("ev
2314	loop argument"). The C<EV_A> form is used when this is the sole argument,	2724	loop argument"). The C<EV_A> form is used when this is the sole argument,
2315	C<EV_A_> is used when other arguments are following. Example:	2725	C<EV_A_> is used when other arguments are following. Example:
2316		2726
2317	ev_unref (EV_A);	2727	ev_unref (EV_A);
2318	ev_timer_add (EV_A_ watcher);	2728	ev_timer_add (EV_A_ watcher);
2319	ev_loop (EV_A_ 0);	2729	ev_loop (EV_A_ 0);
2320		2730
2321	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,	2731	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,
2322	which is often provided by the following macro.	2732	which is often provided by the following macro.
2323		2733
2324	=item C<EV_P>, C<EV_P_>	2734	=item C<EV_P>, C<EV_P_>
2325		2735
2326	This provides the loop I<parameter> for functions, if one is required ("ev	2736	This provides the loop I<parameter> for functions, if one is required ("ev
2327	loop parameter"). The C<EV_P> form is used when this is the sole parameter,	2737	loop parameter"). The C<EV_P> form is used when this is the sole parameter,
2328	C<EV_P_> is used when other parameters are following. Example:	2738	C<EV_P_> is used when other parameters are following. Example:
2329		2739
2330	// this is how ev_unref is being declared	2740	// this is how ev_unref is being declared
2331	static void ev_unref (EV_P);	2741	static void ev_unref (EV_P);
2332		2742
2333	// this is how you can declare your typical callback	2743	// this is how you can declare your typical callback
2334	static void cb (EV_P_ ev_timer *w, int revents)	2744	static void cb (EV_P_ ev_timer *w, int revents)
2335		2745
2336	It declares a parameter C<loop> of type C<struct ev_loop *>, quite	2746	It declares a parameter C<loop> of type C<struct ev_loop *>, quite
2337	suitable for use with C<EV_A>.	2747	suitable for use with C<EV_A>.
2338		2748
2339	=item C<EV_DEFAULT>, C<EV_DEFAULT_>	2749	=item C<EV_DEFAULT>, C<EV_DEFAULT_>
2340		2750
2341	Similar to the other two macros, this gives you the value of the default	2751	Similar to the other two macros, this gives you the value of the default
2342	loop, if multiple loops are supported ("ev loop default").	2752	loop, if multiple loops are supported ("ev loop default").
		2753
		2754	=item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_>
		2755
		2756	Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the
		2757	default loop has been initialised (C<UC> == unchecked). Their behaviour
		2758	is undefined when the default loop has not been initialised by a previous
		2759	execution of C<EV_DEFAULT>, C<EV_DEFAULT_> or C<ev_default_init (...)>.
		2760
		2761	It is often prudent to use C<EV_DEFAULT> when initialising the first
		2762	watcher in a function but use C<EV_DEFAULT_UC> afterwards.
2343		2763
2344	=back	2764	=back
2345		2765
2346	Example: Declare and initialise a check watcher, utilising the above	2766	Example: Declare and initialise a check watcher, utilising the above
2347	macros so it will work regardless of whether multiple loops are supported	2767	macros so it will work regardless of whether multiple loops are supported
2348	or not.	2768	or not.
2349		2769
2350	static void	2770	static void
2351	check_cb (EV_P_ ev_timer *w, int revents)	2771	check_cb (EV_P_ ev_timer *w, int revents)
2352	{	2772	{
2353	ev_check_stop (EV_A_ w);	2773	ev_check_stop (EV_A_ w);
2354	}	2774	}
2355		2775
2356	ev_check check;	2776	ev_check check;
2357	ev_check_init (&check, check_cb);	2777	ev_check_init (&check, check_cb);
2358	ev_check_start (EV_DEFAULT_ &check);	2778	ev_check_start (EV_DEFAULT_ &check);
2359	ev_loop (EV_DEFAULT_ 0);	2779	ev_loop (EV_DEFAULT_ 0);
2360		2780
2361	=head1 EMBEDDING	2781	=head1 EMBEDDING
2362		2782
2363	Libev can (and often is) directly embedded into host	2783	Libev can (and often is) directly embedded into host
2364	applications. Examples of applications that embed it include the Deliantra	2784	applications. Examples of applications that embed it include the Deliantra
…		…
2371	libev somewhere in your source tree).	2791	libev somewhere in your source tree).
2372		2792
2373	=head2 FILESETS	2793	=head2 FILESETS
2374		2794
2375	Depending on what features you need you need to include one or more sets of files	2795	Depending on what features you need you need to include one or more sets of files
2376	in your app.	2796	in your application.
2377		2797
2378	=head3 CORE EVENT LOOP	2798	=head3 CORE EVENT LOOP
2379		2799
2380	To include only the libev core (all the C<ev_*> functions), with manual	2800	To include only the libev core (all the C<ev_*> functions), with manual
2381	configuration (no autoconf):	2801	configuration (no autoconf):
2382		2802
2383	#define EV_STANDALONE 1	2803	#define EV_STANDALONE 1
2384	#include "ev.c"	2804	#include "ev.c"
2385		2805
2386	This will automatically include F<ev.h>, too, and should be done in a	2806	This will automatically include F<ev.h>, too, and should be done in a
2387	single C source file only to provide the function implementations. To use	2807	single C source file only to provide the function implementations. To use
2388	it, do the same for F<ev.h> in all files wishing to use this API (best	2808	it, do the same for F<ev.h> in all files wishing to use this API (best
2389	done by writing a wrapper around F<ev.h> that you can include instead and	2809	done by writing a wrapper around F<ev.h> that you can include instead and
2390	where you can put other configuration options):	2810	where you can put other configuration options):
2391		2811
2392	#define EV_STANDALONE 1	2812	#define EV_STANDALONE 1
2393	#include "ev.h"	2813	#include "ev.h"
2394		2814
2395	Both header files and implementation files can be compiled with a C++	2815	Both header files and implementation files can be compiled with a C++
2396	compiler (at least, thats a stated goal, and breakage will be treated	2816	compiler (at least, thats a stated goal, and breakage will be treated
2397	as a bug).	2817	as a bug).
2398		2818
2399	You need the following files in your source tree, or in a directory	2819	You need the following files in your source tree, or in a directory
2400	in your include path (e.g. in libev/ when using -Ilibev):	2820	in your include path (e.g. in libev/ when using -Ilibev):
2401		2821
2402	ev.h	2822	ev.h
2403	ev.c	2823	ev.c
2404	ev_vars.h	2824	ev_vars.h
2405	ev_wrap.h	2825	ev_wrap.h
2406		2826
2407	ev_win32.c required on win32 platforms only	2827	ev_win32.c required on win32 platforms only
2408		2828
2409	ev_select.c only when select backend is enabled (which is enabled by default)	2829	ev_select.c only when select backend is enabled (which is enabled by default)
2410	ev_poll.c only when poll backend is enabled (disabled by default)	2830	ev_poll.c only when poll backend is enabled (disabled by default)
2411	ev_epoll.c only when the epoll backend is enabled (disabled by default)	2831	ev_epoll.c only when the epoll backend is enabled (disabled by default)
2412	ev_kqueue.c only when the kqueue backend is enabled (disabled by default)	2832	ev_kqueue.c only when the kqueue backend is enabled (disabled by default)
2413	ev_port.c only when the solaris port backend is enabled (disabled by default)	2833	ev_port.c only when the solaris port backend is enabled (disabled by default)
2414		2834
2415	F<ev.c> includes the backend files directly when enabled, so you only need	2835	F<ev.c> includes the backend files directly when enabled, so you only need
2416	to compile this single file.	2836	to compile this single file.
2417		2837
2418	=head3 LIBEVENT COMPATIBILITY API	2838	=head3 LIBEVENT COMPATIBILITY API
2419		2839
2420	To include the libevent compatibility API, also include:	2840	To include the libevent compatibility API, also include:
2421		2841
2422	#include "event.c"	2842	#include "event.c"
2423		2843
2424	in the file including F<ev.c>, and:	2844	in the file including F<ev.c>, and:
2425		2845
2426	#include "event.h"	2846	#include "event.h"
2427		2847
2428	in the files that want to use the libevent API. This also includes F<ev.h>.	2848	in the files that want to use the libevent API. This also includes F<ev.h>.
2429		2849
2430	You need the following additional files for this:	2850	You need the following additional files for this:
2431		2851
2432	event.h	2852	event.h
2433	event.c	2853	event.c
2434		2854
2435	=head3 AUTOCONF SUPPORT	2855	=head3 AUTOCONF SUPPORT
2436		2856
2437	Instead of using C<EV_STANDALONE=1> and providing your config in	2857	Instead of using C<EV_STANDALONE=1> and providing your configuration in
2438	whatever way you want, you can also C<m4_include([libev.m4])> in your	2858	whatever way you want, you can also C<m4_include([libev.m4])> in your
2439	F<configure.ac> and leave C<EV_STANDALONE> undefined. F<ev.c> will then	2859	F<configure.ac> and leave C<EV_STANDALONE> undefined. F<ev.c> will then
2440	include F<config.h> and configure itself accordingly.	2860	include F<config.h> and configure itself accordingly.
2441		2861
2442	For this of course you need the m4 file:	2862	For this of course you need the m4 file:
2443		2863
2444	libev.m4	2864	libev.m4
2445		2865
2446	=head2 PREPROCESSOR SYMBOLS/MACROS	2866	=head2 PREPROCESSOR SYMBOLS/MACROS
2447		2867
2448	Libev can be configured via a variety of preprocessor symbols you have to define	2868	Libev can be configured via a variety of preprocessor symbols you have to
2449	before including any of its files. The default is not to build for multiplicity	2869	define before including any of its files. The default in the absence of
2450	and only include the select backend.	2870	autoconf is noted for every option.
2451		2871
2452	=over 4	2872	=over 4
2453		2873
2454	=item EV_STANDALONE	2874	=item EV_STANDALONE
2455		2875
…		…
2460	F<event.h> that are not directly supported by the libev core alone.	2880	F<event.h> that are not directly supported by the libev core alone.
2461		2881
2462	=item EV_USE_MONOTONIC	2882	=item EV_USE_MONOTONIC
2463		2883
2464	If defined to be C<1>, libev will try to detect the availability of the	2884	If defined to be C<1>, libev will try to detect the availability of the
2465	monotonic clock option at both compiletime and runtime. Otherwise no use	2885	monotonic clock option at both compile time and runtime. Otherwise no use
2466	of the monotonic clock option will be attempted. If you enable this, you	2886	of the monotonic clock option will be attempted. If you enable this, you
2467	usually have to link against librt or something similar. Enabling it when	2887	usually have to link against librt or something similar. Enabling it when
2468	the functionality isn't available is safe, though, although you have	2888	the functionality isn't available is safe, though, although you have
2469	to make sure you link against any libraries where the C<clock_gettime>	2889	to make sure you link against any libraries where the C<clock_gettime>
2470	function is hiding in (often F<-lrt>).	2890	function is hiding in (often F<-lrt>).
2471		2891
2472	=item EV_USE_REALTIME	2892	=item EV_USE_REALTIME
2473		2893
2474	If defined to be C<1>, libev will try to detect the availability of the	2894	If defined to be C<1>, libev will try to detect the availability of the
2475	realtime clock option at compiletime (and assume its availability at	2895	real-time clock option at compile time (and assume its availability at
2476	runtime if successful). Otherwise no use of the realtime clock option will	2896	runtime if successful). Otherwise no use of the real-time clock option will
2477	be attempted. This effectively replaces C<gettimeofday> by C<clock_get	2897	be attempted. This effectively replaces C<gettimeofday> by C<clock_get
2478	(CLOCK_REALTIME, ...)> and will not normally affect correctness. See the	2898	(CLOCK_REALTIME, ...)> and will not normally affect correctness. See the
2479	note about libraries in the description of C<EV_USE_MONOTONIC>, though.	2899	note about libraries in the description of C<EV_USE_MONOTONIC>, though.
2480		2900
2481	=item EV_USE_NANOSLEEP	2901	=item EV_USE_NANOSLEEP
2482		2902
2483	If defined to be C<1>, libev will assume that C<nanosleep ()> is available	2903	If defined to be C<1>, libev will assume that C<nanosleep ()> is available
2484	and will use it for delays. Otherwise it will use C<select ()>.	2904	and will use it for delays. Otherwise it will use C<select ()>.
2485		2905
		2906	=item EV_USE_EVENTFD
		2907
		2908	If defined to be C<1>, then libev will assume that C<eventfd ()> is
		2909	available and will probe for kernel support at runtime. This will improve
		2910	C<ev_signal> and C<ev_async> performance and reduce resource consumption.
		2911	If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
		2912	2.7 or newer, otherwise disabled.
		2913
2486	=item EV_USE_SELECT	2914	=item EV_USE_SELECT
2487		2915
2488	If undefined or defined to be C<1>, libev will compile in support for the	2916	If undefined or defined to be C<1>, libev will compile in support for the
2489	C<select>(2) backend. No attempt at autodetection will be done: if no	2917	C<select>(2) backend. No attempt at auto-detection will be done: if no
2490	other method takes over, select will be it. Otherwise the select backend	2918	other method takes over, select will be it. Otherwise the select backend
2491	will not be compiled in.	2919	will not be compiled in.
2492		2920
2493	=item EV_SELECT_USE_FD_SET	2921	=item EV_SELECT_USE_FD_SET
2494		2922
2495	If defined to C<1>, then the select backend will use the system C<fd_set>	2923	If defined to C<1>, then the select backend will use the system C<fd_set>
2496	structure. This is useful if libev doesn't compile due to a missing	2924	structure. This is useful if libev doesn't compile due to a missing
2497	C<NFDBITS> or C<fd_mask> definition or it misguesses the bitset layout on	2925	C<NFDBITS> or C<fd_mask> definition or it mis-guesses the bitset layout on
2498	exotic systems. This usually limits the range of file descriptors to some	2926	exotic systems. This usually limits the range of file descriptors to some
2499	low limit such as 1024 or might have other limitations (winsocket only	2927	low limit such as 1024 or might have other limitations (winsocket only
2500	allows 64 sockets). The C<FD_SETSIZE> macro, set before compilation, might	2928	allows 64 sockets). The C<FD_SETSIZE> macro, set before compilation, might
2501	influence the size of the C<fd_set> used.	2929	influence the size of the C<fd_set> used.
2502		2930
…		…
2526		2954
2527	=item EV_USE_EPOLL	2955	=item EV_USE_EPOLL
2528		2956
2529	If defined to be C<1>, libev will compile in support for the Linux	2957	If defined to be C<1>, libev will compile in support for the Linux
2530	C<epoll>(7) backend. Its availability will be detected at runtime,	2958	C<epoll>(7) backend. Its availability will be detected at runtime,
2531	otherwise another method will be used as fallback. This is the	2959	otherwise another method will be used as fallback. This is the preferred
2532	preferred backend for GNU/Linux systems.	2960	backend for GNU/Linux systems. If undefined, it will be enabled if the
		2961	headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
2533		2962
2534	=item EV_USE_KQUEUE	2963	=item EV_USE_KQUEUE
2535		2964
2536	If defined to be C<1>, libev will compile in support for the BSD style	2965	If defined to be C<1>, libev will compile in support for the BSD style
2537	C<kqueue>(2) backend. Its actual availability will be detected at runtime,	2966	C<kqueue>(2) backend. Its actual availability will be detected at runtime,
…		…
2550	otherwise another method will be used as fallback. This is the preferred	2979	otherwise another method will be used as fallback. This is the preferred
2551	backend for Solaris 10 systems.	2980	backend for Solaris 10 systems.
2552		2981
2553	=item EV_USE_DEVPOLL	2982	=item EV_USE_DEVPOLL
2554		2983
2555	reserved for future expansion, works like the USE symbols above.	2984	Reserved for future expansion, works like the USE symbols above.
2556		2985
2557	=item EV_USE_INOTIFY	2986	=item EV_USE_INOTIFY
2558		2987
2559	If defined to be C<1>, libev will compile in support for the Linux inotify	2988	If defined to be C<1>, libev will compile in support for the Linux inotify
2560	interface to speed up C<ev_stat> watchers. Its actual availability will	2989	interface to speed up C<ev_stat> watchers. Its actual availability will
2561	be detected at runtime.	2990	be detected at runtime. If undefined, it will be enabled if the headers
		2991	indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
		2992
		2993	=item EV_ATOMIC_T
		2994
		2995	Libev requires an integer type (suitable for storing C<0> or C<1>) whose
		2996	access is atomic with respect to other threads or signal contexts. No such
		2997	type is easily found in the C language, so you can provide your own type
		2998	that you know is safe for your purposes. It is used both for signal handler "locking"
		2999	as well as for signal and thread safety in C<ev_async> watchers.
		3000
		3001	In the absence of this define, libev will use C<sig_atomic_t volatile>
		3002	(from F<signal.h>), which is usually good enough on most platforms.
2562		3003
2563	=item EV_H	3004	=item EV_H
2564		3005
2565	The name of the F<ev.h> header file used to include it. The default if	3006	The name of the F<ev.h> header file used to include it. The default if
2566	undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be	3007	undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be
…		…
2604	When doing priority-based operations, libev usually has to linearly search	3045	When doing priority-based operations, libev usually has to linearly search
2605	all the priorities, so having many of them (hundreds) uses a lot of space	3046	all the priorities, so having many of them (hundreds) uses a lot of space
2606	and time, so using the defaults of five priorities (-2 .. +2) is usually	3047	and time, so using the defaults of five priorities (-2 .. +2) is usually
2607	fine.	3048	fine.
2608		3049
2609	If your embedding app does not need any priorities, defining these both to	3050	If your embedding application does not need any priorities, defining these both to
2610	C<0> will save some memory and cpu.	3051	C<0> will save some memory and CPU.
2611		3052
2612	=item EV_PERIODIC_ENABLE	3053	=item EV_PERIODIC_ENABLE
2613		3054
2614	If undefined or defined to be C<1>, then periodic timers are supported. If	3055	If undefined or defined to be C<1>, then periodic timers are supported. If
2615	defined to be C<0>, then they are not. Disabling them saves a few kB of	3056	defined to be C<0>, then they are not. Disabling them saves a few kB of
…		…
2634	=item EV_FORK_ENABLE	3075	=item EV_FORK_ENABLE
2635		3076
2636	If undefined or defined to be C<1>, then fork watchers are supported. If	3077	If undefined or defined to be C<1>, then fork watchers are supported. If
2637	defined to be C<0>, then they are not.	3078	defined to be C<0>, then they are not.
2638		3079
		3080	=item EV_ASYNC_ENABLE
		3081
		3082	If undefined or defined to be C<1>, then async watchers are supported. If
		3083	defined to be C<0>, then they are not.
		3084
2639	=item EV_MINIMAL	3085	=item EV_MINIMAL
2640		3086
2641	If you need to shave off some kilobytes of code at the expense of some	3087	If you need to shave off some kilobytes of code at the expense of some
2642	speed, define this symbol to C<1>. Currently only used for gcc to override	3088	speed, define this symbol to C<1>. Currently this is used to override some
2643	some inlining decisions, saves roughly 30% codesize of amd64.	3089	inlining decisions, saves roughly 30% code size on amd64. It also selects a
		3090	much smaller 2-heap for timer management over the default 4-heap.
2644		3091
2645	=item EV_PID_HASHSIZE	3092	=item EV_PID_HASHSIZE
2646		3093
2647	C<ev_child> watchers use a small hash table to distribute workload by	3094	C<ev_child> watchers use a small hash table to distribute workload by
2648	pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more	3095	pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more
…		…
2655	inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>),	3102	inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>),
2656	usually more than enough. If you need to manage thousands of C<ev_stat>	3103	usually more than enough. If you need to manage thousands of C<ev_stat>
2657	watchers you might want to increase this value (I<must> be a power of	3104	watchers you might want to increase this value (I<must> be a power of
2658	two).	3105	two).
2659		3106
		3107	=item EV_USE_4HEAP
		3108
		3109	Heaps are not very cache-efficient. To improve the cache-efficiency of the
		3110	timer and periodics heap, libev uses a 4-heap when this symbol is defined
		3111	to C<1>. The 4-heap uses more complicated (longer) code but has
		3112	noticeably faster performance with many (thousands) of watchers.
		3113
		3114	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>
		3115	(disabled).
		3116
		3117	=item EV_HEAP_CACHE_AT
		3118
		3119	Heaps are not very cache-efficient. To improve the cache-efficiency of the
		3120	timer and periodics heap, libev can cache the timestamp (I<at>) within
		3121	the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>),
		3122	which uses 8-12 bytes more per watcher and a few hundred bytes more code,
		3123	but avoids random read accesses on heap changes. This improves performance
		3124	noticeably with with many (hundreds) of watchers.
		3125
		3126	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>
		3127	(disabled).
		3128
		3129	=item EV_VERIFY
		3130
		3131	Controls how much internal verification (see C<ev_loop_verify ()>) will
		3132	be done: If set to C<0>, no internal verification code will be compiled
		3133	in. If set to C<1>, then verification code will be compiled in, but not
		3134	called. If set to C<2>, then the internal verification code will be
		3135	called once per loop, which can slow down libev. If set to C<3>, then the
		3136	verification code will be called very frequently, which will slow down
		3137	libev considerably.
		3138
		3139	The default is C<1>, unless C<EV_MINIMAL> is set, in which case it will be
		3140	C<0.>
		3141
2660	=item EV_COMMON	3142	=item EV_COMMON
2661		3143
2662	By default, all watchers have a C<void *data> member. By redefining	3144	By default, all watchers have a C<void *data> member. By redefining
2663	this macro to a something else you can include more and other types of	3145	this macro to a something else you can include more and other types of
2664	members. You have to define it each time you include one of the files,	3146	members. You have to define it each time you include one of the files,
2665	though, and it must be identical each time.	3147	though, and it must be identical each time.
2666		3148
2667	For example, the perl EV module uses something like this:	3149	For example, the perl EV module uses something like this:
2668		3150
2669	#define EV_COMMON \	3151	#define EV_COMMON \
2670	SV *self; /* contains this struct */ \	3152	SV *self; /* contains this struct */ \
2671	SV *cb_sv, *fh /* note no trailing ";" */	3153	SV *cb_sv, *fh /* note no trailing ";" */
2672		3154
2673	=item EV_CB_DECLARE (type)	3155	=item EV_CB_DECLARE (type)
2674		3156
2675	=item EV_CB_INVOKE (watcher, revents)	3157	=item EV_CB_INVOKE (watcher, revents)
2676		3158
…		…
2683	avoid the C<struct ev_loop *> as first argument in all cases, or to use	3165	avoid the C<struct ev_loop *> as first argument in all cases, or to use
2684	method calls instead of plain function calls in C++.	3166	method calls instead of plain function calls in C++.
2685		3167
2686	=head2 EXPORTED API SYMBOLS	3168	=head2 EXPORTED API SYMBOLS
2687		3169
2688	If you need to re-export the API (e.g. via a dll) and you need a list of	3170	If you need to re-export the API (e.g. via a DLL) and you need a list of
2689	exported symbols, you can use the provided F<Symbol.*> files which list	3171	exported symbols, you can use the provided F<Symbol.*> files which list
2690	all public symbols, one per line:	3172	all public symbols, one per line:
2691		3173
2692	Symbols.ev for libev proper	3174	Symbols.ev for libev proper
2693	Symbols.event for the libevent emulation	3175	Symbols.event for the libevent emulation
2694		3176
2695	This can also be used to rename all public symbols to avoid clashes with	3177	This can also be used to rename all public symbols to avoid clashes with
2696	multiple versions of libev linked together (which is obviously bad in	3178	multiple versions of libev linked together (which is obviously bad in
2697	itself, but sometimes it is inconvinient to avoid this).	3179	itself, but sometimes it is inconvenient to avoid this).
2698		3180
2699	A sed command like this will create wrapper C<#define>'s that you need to	3181	A sed command like this will create wrapper C<#define>'s that you need to
2700	include before including F<ev.h>:	3182	include before including F<ev.h>:
2701		3183
2702	<Symbols.ev sed -e "s/.*/#define & myprefix_&/" >wrap.h	3184	<Symbols.ev sed -e "s/.*/#define & myprefix_&/" >wrap.h
…		…
2719	file.	3201	file.
2720		3202
2721	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file	3203	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file
2722	that everybody includes and which overrides some configure choices:	3204	that everybody includes and which overrides some configure choices:
2723		3205
2724	#define EV_MINIMAL 1	3206	#define EV_MINIMAL 1
2725	#define EV_USE_POLL 0	3207	#define EV_USE_POLL 0
2726	#define EV_MULTIPLICITY 0	3208	#define EV_MULTIPLICITY 0
2727	#define EV_PERIODIC_ENABLE 0	3209	#define EV_PERIODIC_ENABLE 0
2728	#define EV_STAT_ENABLE 0	3210	#define EV_STAT_ENABLE 0
2729	#define EV_FORK_ENABLE 0	3211	#define EV_FORK_ENABLE 0
2730	#define EV_CONFIG_H <config.h>	3212	#define EV_CONFIG_H <config.h>
2731	#define EV_MINPRI 0	3213	#define EV_MINPRI 0
2732	#define EV_MAXPRI 0	3214	#define EV_MAXPRI 0
2733		3215
2734	#include "ev++.h"	3216	#include "ev++.h"
2735		3217
2736	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:	3218	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
2737		3219
2738	#include "ev_cpp.h"	3220	#include "ev_cpp.h"
2739	#include "ev.c"	3221	#include "ev.c"
		3222
		3223
		3224	=head1 THREADS AND COROUTINES
		3225
		3226	=head2 THREADS
		3227
		3228	Libev itself is completely thread-safe, but it uses no locking. This
		3229	means that you can use as many loops as you want in parallel, as long as
		3230	only one thread ever calls into one libev function with the same loop
		3231	parameter.
		3232
		3233	Or put differently: calls with different loop parameters can be done in
		3234	parallel from multiple threads, calls with the same loop parameter must be
		3235	done serially (but can be done from different threads, as long as only one
		3236	thread ever is inside a call at any point in time, e.g. by using a mutex
		3237	per loop).
		3238
		3239	If you want to know which design (one loop, locking, or multiple loops
		3240	without or something else still) is best for your problem, then I cannot
		3241	help you. I can give some generic advice however:
		3242
		3243	=over 4
		3244
		3245	=item * most applications have a main thread: use the default libev loop
		3246	in that thread, or create a separate thread running only the default loop.
		3247
		3248	This helps integrating other libraries or software modules that use libev
		3249	themselves and don't care/know about threading.
		3250
		3251	=item * one loop per thread is usually a good model.
		3252
		3253	Doing this is almost never wrong, sometimes a better-performance model
		3254	exists, but it is always a good start.
		3255
		3256	=item * other models exist, such as the leader/follower pattern, where one
		3257	loop is handed through multiple threads in a kind of round-robin fashion.
		3258
		3259	Choosing a model is hard - look around, learn, know that usually you can do
		3260	better than you currently do :-)
		3261
		3262	=item * often you need to talk to some other thread which blocks in the
		3263	event loop - C<ev_async> watchers can be used to wake them up from other
		3264	threads safely (or from signal contexts...).
		3265
		3266	=back
		3267
		3268	=head2 COROUTINES
		3269
		3270	Libev is much more accommodating to coroutines ("cooperative threads"):
		3271	libev fully supports nesting calls to it's functions from different
		3272	coroutines (e.g. you can call C<ev_loop> on the same loop from two
		3273	different coroutines and switch freely between both coroutines running the
		3274	loop, as long as you don't confuse yourself). The only exception is that
		3275	you must not do this from C<ev_periodic> reschedule callbacks.
		3276
		3277	Care has been invested into making sure that libev does not keep local
		3278	state inside C<ev_loop>, and other calls do not usually allow coroutine
		3279	switches.
2740		3280
2741		3281
2742	=head1 COMPLEXITIES	3282	=head1 COMPLEXITIES
2743		3283
2744	In this section the complexities of (many of) the algorithms used inside	3284	In this section the complexities of (many of) the algorithms used inside
…		…
2762	=item Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)	3302	=item Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)
2763		3303
2764	That means that changing a timer costs less than removing/adding them	3304	That means that changing a timer costs less than removing/adding them
2765	as only the relative motion in the event queue has to be paid for.	3305	as only the relative motion in the event queue has to be paid for.
2766		3306
2767	=item Starting io/check/prepare/idle/signal/child watchers: O(1)	3307	=item Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1)
2768		3308
2769	These just add the watcher into an array or at the head of a list.	3309	These just add the watcher into an array or at the head of a list.
2770		3310
2771	=item Stopping check/prepare/idle watchers: O(1)	3311	=item Stopping check/prepare/idle/fork/async watchers: O(1)
2772		3312
2773	=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))	3313	=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))
2774		3314
2775	These watchers are stored in lists then need to be walked to find the	3315	These watchers are stored in lists then need to be walked to find the
2776	correct watcher to remove. The lists are usually short (you don't usually	3316	correct watcher to remove. The lists are usually short (you don't usually
2777	have many watchers waiting for the same fd or signal).	3317	have many watchers waiting for the same fd or signal).
2778		3318
2779	=item Finding the next timer in each loop iteration: O(1)	3319	=item Finding the next timer in each loop iteration: O(1)
2780		3320
2781	By virtue of using a binary heap, the next timer is always found at the	3321	By virtue of using a binary or 4-heap, the next timer is always found at a
2782	beginning of the storage array.	3322	fixed position in the storage array.
2783		3323
2784	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)	3324	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)
2785		3325
2786	A change means an I/O watcher gets started or stopped, which requires	3326	A change means an I/O watcher gets started or stopped, which requires
2787	libev to recalculate its status (and possibly tell the kernel, depending	3327	libev to recalculate its status (and possibly tell the kernel, depending
2788	on backend and wether C<ev_io_set> was used).	3328	on backend and whether C<ev_io_set> was used).
2789		3329
2790	=item Activating one watcher (putting it into the pending state): O(1)	3330	=item Activating one watcher (putting it into the pending state): O(1)
2791		3331
2792	=item Priority handling: O(number_of_priorities)	3332	=item Priority handling: O(number_of_priorities)
2793		3333
2794	Priorities are implemented by allocating some space for each	3334	Priorities are implemented by allocating some space for each
2795	priority. When doing priority-based operations, libev usually has to	3335	priority. When doing priority-based operations, libev usually has to
2796	linearly search all the priorities, but starting/stopping and activating	3336	linearly search all the priorities, but starting/stopping and activating
2797	watchers becomes O(1) w.r.t. prioritiy handling.	3337	watchers becomes O(1) w.r.t. priority handling.
		3338
		3339	=item Sending an ev_async: O(1)
		3340
		3341	=item Processing ev_async_send: O(number_of_async_watchers)
		3342
		3343	=item Processing signals: O(max_signal_number)
		3344
		3345	Sending involves a system call I<iff> there were no other C<ev_async_send>
		3346	calls in the current loop iteration. Checking for async and signal events
		3347	involves iterating over all running async watchers or all signal numbers.
2798		3348
2799	=back	3349	=back
2800		3350
2801		3351
2802	=head1 Win32 platform limitations and workarounds	3352	=head1 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS
2803		3353
2804	Win32 doesn't support any of the standards (e.g. POSIX) that libev	3354	Win32 doesn't support any of the standards (e.g. POSIX) that libev
2805	requires, and its I/O model is fundamentally incompatible with the POSIX	3355	requires, and its I/O model is fundamentally incompatible with the POSIX
2806	model. Libev still offers limited functionality on this platform in	3356	model. Libev still offers limited functionality on this platform in
2807	the form of the C<EVBACKEND_SELECT> backend, and only supports socket	3357	the form of the C<EVBACKEND_SELECT> backend, and only supports socket
2808	descriptors. This only applies when using Win32 natively, not when using	3358	descriptors. This only applies when using Win32 natively, not when using
2809	e.g. cygwin.	3359	e.g. cygwin.
2810		3360
		3361	Lifting these limitations would basically require the full
		3362	re-implementation of the I/O system. If you are into these kinds of
		3363	things, then note that glib does exactly that for you in a very portable
		3364	way (note also that glib is the slowest event library known to man).
		3365
2811	There is no supported compilation method available on windows except	3366	There is no supported compilation method available on windows except
2812	embedding it into other applications.	3367	embedding it into other applications.
2813		3368
		3369	Not a libev limitation but worth mentioning: windows apparently doesn't
		3370	accept large writes: instead of resulting in a partial write, windows will
		3371	either accept everything or return C<ENOBUFS> if the buffer is too large,
		3372	so make sure you only write small amounts into your sockets (less than a
		3373	megabyte seems safe, but thsi apparently depends on the amount of memory
		3374	available).
		3375
2814	Due to the many, low, and arbitrary limits on the win32 platform and the	3376	Due to the many, low, and arbitrary limits on the win32 platform and
2815	abysmal performance of winsockets, using a large number of sockets is not	3377	the abysmal performance of winsockets, using a large number of sockets
2816	recommended (and not reasonable). If your program needs to use more than	3378	is not recommended (and not reasonable). If your program needs to use
2817	a hundred or so sockets, then likely it needs to use a totally different	3379	more than a hundred or so sockets, then likely it needs to use a totally
2818	implementation for windows, as libev offers the POSIX model, which cannot	3380	different implementation for windows, as libev offers the POSIX readiness
2819	be implemented efficiently on windows (microsoft monopoly games).	3381	notification model, which cannot be implemented efficiently on windows
		3382	(Microsoft monopoly games).
		3383
		3384	A typical way to use libev under windows is to embed it (see the embedding
		3385	section for details) and use the following F<evwrap.h> header file instead
		3386	of F<ev.h>:
		3387
		3388	#define EV_STANDALONE /* keeps ev from requiring config.h */
		3389	#define EV_SELECT_IS_WINSOCKET 1 /* configure libev for windows select */
		3390
		3391	#include "ev.h"
		3392
		3393	And compile the following F<evwrap.c> file into your project (make sure
		3394	you do I<not> compile the F<ev.c> or any other embedded soruce files!):
		3395
		3396	#include "evwrap.h"
		3397	#include "ev.c"
2820		3398
2821	=over 4	3399	=over 4
2822		3400
2823	=item The winsocket select function	3401	=item The winsocket select function
2824		3402
2825	The winsocket C<select> function doesn't follow POSIX in that it requires	3403	The winsocket C<select> function doesn't follow POSIX in that it
2826	socket I<handles> and not socket I<file descriptors>. This makes select	3404	requires socket I<handles> and not socket I<file descriptors> (it is
2827	very inefficient, and also requires a mapping from file descriptors	3405	also extremely buggy). This makes select very inefficient, and also
2828	to socket handles. See the discussion of the C<EV_SELECT_USE_FD_SET>,	3406	requires a mapping from file descriptors to socket handles (the Microsoft
2829	C<EV_SELECT_IS_WINSOCKET> and C<EV_FD_TO_WIN32_HANDLE> preprocessor	3407	C runtime provides the function C<_open_osfhandle> for this). See the
2830	symbols for more info.	3408	discussion of the C<EV_SELECT_USE_FD_SET>, C<EV_SELECT_IS_WINSOCKET> and
		3409	C<EV_FD_TO_WIN32_HANDLE> preprocessor symbols for more info.
2831		3410
2832	The configuration for a "naked" win32 using the microsoft runtime	3411	The configuration for a "naked" win32 using the Microsoft runtime
2833	libraries and raw winsocket select is:	3412	libraries and raw winsocket select is:
2834		3413
2835	#define EV_USE_SELECT 1	3414	#define EV_USE_SELECT 1
2836	#define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */	3415	#define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */
2837		3416
2838	Note that winsockets handling of fd sets is O(n), so you can easily get a	3417	Note that winsockets handling of fd sets is O(n), so you can easily get a
2839	complexity in the O(n²) range when using win32.	3418	complexity in the O(n²) range when using win32.
2840		3419
2841	=item Limited number of file descriptors	3420	=item Limited number of file descriptors
2842		3421
2843	Windows has numerous arbitrary (and low) limits on things. Early versions	3422	Windows has numerous arbitrary (and low) limits on things.
2844	of winsocket's select only supported waiting for a max. of C<64> handles	3423
		3424	Early versions of winsocket's select only supported waiting for a maximum
2845	(probably owning to the fact that all windows kernels can only wait for	3425	of C<64> handles (probably owning to the fact that all windows kernels
2846	C<64> things at the same time internally; microsoft recommends spawning a	3426	can only wait for C<64> things at the same time internally; Microsoft
2847	chain of threads and wait for 63 handles and the previous thread in each).	3427	recommends spawning a chain of threads and wait for 63 handles and the
		3428	previous thread in each. Great).
2848		3429
2849	Newer versions support more handles, but you need to define C<FD_SETSIZE>	3430	Newer versions support more handles, but you need to define C<FD_SETSIZE>
2850	to some high number (e.g. C<2048>) before compiling the winsocket select	3431	to some high number (e.g. C<2048>) before compiling the winsocket select
2851	call (which might be in libev or elsewhere, for example, perl does its own	3432	call (which might be in libev or elsewhere, for example, perl does its own
2852	select emulation on windows).	3433	select emulation on windows).
2853		3434
2854	Another limit is the number of file descriptors in the microsoft runtime	3435	Another limit is the number of file descriptors in the Microsoft runtime
2855	libraries, which by default is C<64> (there must be a hidden I<64> fetish	3436	libraries, which by default is C<64> (there must be a hidden I<64> fetish
2856	or something like this inside microsoft). You can increase this by calling	3437	or something like this inside Microsoft). You can increase this by calling
2857	C<_setmaxstdio>, which can increase this limit to C<2048> (another	3438	C<_setmaxstdio>, which can increase this limit to C<2048> (another
2858	arbitrary limit), but is broken in many versions of the microsoft runtime	3439	arbitrary limit), but is broken in many versions of the Microsoft runtime
2859	libraries.	3440	libraries.
2860		3441
2861	This might get you to about C<512> or C<2048> sockets (depending on	3442	This might get you to about C<512> or C<2048> sockets (depending on
2862	windows version and/or the phase of the moon). To get more, you need to	3443	windows version and/or the phase of the moon). To get more, you need to
2863	wrap all I/O functions and provide your own fd management, but the cost of	3444	wrap all I/O functions and provide your own fd management, but the cost of
2864	calling select (O(n²)) will likely make this unworkable.	3445	calling select (O(n²)) will likely make this unworkable.
2865		3446
2866	=back	3447	=back
2867		3448
2868		3449
		3450	=head1 PORTABILITY REQUIREMENTS
		3451
		3452	In addition to a working ISO-C implementation, libev relies on a few
		3453	additional extensions:
		3454
		3455	=over 4
		3456
		3457	=item C<void (*)(ev_watcher_type *, int revents)> must have compatible
		3458	calling conventions regardless of C<ev_watcher_type *>.
		3459
		3460	Libev assumes not only that all watcher pointers have the same internal
		3461	structure (guaranteed by POSIX but not by ISO C for example), but it also
		3462	assumes that the same (machine) code can be used to call any watcher
		3463	callback: The watcher callbacks have different type signatures, but libev
		3464	calls them using an C<ev_watcher *> internally.
		3465
		3466	=item C<sig_atomic_t volatile> must be thread-atomic as well
		3467
		3468	The type C<sig_atomic_t volatile> (or whatever is defined as
		3469	C<EV_ATOMIC_T>) must be atomic w.r.t. accesses from different
		3470	threads. This is not part of the specification for C<sig_atomic_t>, but is
		3471	believed to be sufficiently portable.
		3472
		3473	=item C<sigprocmask> must work in a threaded environment
		3474
		3475	Libev uses C<sigprocmask> to temporarily block signals. This is not
		3476	allowed in a threaded program (C<pthread_sigmask> has to be used). Typical
		3477	pthread implementations will either allow C<sigprocmask> in the "main
		3478	thread" or will block signals process-wide, both behaviours would
		3479	be compatible with libev. Interaction between C<sigprocmask> and
		3480	C<pthread_sigmask> could complicate things, however.
		3481
		3482	The most portable way to handle signals is to block signals in all threads
		3483	except the initial one, and run the default loop in the initial thread as
		3484	well.
		3485
		3486	=item C<long> must be large enough for common memory allocation sizes
		3487
		3488	To improve portability and simplify using libev, libev uses C<long>
		3489	internally instead of C<size_t> when allocating its data structures. On
		3490	non-POSIX systems (Microsoft...) this might be unexpectedly low, but
		3491	is still at least 31 bits everywhere, which is enough for hundreds of
		3492	millions of watchers.
		3493
		3494	=item C<double> must hold a time value in seconds with enough accuracy
		3495
		3496	The type C<double> is used to represent timestamps. It is required to
		3497	have at least 51 bits of mantissa (and 9 bits of exponent), which is good
		3498	enough for at least into the year 4000. This requirement is fulfilled by
		3499	implementations implementing IEEE 754 (basically all existing ones).
		3500
		3501	=back
		3502
		3503	If you know of other additional requirements drop me a note.
		3504
		3505
		3506	=head1 COMPILER WARNINGS
		3507
		3508	Depending on your compiler and compiler settings, you might get no or a
		3509	lot of warnings when compiling libev code. Some people are apparently
		3510	scared by this.
		3511
		3512	However, these are unavoidable for many reasons. For one, each compiler
		3513	has different warnings, and each user has different tastes regarding
		3514	warning options. "Warn-free" code therefore cannot be a goal except when
		3515	targeting a specific compiler and compiler-version.
		3516
		3517	Another reason is that some compiler warnings require elaborate
		3518	workarounds, or other changes to the code that make it less clear and less
		3519	maintainable.
		3520
		3521	And of course, some compiler warnings are just plain stupid, or simply
		3522	wrong (because they don't actually warn about the condition their message
		3523	seems to warn about).
		3524
		3525	While libev is written to generate as few warnings as possible,
		3526	"warn-free" code is not a goal, and it is recommended not to build libev
		3527	with any compiler warnings enabled unless you are prepared to cope with
		3528	them (e.g. by ignoring them). Remember that warnings are just that:
		3529	warnings, not errors, or proof of bugs.
		3530
		3531
		3532	=head1 VALGRIND
		3533
		3534	Valgrind has a special section here because it is a popular tool that is
		3535	highly useful, but valgrind reports are very hard to interpret.
		3536
		3537	If you think you found a bug (memory leak, uninitialised data access etc.)
		3538	in libev, then check twice: If valgrind reports something like:
		3539
		3540	==2274== definitely lost: 0 bytes in 0 blocks.
		3541	==2274== possibly lost: 0 bytes in 0 blocks.
		3542	==2274== still reachable: 256 bytes in 1 blocks.
		3543
		3544	Then there is no memory leak. Similarly, under some circumstances,
		3545	valgrind might report kernel bugs as if it were a bug in libev, or it
		3546	might be confused (it is a very good tool, but only a tool).
		3547
		3548	If you are unsure about something, feel free to contact the mailing list
		3549	with the full valgrind report and an explanation on why you think this is
		3550	a bug in libev. However, don't be annoyed when you get a brisk "this is
		3551	no bug" answer and take the chance of learning how to interpret valgrind
		3552	properly.
		3553
		3554	If you need, for some reason, empty reports from valgrind for your project
		3555	I suggest using suppression lists.
		3556
		3557
2869	=head1 AUTHOR	3558	=head1 AUTHOR
2870		3559
2871	Marc Lehmann <libev@schmorp.de>.	3560	Marc Lehmann <libev@schmorp.de>.
2872		3561

Diff Legend

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