ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

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

Diff Legend

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