ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.78 by root, Sun Dec 9 19:42:57 2007 UTC vs.
Revision 1.138 by root, Mon Mar 31 01:14:12 2008 UTC

…		…
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	#include <ev.h>	7	#include <ev.h>
8		8
9	=head1 EXAMPLE PROGRAM	9	=head2 EXAMPLE PROGRAM
10		10
		11	// a single header file is required
11	#include <ev.h>	12	#include <ev.h>
12		13
		14	// every watcher type has its own typedef'd struct
		15	// with the name ev_<type>
13	ev_io stdin_watcher;	16	ev_io stdin_watcher;
14	ev_timer timeout_watcher;	17	ev_timer timeout_watcher;
15		18
		19	// all watcher callbacks have a similar signature
16	/* called when data readable on stdin */	20	// this callback is called when data is readable on stdin
17	static void	21	static void
18	stdin_cb (EV_P_ struct ev_io *w, int revents)	22	stdin_cb (EV_P_ struct ev_io *w, int revents)
19	{	23	{
20	/* puts ("stdin ready"); */	24	puts ("stdin ready");
21	ev_io_stop (EV_A_ w); /* just a syntax example */	25	// for one-shot events, one must manually stop the watcher
22	ev_unloop (EV_A_ EVUNLOOP_ALL); /* leave all loop calls */	26	// with its corresponding stop function.
		27	ev_io_stop (EV_A_ w);
		28
		29	// this causes all nested ev_loop's to stop iterating
		30	ev_unloop (EV_A_ EVUNLOOP_ALL);
23	}	31	}
24		32
		33	// another callback, this time for a time-out
25	static void	34	static void
26	timeout_cb (EV_P_ struct ev_timer *w, int revents)	35	timeout_cb (EV_P_ struct ev_timer *w, int revents)
27	{	36	{
28	/* puts ("timeout"); */	37	puts ("timeout");
29	ev_unloop (EV_A_ EVUNLOOP_ONE); /* leave one loop call */	38	// this causes the innermost ev_loop to stop iterating
		39	ev_unloop (EV_A_ EVUNLOOP_ONE);
30	}	40	}
31		41
32	int	42	int
33	main (void)	43	main (void)
34	{	44	{
		45	// use the default event loop unless you have special needs
35	struct ev_loop *loop = ev_default_loop (0);	46	struct ev_loop *loop = ev_default_loop (0);
36		47
37	/* initialise an io watcher, then start it */	48	// initialise an io watcher, then start it
		49	// this one will watch for stdin to become readable
38	ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);	50	ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);
39	ev_io_start (loop, &stdin_watcher);	51	ev_io_start (loop, &stdin_watcher);
40		52
		53	// initialise a timer watcher, then start it
41	/* simple non-repeating 5.5 second timeout */	54	// simple non-repeating 5.5 second timeout
42	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);	55	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
43	ev_timer_start (loop, &timeout_watcher);	56	ev_timer_start (loop, &timeout_watcher);
44		57
45	/* loop till timeout or data ready */	58	// now wait for events to arrive
46	ev_loop (loop, 0);	59	ev_loop (loop, 0);
47		60
		61	// unloop was called, so exit
48	return 0;	62	return 0;
49	}	63	}
50		64
51	=head1 DESCRIPTION	65	=head1 DESCRIPTION
52		66
53	The newest version of this document is also available as a html-formatted	67	The newest version of this document is also available as an html-formatted
54	web page you might find easier to navigate when reading it for the first	68	web page you might find easier to navigate when reading it for the first
55	time: L<http://cvs.schmorp.de/libev/ev.html>.	69	time: L<http://cvs.schmorp.de/libev/ev.html>.
56		70
57	Libev is an event loop: you register interest in certain events (such as a	71	Libev is an event loop: you register interest in certain events (such as a
58	file descriptor being readable or a timeout occuring), and it will manage	72	file descriptor being readable or a timeout occurring), and it will manage
59	these event sources and provide your program with events.	73	these event sources and provide your program with events.
60		74
61	To do this, it must take more or less complete control over your process	75	To do this, it must take more or less complete control over your process
62	(or thread) by executing the I<event loop> handler, and will then	76	(or thread) by executing the I<event loop> handler, and will then
63	communicate events via a callback mechanism.	77	communicate events via a callback mechanism.
…		…
65	You register interest in certain events by registering so-called I<event	79	You register interest in certain events by registering so-called I<event
66	watchers>, which are relatively small C structures you initialise with the	80	watchers>, which are relatively small C structures you initialise with the
67	details of the event, and then hand it over to libev by I<starting> the	81	details of the event, and then hand it over to libev by I<starting> the
68	watcher.	82	watcher.
69		83
70	=head1 FEATURES	84	=head2 FEATURES
71		85
72	Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the	86	Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the
73	BSD-specific C<kqueue> and the Solaris-specific event port mechanisms	87	BSD-specific C<kqueue> and the Solaris-specific event port mechanisms
74	for file descriptor events (C<ev_io>), the Linux C<inotify> interface	88	for file descriptor events (C<ev_io>), the Linux C<inotify> interface
75	(for C<ev_stat>), relative timers (C<ev_timer>), absolute timers	89	(for C<ev_stat>), relative timers (C<ev_timer>), absolute timers
…		…
82		96
83	It also is quite fast (see this	97	It also is quite fast (see this
84	L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent	98	L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent
85	for example).	99	for example).
86		100
87	=head1 CONVENTIONS	101	=head2 CONVENTIONS
88		102
89	Libev is very configurable. In this manual the default configuration will	103	Libev is very configurable. In this manual the default (and most common)
90	be described, which supports multiple event loops. For more info about	104	configuration will be described, which supports multiple event loops. For
91	various configuration options please have a look at B<EMBED> section in	105	more info about various configuration options please have a look at
92	this manual. If libev was configured without support for multiple event	106	B<EMBED> section in this manual. If libev was configured without support
93	loops, then all functions taking an initial argument of name C<loop>	107	for multiple event loops, then all functions taking an initial argument of
94	(which is always of type C<struct ev_loop *>) will not have this argument.	108	name C<loop> (which is always of type C<struct ev_loop *>) will not have
		109	this argument.
95		110
96	=head1 TIME REPRESENTATION	111	=head2 TIME REPRESENTATION
97		112
98	Libev represents time as a single floating point number, representing the	113	Libev represents time as a single floating point number, representing the
99	(fractional) number of seconds since the (POSIX) epoch (somewhere near	114	(fractional) number of seconds since the (POSIX) epoch (somewhere near
100	the beginning of 1970, details are complicated, don't ask). This type is	115	the beginning of 1970, details are complicated, don't ask). This type is
101	called C<ev_tstamp>, which is what you should use too. It usually aliases	116	called C<ev_tstamp>, which is what you should use too. It usually aliases
102	to the C<double> type in C, and when you need to do any calculations on	117	to the C<double> type in C, and when you need to do any calculations on
103	it, you should treat it as such.	118	it, you should treat it as some floatingpoint value. Unlike the name
		119	component C<stamp> might indicate, it is also used for time differences
		120	throughout libev.
104		121
105	=head1 GLOBAL FUNCTIONS	122	=head1 GLOBAL FUNCTIONS
106		123
107	These functions can be called anytime, even before initialising the	124	These functions can be called anytime, even before initialising the
108	library in any way.	125	library in any way.
…		…
113		130
114	Returns the current time as libev would use it. Please note that the	131	Returns the current time as libev would use it. Please note that the
115	C<ev_now> function is usually faster and also often returns the timestamp	132	C<ev_now> function is usually faster and also often returns the timestamp
116	you actually want to know.	133	you actually want to know.
117		134
		135	=item ev_sleep (ev_tstamp interval)
		136
		137	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
		139	this is a subsecond-resolution C<sleep ()>.
		140
118	=item int ev_version_major ()	141	=item int ev_version_major ()
119		142
120	=item int ev_version_minor ()	143	=item int ev_version_minor ()
121		144
122	You can find out the major and minor version numbers of the library	145	You can find out the major and minor ABI version numbers of the library
123	you linked against by calling the functions C<ev_version_major> and	146	you linked against by calling the functions C<ev_version_major> and
124	C<ev_version_minor>. If you want, you can compare against the global	147	C<ev_version_minor>. If you want, you can compare against the global
125	symbols C<EV_VERSION_MAJOR> and C<EV_VERSION_MINOR>, which specify the	148	symbols C<EV_VERSION_MAJOR> and C<EV_VERSION_MINOR>, which specify the
126	version of the library your program was compiled against.	149	version of the library your program was compiled against.
127		150
		151	These version numbers refer to the ABI version of the library, not the
		152	release version.
		153
128	Usually, it's a good idea to terminate if the major versions mismatch,	154	Usually, it's a good idea to terminate if the major versions mismatch,
129	as this indicates an incompatible change. Minor versions are usually	155	as this indicates an incompatible change. Minor versions are usually
130	compatible to older versions, so a larger minor version alone is usually	156	compatible to older versions, so a larger minor version alone is usually
131	not a problem.	157	not a problem.
132		158
133	Example: Make sure we haven't accidentally been linked against the wrong	159	Example: Make sure we haven't accidentally been linked against the wrong
134	version.	160	version.
…		…
249	flags. If that is troubling you, check C<ev_backend ()> afterwards).	275	flags. If that is troubling you, check C<ev_backend ()> afterwards).
250		276
251	If you don't know what event loop to use, use the one returned from this	277	If you don't know what event loop to use, use the one returned from this
252	function.	278	function.
253		279
		280	The default loop is the only loop that can handle C<ev_signal> and
		281	C<ev_child> watchers, and to do this, it always registers a handler
		282	for C<SIGCHLD>. If this is a problem for your app you can either
		283	create a dynamic loop with C<ev_loop_new> that doesn't do that, or you
		284	can simply overwrite the C<SIGCHLD> signal handler I<after> calling
		285	C<ev_default_init>.
		286
254	The flags argument can be used to specify special behaviour or specific	287	The flags argument can be used to specify special behaviour or specific
255	backends to use, and is usually specified as C<0> (or C<EVFLAG_AUTO>).	288	backends to use, and is usually specified as C<0> (or C<EVFLAG_AUTO>).
256		289
257	The following flags are supported:	290	The following flags are supported:
258		291
…		…
279	enabling this flag.	312	enabling this flag.
280		313
281	This works by calling C<getpid ()> on every iteration of the loop,	314	This works by calling C<getpid ()> on every iteration of the loop,
282	and thus this might slow down your event loop if you do a lot of loop	315	and thus this might slow down your event loop if you do a lot of loop
283	iterations and little real work, but is usually not noticeable (on my	316	iterations and little real work, but is usually not noticeable (on my
284	Linux system for example, C<getpid> is actually a simple 5-insn sequence	317	GNU/Linux system for example, C<getpid> is actually a simple 5-insn sequence
285	without a syscall and thus I<very> fast, but my Linux system also has	318	without a syscall and thus I<very> fast, but my GNU/Linux system also has
286	C<pthread_atfork> which is even faster).	319	C<pthread_atfork> which is even faster).
287		320
288	The big advantage of this flag is that you can forget about fork (and	321	The big advantage of this flag is that you can forget about fork (and
289	forget about forgetting to tell libev about forking) when you use this	322	forget about forgetting to tell libev about forking) when you use this
290	flag.	323	flag.
…		…
295	=item C<EVBACKEND_SELECT> (value 1, portable select backend)	328	=item C<EVBACKEND_SELECT> (value 1, portable select backend)
296		329
297	This is your standard select(2) backend. Not I<completely> standard, as	330	This is your standard select(2) backend. Not I<completely> standard, as
298	libev tries to roll its own fd_set with no limits on the number of fds,	331	libev tries to roll its own fd_set with no limits on the number of fds,
299	but if that fails, expect a fairly low limit on the number of fds when	332	but if that fails, expect a fairly low limit on the number of fds when
300	using this backend. It doesn't scale too well (O(highest_fd)), but its usually	333	using this backend. It doesn't scale too well (O(highest_fd)), but its
301	the fastest backend for a low number of fds.	334	usually the fastest backend for a low number of (low-numbered :) fds.
		335
		336	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
		338	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
		340	a look at C<ev_set_io_collect_interval ()> to increase the amount of
		341	readyness notifications you get per iteration.
302		342
303	=item C<EVBACKEND_POLL> (value 2, poll backend, available everywhere except on windows)	343	=item C<EVBACKEND_POLL> (value 2, poll backend, available everywhere except on windows)
304		344
305	And this is your standard poll(2) backend. It's more complicated than	345	And this is your standard poll(2) backend. It's more complicated
306	select, but handles sparse fds better and has no artificial limit on the	346	than select, but handles sparse fds better and has no artificial
307	number of fds you can use (except it will slow down considerably with a	347	limit on the number of fds you can use (except it will slow down
308	lot of inactive fds). It scales similarly to select, i.e. O(total_fds).	348	considerably with a lot of inactive fds). It scales similarly to select,
		349	i.e. O(total_fds). See the entry for C<EVBACKEND_SELECT>, above, for
		350	performance tips.
309		351
310	=item C<EVBACKEND_EPOLL> (value 4, Linux)	352	=item C<EVBACKEND_EPOLL> (value 4, Linux)
311		353
312	For few fds, this backend is a bit little slower than poll and select,	354	For few fds, this backend is a bit little slower than poll and select,
313	but it scales phenomenally better. While poll and select usually scale like	355	but it scales phenomenally better. While poll and select usually scale
314	O(total_fds) where n is the total number of fds (or the highest fd), epoll scales	356	like O(total_fds) where n is the total number of fds (or the highest fd),
315	either O(1) or O(active_fds).	357	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
		359	cases and rewiring a syscall per fd change, no fork support and bad
		360	support for dup.
316		361
317	While stopping and starting an I/O watcher in the same iteration will	362	While stopping, setting and starting an I/O watcher in the same iteration
318	result in some caching, there is still a syscall per such incident	363	will result in some caching, there is still a syscall per such incident
319	(because the fd could point to a different file description now), so its	364	(because the fd could point to a different file description now), so its
320	best to avoid that. Also, dup()ed file descriptors might not work very	365	best to avoid that. Also, C<dup ()>'ed file descriptors might not work
321	well if you register events for both fds.	366	very well if you register events for both fds.
322		367
323	Please note that epoll sometimes generates spurious notifications, so you	368	Please note that epoll sometimes generates spurious notifications, so you
324	need to use non-blocking I/O or other means to avoid blocking when no data	369	need to use non-blocking I/O or other means to avoid blocking when no data
325	(or space) is available.	370	(or space) is available.
326		371
		372	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.
		374	keep at least one watcher active per fd at all times.
		375
		376	While nominally embeddeble in other event loops, this feature is broken in
		377	all kernel versions tested so far.
		378
327	=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)	379	=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)
328		380
329	Kqueue deserves special mention, as at the time of this writing, it	381	Kqueue deserves special mention, as at the time of this writing, it
330	was broken on all BSDs except NetBSD (usually it doesn't work with	382	was broken on all BSDs except NetBSD (usually it doesn't work reliably
331	anything but sockets and pipes, except on Darwin, where of course its	383	with anything but sockets and pipes, except on Darwin, where of course
332	completely useless). For this reason its not being "autodetected"	384	it's completely useless). For this reason it's not being "autodetected"
333	unless you explicitly specify it explicitly in the flags (i.e. using	385	unless you explicitly specify it explicitly in the flags (i.e. using
334	C<EVBACKEND_KQUEUE>).	386	C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough)
		387	system like NetBSD.
		388
		389	You still can embed kqueue into a normal poll or select backend and use it
		390	only for sockets (after having made sure that sockets work with kqueue on
		391	the target platform). See C<ev_embed> watchers for more info.
335		392
336	It scales in the same way as the epoll backend, but the interface to the	393	It scales in the same way as the epoll backend, but the interface to the
337	kernel is more efficient (which says nothing about its actual speed, of	394	kernel is more efficient (which says nothing about its actual speed, of
338	course). While starting and stopping an I/O watcher does not cause an	395	course). While stopping, setting and starting an I/O watcher does never
339	extra syscall as with epoll, it still adds up to four event changes per	396	cause an extra syscall as with C<EVBACKEND_EPOLL>, it still adds up to
340	incident, so its best to avoid that.	397	two event changes per incident, support for C<fork ()> is very bad and it
		398	drops fds silently in similarly hard-to-detect cases.
		399
		400	This backend usually performs well under most conditions.
		401
		402	While nominally embeddable in other event loops, this doesn't work
		403	everywhere, so you might need to test for this. And since it is broken
		404	almost everywhere, you should only use it when you have a lot of sockets
		405	(for which it usually works), by embedding it into another event loop
		406	(e.g. C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>) and using it only for
		407	sockets.
341		408
342	=item C<EVBACKEND_DEVPOLL> (value 16, Solaris 8)	409	=item C<EVBACKEND_DEVPOLL> (value 16, Solaris 8)
343		410
344	This is not implemented yet (and might never be).	411	This is not implemented yet (and might never be, unless you send me an
		412	implementation). According to reports, C</dev/poll> only supports sockets
		413	and is not embeddable, which would limit the usefulness of this backend
		414	immensely.
345		415
346	=item C<EVBACKEND_PORT> (value 32, Solaris 10)	416	=item C<EVBACKEND_PORT> (value 32, Solaris 10)
347		417
348	This uses the Solaris 10 port mechanism. As with everything on Solaris,	418	This uses the Solaris 10 event port mechanism. As with everything on Solaris,
349	it's really slow, but it still scales very well (O(active_fds)).	419	it's really slow, but it still scales very well (O(active_fds)).
350		420
351	Please note that solaris ports can result in a lot of spurious	421	Please note that solaris event ports can deliver a lot of spurious
352	notifications, so you need to use non-blocking I/O or other means to avoid	422	notifications, so you need to use non-blocking I/O or other means to avoid
353	blocking when no data (or space) is available.	423	blocking when no data (or space) is available.
		424
		425	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
		427	descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend
		428	might perform better.
		429
		430	On the positive side, ignoring the spurious readyness notifications, this
		431	backend actually performed to specification in all tests and is fully
		432	embeddable, which is a rare feat among the OS-specific backends.
354		433
355	=item C<EVBACKEND_ALL>	434	=item C<EVBACKEND_ALL>
356		435
357	Try all backends (even potentially broken ones that wouldn't be tried	436	Try all backends (even potentially broken ones that wouldn't be tried
358	with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as	437	with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as
359	C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>.	438	C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>.
360		439
		440	It is definitely not recommended to use this flag.
		441
361	=back	442	=back
362		443
363	If one or more of these are ored into the flags value, then only these	444	If one or more of these are ored into the flags value, then only these
364	backends will be tried (in the reverse order as given here). If none are	445	backends will be tried (in the reverse order as listed here). If none are
365	specified, most compiled-in backend will be tried, usually in reverse	446	specified, all backends in C<ev_recommended_backends ()> will be tried.
366	order of their flag values :)
367		447
368	The most typical usage is like this:	448	The most typical usage is like this:
369		449
370	if (!ev_default_loop (0))	450	if (!ev_default_loop (0))
371	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");	451	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
…		…
399	Destroys the default loop again (frees all memory and kernel state	479	Destroys the default loop again (frees all memory and kernel state
400	etc.). None of the active event watchers will be stopped in the normal	480	etc.). None of the active event watchers will be stopped in the normal
401	sense, so e.g. C<ev_is_active> might still return true. It is your	481	sense, so e.g. C<ev_is_active> might still return true. It is your
402	responsibility to either stop all watchers cleanly yoursef I<before>	482	responsibility to either stop all watchers cleanly yoursef I<before>
403	calling this function, or cope with the fact afterwards (which is usually	483	calling this function, or cope with the fact afterwards (which is usually
404	the easiest thing, youc na just ignore the watchers and/or C<free ()> them	484	the easiest thing, you can just ignore the watchers and/or C<free ()> them
405	for example).	485	for example).
		486
		487	Note that certain global state, such as signal state, will not be freed by
		488	this function, and related watchers (such as signal and child watchers)
		489	would need to be stopped manually.
		490
		491	In general it is not advisable to call this function except in the
		492	rare occasion where you really need to free e.g. the signal handling
		493	pipe fds. If you need dynamically allocated loops it is better to use
		494	C<ev_loop_new> and C<ev_loop_destroy>).
406		495
407	=item ev_loop_destroy (loop)	496	=item ev_loop_destroy (loop)
408		497
409	Like C<ev_default_destroy>, but destroys an event loop created by an	498	Like C<ev_default_destroy>, but destroys an event loop created by an
410	earlier call to C<ev_loop_new>.	499	earlier call to C<ev_loop_new>.
411		500
412	=item ev_default_fork ()	501	=item ev_default_fork ()
413		502
		503	This function sets a flag that causes subsequent C<ev_loop> iterations
414	This function reinitialises the kernel state for backends that have	504	to reinitialise the kernel state for backends that have one. Despite the
415	one. Despite the name, you can call it anytime, but it makes most sense	505	name, you can call it anytime, but it makes most sense after forking, in
416	after forking, in either the parent or child process (or both, but that	506	the child process (or both child and parent, but that again makes little
417	again makes little sense).	507	sense). You I<must> call it in the child before using any of the libev
		508	functions, and it will only take effect at the next C<ev_loop> iteration.
418		509
419	You I<must> call this function in the child process after forking if and	510	On the other hand, you only need to call this function in the child
420	only if you want to use the event library in both processes. If you just	511	process if and only if you want to use the event library in the child. If
421	fork+exec, you don't have to call it.	512	you just fork+exec, you don't have to call it at all.
422		513
423	The function itself is quite fast and it's usually not a problem to call	514	The function itself is quite fast and it's usually not a problem to call
424	it just in case after a fork. To make this easy, the function will fit in	515	it just in case after a fork. To make this easy, the function will fit in
425	quite nicely into a call to C<pthread_atfork>:	516	quite nicely into a call to C<pthread_atfork>:
426		517
427	pthread_atfork (0, 0, ev_default_fork);	518	pthread_atfork (0, 0, ev_default_fork);
428		519
429	At the moment, C<EVBACKEND_SELECT> and C<EVBACKEND_POLL> are safe to use
430	without calling this function, so if you force one of those backends you
431	do not need to care.
432
433	=item ev_loop_fork (loop)	520	=item ev_loop_fork (loop)
434		521
435	Like C<ev_default_fork>, but acts on an event loop created by	522	Like C<ev_default_fork>, but acts on an event loop created by
436	C<ev_loop_new>. Yes, you have to call this on every allocated event loop	523	C<ev_loop_new>. Yes, you have to call this on every allocated event loop
437	after fork, and how you do this is entirely your own problem.	524	after fork, and how you do this is entirely your own problem.
		525
		526	=item int ev_is_default_loop (loop)
		527
		528	Returns true when the given loop actually is the default loop, false otherwise.
438		529
439	=item unsigned int ev_loop_count (loop)	530	=item unsigned int ev_loop_count (loop)
440		531
441	Returns the count of loop iterations for the loop, which is identical to	532	Returns the count of loop iterations for the loop, which is identical to
442	the number of times libev did poll for new events. It starts at C<0> and	533	the number of times libev did poll for new events. It starts at C<0> and
…		…
455		546
456	Returns the current "event loop time", which is the time the event loop	547	Returns the current "event loop time", which is the time the event loop
457	received events and started processing them. This timestamp does not	548	received events and started processing them. This timestamp does not
458	change as long as callbacks are being processed, and this is also the base	549	change as long as callbacks are being processed, and this is also the base
459	time used for relative timers. You can treat it as the timestamp of the	550	time used for relative timers. You can treat it as the timestamp of the
460	event occuring (or more correctly, libev finding out about it).	551	event occurring (or more correctly, libev finding out about it).
461		552
462	=item ev_loop (loop, int flags)	553	=item ev_loop (loop, int flags)
463		554
464	Finally, this is it, the event handler. This function usually is called	555	Finally, this is it, the event handler. This function usually is called
465	after you initialised all your watchers and you want to start handling	556	after you initialised all your watchers and you want to start handling
…		…
487	usually a better approach for this kind of thing.	578	usually a better approach for this kind of thing.
488		579
489	Here are the gory details of what C<ev_loop> does:	580	Here are the gory details of what C<ev_loop> does:
490		581
491	- Before the first iteration, call any pending watchers.	582	- Before the first iteration, call any pending watchers.
492	* If there are no active watchers (reference count is zero), return.	583	* If EVFLAG_FORKCHECK was used, check for a fork.
493	- Queue all prepare watchers and then call all outstanding watchers.	584	- If a fork was detected, queue and call all fork watchers.
		585	- Queue and call all prepare watchers.
494	- If we have been forked, recreate the kernel state.	586	- If we have been forked, recreate the kernel state.
495	- Update the kernel state with all outstanding changes.	587	- Update the kernel state with all outstanding changes.
496	- Update the "event loop time".	588	- Update the "event loop time".
497	- Calculate for how long to block.	589	- Calculate for how long to sleep or block, if at all
		590	(active idle watchers, EVLOOP_NONBLOCK or not having
		591	any active watchers at all will result in not sleeping).
		592	- Sleep if the I/O and timer collect interval say so.
498	- Block the process, waiting for any events.	593	- Block the process, waiting for any events.
499	- Queue all outstanding I/O (fd) events.	594	- Queue all outstanding I/O (fd) events.
500	- Update the "event loop time" and do time jump handling.	595	- Update the "event loop time" and do time jump handling.
501	- Queue all outstanding timers.	596	- Queue all outstanding timers.
502	- Queue all outstanding periodics.	597	- Queue all outstanding periodics.
503	- If no events are pending now, queue all idle watchers.	598	- If no events are pending now, queue all idle watchers.
504	- Queue all check watchers.	599	- Queue all check watchers.
505	- Call all queued watchers in reverse order (i.e. check watchers first).	600	- Call all queued watchers in reverse order (i.e. check watchers first).
506	Signals and child watchers are implemented as I/O watchers, and will	601	Signals and child watchers are implemented as I/O watchers, and will
507	be handled here by queueing them when their watcher gets executed.	602	be handled here by queueing them when their watcher gets executed.
508	- If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK	603	- If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK
509	were used, return, otherwise continue with step *.	604	were used, or there are no active watchers, return, otherwise
		605	continue with step *.
510		606
511	Example: Queue some jobs and then loop until no events are outsanding	607	Example: Queue some jobs and then loop until no events are outstanding
512	anymore.	608	anymore.
513		609
514	... queue jobs here, make sure they register event watchers as long	610	... queue jobs here, make sure they register event watchers as long
515	... as they still have work to do (even an idle watcher will do..)	611	... as they still have work to do (even an idle watcher will do..)
516	ev_loop (my_loop, 0);	612	ev_loop (my_loop, 0);
…		…
520		616
521	Can be used to make a call to C<ev_loop> return early (but only after it	617	Can be used to make a call to C<ev_loop> return early (but only after it
522	has processed all outstanding events). The C<how> argument must be either	618	has processed all outstanding events). The C<how> argument must be either
523	C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or	619	C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or
524	C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return.	620	C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return.
		621
		622	This "unloop state" will be cleared when entering C<ev_loop> again.
525		623
526	=item ev_ref (loop)	624	=item ev_ref (loop)
527		625
528	=item ev_unref (loop)	626	=item ev_unref (loop)
529		627
…		…
534	returning, ev_unref() after starting, and ev_ref() before stopping it. For	632	returning, ev_unref() after starting, and ev_ref() before stopping it. For
535	example, libev itself uses this for its internal signal pipe: It is not	633	example, libev itself uses this for its internal signal pipe: It is not
536	visible to the libev user and should not keep C<ev_loop> from exiting if	634	visible to the libev user and should not keep C<ev_loop> from exiting if
537	no event watchers registered by it are active. It is also an excellent	635	no event watchers registered by it are active. It is also an excellent
538	way to do this for generic recurring timers or from within third-party	636	way to do this for generic recurring timers or from within third-party
539	libraries. Just remember to I<unref after start> and I<ref before stop>.	637	libraries. Just remember to I<unref after start> and I<ref before stop>
		638	(but only if the watcher wasn't active before, or was active before,
		639	respectively).
540		640
541	Example: Create a signal watcher, but keep it from keeping C<ev_loop>	641	Example: Create a signal watcher, but keep it from keeping C<ev_loop>
542	running when nothing else is active.	642	running when nothing else is active.
543		643
544	struct ev_signal exitsig;	644	struct ev_signal exitsig;
…		…
548		648
549	Example: For some weird reason, unregister the above signal handler again.	649	Example: For some weird reason, unregister the above signal handler again.
550		650
551	ev_ref (loop);	651	ev_ref (loop);
552	ev_signal_stop (loop, &exitsig);	652	ev_signal_stop (loop, &exitsig);
		653
		654	=item ev_set_io_collect_interval (loop, ev_tstamp interval)
		655
		656	=item ev_set_timeout_collect_interval (loop, ev_tstamp interval)
		657
		658	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
		660	invoke timer/periodic callbacks and I/O callbacks with minimum latency.
		661
		662	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
		664	increase efficiency of loop iterations.
		665
		666	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
		668	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
		670	overhead for the actual polling but can deliver many events at once.
		671
		672	By setting a higher I<io collect interval> you allow libev to spend more
		673	time collecting I/O events, so you can handle more events per iteration,
		674	at the cost of increasing latency. Timeouts (both C<ev_periodic> and
		675	C<ev_timer>) will be not affected. Setting this to a non-null value will
		676	introduce an additional C<ev_sleep ()> call into most loop iterations.
		677
		678	Likewise, by setting a higher I<timeout collect interval> you allow libev
		679	to spend more time collecting timeouts, at the expense of increased
		680	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
		682	any overhead in libev.
		683
		684	Many (busy) programs can usually benefit by setting the io collect
		685	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
		687	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.
553		689
554	=back	690	=back
555		691
556		692
557	=head1 ANATOMY OF A WATCHER	693	=head1 ANATOMY OF A WATCHER
…		…
656		792
657	=item C<EV_FORK>	793	=item C<EV_FORK>
658		794
659	The event loop has been resumed in the child process after fork (see	795	The event loop has been resumed in the child process after fork (see
660	C<ev_fork>).	796	C<ev_fork>).
		797
		798	=item C<EV_ASYNC>
		799
		800	The given async watcher has been asynchronously notified (see C<ev_async>).
661		801
662	=item C<EV_ERROR>	802	=item C<EV_ERROR>
663		803
664	An unspecified error has occured, the watcher has been stopped. This might	804	An unspecified error has occured, the watcher has been stopped. This might
665	happen because the watcher could not be properly started because libev	805	happen because the watcher could not be properly started because libev
…		…
883	In general you can register as many read and/or write event watchers per	1023	In general you can register as many read and/or write event watchers per
884	fd as you want (as long as you don't confuse yourself). Setting all file	1024	fd as you want (as long as you don't confuse yourself). Setting all file
885	descriptors to non-blocking mode is also usually a good idea (but not	1025	descriptors to non-blocking mode is also usually a good idea (but not
886	required if you know what you are doing).	1026	required if you know what you are doing).
887		1027
888	You have to be careful with dup'ed file descriptors, though. Some backends
889	(the linux epoll backend is a notable example) cannot handle dup'ed file
890	descriptors correctly if you register interest in two or more fds pointing
891	to the same underlying file/socket/etc. description (that is, they share
892	the same underlying "file open").
893
894	If you must do this, then force the use of a known-to-be-good backend	1028	If you must do this, then force the use of a known-to-be-good backend
895	(at the time of this writing, this includes only C<EVBACKEND_SELECT> and	1029	(at the time of this writing, this includes only C<EVBACKEND_SELECT> and
896	C<EVBACKEND_POLL>).	1030	C<EVBACKEND_POLL>).
897		1031
898	Another thing you have to watch out for is that it is quite easy to	1032	Another thing you have to watch out for is that it is quite easy to
…		…
908	play around with an Xlib connection), then you have to seperately re-test	1042	play around with an Xlib connection), then you have to seperately re-test
909	whether a file descriptor is really ready with a known-to-be good interface	1043	whether a file descriptor is really ready with a known-to-be good interface
910	such as poll (fortunately in our Xlib example, Xlib already does this on	1044	such as poll (fortunately in our Xlib example, Xlib already does this on
911	its own, so its quite safe to use).	1045	its own, so its quite safe to use).
912		1046
		1047	=head3 The special problem of disappearing file descriptors
		1048
		1049	Some backends (e.g. kqueue, epoll) need to be told about closing a file
		1050	descriptor (either by calling C<close> explicitly or by any other means,
		1051	such as C<dup>). The reason is that you register interest in some file
		1052	descriptor, but when it goes away, the operating system will silently drop
		1053	this interest. If another file descriptor with the same number then is
		1054	registered with libev, there is no efficient way to see that this is, in
		1055	fact, a different file descriptor.
		1056
		1057	To avoid having to explicitly tell libev about such cases, libev follows
		1058	the following policy: Each time C<ev_io_set> is being called, libev
		1059	will assume that this is potentially a new file descriptor, otherwise
		1060	it is assumed that the file descriptor stays the same. That means that
		1061	you I<have> to call C<ev_io_set> (or C<ev_io_init>) when you change the
		1062	descriptor even if the file descriptor number itself did not change.
		1063
		1064	This is how one would do it normally anyway, the important point is that
		1065	the libev application should not optimise around libev but should leave
		1066	optimisations to libev.
		1067
		1068	=head3 The special problem of dup'ed file descriptors
		1069
		1070	Some backends (e.g. epoll), cannot register events for file descriptors,
		1071	but only events for the underlying file descriptions. That means when you
		1072	have C<dup ()>'ed file descriptors or weirder constellations, and register
		1073	events for them, only one file descriptor might actually receive events.
		1074
		1075	There is no workaround possible except not registering events
		1076	for potentially C<dup ()>'ed file descriptors, or to resort to
		1077	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
		1078
		1079	=head3 The special problem of fork
		1080
		1081	Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit
		1082	useless behaviour. Libev fully supports fork, but needs to be told about
		1083	it in the child.
		1084
		1085	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,
		1087	enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or
		1088	C<EVBACKEND_POLL>.
		1089
		1090	=head3 The special problem of SIGPIPE
		1091
		1092	While not really specific to libev, it is easy to forget about SIGPIPE:
		1093	when reading from a pipe whose other end has been closed, your program
		1094	gets send a SIGPIPE, which, by default, aborts your program. For most
		1095	programs this is sensible behaviour, for daemons, this is usually
		1096	undesirable.
		1097
		1098	So when you encounter spurious, unexplained daemon exits, make sure you
		1099	ignore SIGPIPE (and maybe make sure you log the exit status of your daemon
		1100	somewhere, as that would have given you a big clue).
		1101
		1102
		1103	=head3 Watcher-Specific Functions
		1104
913	=over 4	1105	=over 4
914		1106
915	=item ev_io_init (ev_io *, callback, int fd, int events)	1107	=item ev_io_init (ev_io *, callback, int fd, int events)
916		1108
917	=item ev_io_set (ev_io *, int fd, int events)	1109	=item ev_io_set (ev_io *, int fd, int events)
…		…
927	=item int events [read-only]	1119	=item int events [read-only]
928		1120
929	The events being watched.	1121	The events being watched.
930		1122
931	=back	1123	=back
		1124
		1125	=head3 Examples
932		1126
933	Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well	1127	Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well
934	readable, but only once. Since it is likely line-buffered, you could	1128	readable, but only once. Since it is likely line-buffered, you could
935	attempt to read a whole line in the callback.	1129	attempt to read a whole line in the callback.
936		1130
…		…
970		1164
971	The callback is guarenteed to be invoked only when its timeout has passed,	1165	The callback is guarenteed to be invoked only when its timeout has passed,
972	but if multiple timers become ready during the same loop iteration then	1166	but if multiple timers become ready during the same loop iteration then
973	order of execution is undefined.	1167	order of execution is undefined.
974		1168
		1169	=head3 Watcher-Specific Functions and Data Members
		1170
975	=over 4	1171	=over 4
976		1172
977	=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)	1173	=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
978		1174
979	=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)	1175	=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)
…		…
987	configure a timer to trigger every 10 seconds, then it will trigger at	1183	configure a timer to trigger every 10 seconds, then it will trigger at
988	exactly 10 second intervals. If, however, your program cannot keep up with	1184	exactly 10 second intervals. If, however, your program cannot keep up with
989	the timer (because it takes longer than those 10 seconds to do stuff) the	1185	the timer (because it takes longer than those 10 seconds to do stuff) the
990	timer will not fire more than once per event loop iteration.	1186	timer will not fire more than once per event loop iteration.
991		1187
992	=item ev_timer_again (loop)	1188	=item ev_timer_again (loop, ev_timer *)
993		1189
994	This will act as if the timer timed out and restart it again if it is	1190	This will act as if the timer timed out and restart it again if it is
995	repeating. The exact semantics are:	1191	repeating. The exact semantics are:
996		1192
997	If the timer is pending, its pending status is cleared.	1193	If the timer is pending, its pending status is cleared.
…		…
1032	or C<ev_timer_again> is called and determines the next timeout (if any),	1228	or C<ev_timer_again> is called and determines the next timeout (if any),
1033	which is also when any modifications are taken into account.	1229	which is also when any modifications are taken into account.
1034		1230
1035	=back	1231	=back
1036		1232
		1233	=head3 Examples
		1234
1037	Example: Create a timer that fires after 60 seconds.	1235	Example: Create a timer that fires after 60 seconds.
1038		1236
1039	static void	1237	static void
1040	one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents)	1238	one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents)
1041	{	1239	{
…		…
1084		1282
1085	As with timers, the callback is guarenteed to be invoked only when the	1283	As with timers, the callback is guarenteed to be invoked only when the
1086	time (C<at>) has been passed, but if multiple periodic timers become ready	1284	time (C<at>) has been passed, but if multiple periodic timers become ready
1087	during the same loop iteration then order of execution is undefined.	1285	during the same loop iteration then order of execution is undefined.
1088		1286
		1287	=head3 Watcher-Specific Functions and Data Members
		1288
1089	=over 4	1289	=over 4
1090		1290
1091	=item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)	1291	=item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)
1092		1292
1093	=item ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)	1293	=item ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)
…		…
1102	In this configuration the watcher triggers an event at the wallclock time	1302	In this configuration the watcher triggers an event at the wallclock time
1103	C<at> and doesn't repeat. It will not adjust when a time jump occurs,	1303	C<at> and doesn't repeat. It will not adjust when a time jump occurs,
1104	that is, if it is to be run at January 1st 2011 then it will run when the	1304	that is, if it is to be run at January 1st 2011 then it will run when the
1105	system time reaches or surpasses this time.	1305	system time reaches or surpasses this time.
1106		1306
1107	=item * non-repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)	1307	=item * repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)
1108		1308
1109	In this mode the watcher will always be scheduled to time out at the next	1309	In this mode the watcher will always be scheduled to time out at the next
1110	C<at + N * interval> time (for some integer N, which can also be negative)	1310	C<at + N * interval> time (for some integer N, which can also be negative)
1111	and then repeat, regardless of any time jumps.	1311	and then repeat, regardless of any time jumps.
1112		1312
…		…
1189		1389
1190	The current reschedule callback, or C<0>, if this functionality is	1390	The current reschedule callback, or C<0>, if this functionality is
1191	switched off. Can be changed any time, but changes only take effect when	1391	switched off. Can be changed any time, but changes only take effect when
1192	the periodic timer fires or C<ev_periodic_again> is being called.	1392	the periodic timer fires or C<ev_periodic_again> is being called.
1193		1393
		1394	=item ev_tstamp at [read-only]
		1395
		1396	When active, contains the absolute time that the watcher is supposed to
		1397	trigger next.
		1398
1194	=back	1399	=back
		1400
		1401	=head3 Examples
1195		1402
1196	Example: Call a callback every hour, or, more precisely, whenever the	1403	Example: Call a callback every hour, or, more precisely, whenever the
1197	system clock is divisible by 3600. The callback invocation times have	1404	system clock is divisible by 3600. The callback invocation times have
1198	potentially a lot of jittering, but good long-term stability.	1405	potentially a lot of jittering, but good long-term stability.
1199		1406
…		…
1239	with the kernel (thus it coexists with your own signal handlers as long	1446	with the kernel (thus it coexists with your own signal handlers as long
1240	as you don't register any with libev). Similarly, when the last signal	1447	as you don't register any with libev). Similarly, when the last signal
1241	watcher for a signal is stopped libev will reset the signal handler to	1448	watcher for a signal is stopped libev will reset the signal handler to
1242	SIG_DFL (regardless of what it was set to before).	1449	SIG_DFL (regardless of what it was set to before).
1243		1450
		1451	If possible and supported, libev will install its handlers with
		1452	C<SA_RESTART> behaviour enabled, so syscalls should not be unduly
		1453	interrupted. If you have a problem with syscalls getting interrupted by
		1454	signals you can block all signals in an C<ev_check> watcher and unblock
		1455	them in an C<ev_prepare> watcher.
		1456
		1457	=head3 Watcher-Specific Functions and Data Members
		1458
1244	=over 4	1459	=over 4
1245		1460
1246	=item ev_signal_init (ev_signal *, callback, int signum)	1461	=item ev_signal_init (ev_signal *, callback, int signum)
1247		1462
1248	=item ev_signal_set (ev_signal *, int signum)	1463	=item ev_signal_set (ev_signal *, int signum)
…		…
1254		1469
1255	The signal the watcher watches out for.	1470	The signal the watcher watches out for.
1256		1471
1257	=back	1472	=back
1258		1473
		1474	=head3 Examples
		1475
		1476	Example: Try to exit cleanly on SIGINT and SIGTERM.
		1477
		1478	static void
		1479	sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)
		1480	{
		1481	ev_unloop (loop, EVUNLOOP_ALL);
		1482	}
		1483
		1484	struct ev_signal signal_watcher;
		1485	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
		1486	ev_signal_start (loop, &sigint_cb);
		1487
1259		1488
1260	=head2 C<ev_child> - watch out for process status changes	1489	=head2 C<ev_child> - watch out for process status changes
1261		1490
1262	Child watchers trigger when your process receives a SIGCHLD in response to	1491	Child watchers trigger when your process receives a SIGCHLD in response to
1263	some child status changes (most typically when a child of yours dies).	1492	some child status changes (most typically when a child of yours dies). It
		1493	is permissible to install a child watcher I<after> the child has been
		1494	forked (which implies it might have already exited), as long as the event
		1495	loop isn't entered (or is continued from a watcher).
		1496
		1497	Only the default event loop is capable of handling signals, and therefore
		1498	you can only rgeister child watchers in the default event loop.
		1499
		1500	=head3 Process Interaction
		1501
		1502	Libev grabs C<SIGCHLD> as soon as the default event loop is
		1503	initialised. This is necessary to guarantee proper behaviour even if
		1504	the first child watcher is started after the child exits. The occurance
		1505	of C<SIGCHLD> is recorded asynchronously, but child reaping is done
		1506	synchronously as part of the event loop processing. Libev always reaps all
		1507	children, even ones not watched.
		1508
		1509	=head3 Overriding the Built-In Processing
		1510
		1511	Libev offers no special support for overriding the built-in child
		1512	processing, but if your application collides with libev's default child
		1513	handler, you can override it easily by installing your own handler for
		1514	C<SIGCHLD> after initialising the default loop, and making sure the
		1515	default loop never gets destroyed. You are encouraged, however, to use an
		1516	event-based approach to child reaping and thus use libev's support for
		1517	that, so other libev users can use C<ev_child> watchers freely.
		1518
		1519	=head3 Watcher-Specific Functions and Data Members
1264		1520
1265	=over 4	1521	=over 4
1266		1522
1267	=item ev_child_init (ev_child *, callback, int pid)	1523	=item ev_child_init (ev_child *, callback, int pid, int trace)
1268		1524
1269	=item ev_child_set (ev_child *, int pid)	1525	=item ev_child_set (ev_child *, int pid, int trace)
1270		1526
1271	Configures the watcher to wait for status changes of process C<pid> (or	1527	Configures the watcher to wait for status changes of process C<pid> (or
1272	I<any> process if C<pid> is specified as C<0>). The callback can look	1528	I<any> process if C<pid> is specified as C<0>). The callback can look
1273	at the C<rstatus> member of the C<ev_child> watcher structure to see	1529	at the C<rstatus> member of the C<ev_child> watcher structure to see
1274	the status word (use the macros from C<sys/wait.h> and see your systems	1530	the status word (use the macros from C<sys/wait.h> and see your systems
1275	C<waitpid> documentation). The C<rpid> member contains the pid of the	1531	C<waitpid> documentation). The C<rpid> member contains the pid of the
1276	process causing the status change.	1532	process causing the status change. C<trace> must be either C<0> (only
		1533	activate the watcher when the process terminates) or C<1> (additionally
		1534	activate the watcher when the process is stopped or continued).
1277		1535
1278	=item int pid [read-only]	1536	=item int pid [read-only]
1279		1537
1280	The process id this watcher watches out for, or C<0>, meaning any process id.	1538	The process id this watcher watches out for, or C<0>, meaning any process id.
1281		1539
…		…
1288	The process exit/trace status caused by C<rpid> (see your systems	1546	The process exit/trace status caused by C<rpid> (see your systems
1289	C<waitpid> and C<sys/wait.h> documentation for details).	1547	C<waitpid> and C<sys/wait.h> documentation for details).
1290		1548
1291	=back	1549	=back
1292		1550
1293	Example: Try to exit cleanly on SIGINT and SIGTERM.	1551	=head3 Examples
		1552
		1553	Example: C<fork()> a new process and install a child handler to wait for
		1554	its completion.
		1555
		1556	ev_child cw;
1294		1557
1295	static void	1558	static void
1296	sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)	1559	child_cb (EV_P_ struct ev_child *w, int revents)
1297	{	1560	{
1298	ev_unloop (loop, EVUNLOOP_ALL);	1561	ev_child_stop (EV_A_ w);
		1562	printf ("process %d exited with status %x\n", w->rpid, w->rstatus);
1299	}	1563	}
1300		1564
1301	struct ev_signal signal_watcher;	1565	pid_t pid = fork ();
1302	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);	1566
1303	ev_signal_start (loop, &sigint_cb);	1567	if (pid < 0)
		1568	// error
		1569	else if (pid == 0)
		1570	{
		1571	// the forked child executes here
		1572	exit (1);
		1573	}
		1574	else
		1575	{
		1576	ev_child_init (&cw, child_cb, pid, 0);
		1577	ev_child_start (EV_DEFAULT_ &cw);
		1578	}
1304		1579
1305		1580
1306	=head2 C<ev_stat> - did the file attributes just change?	1581	=head2 C<ev_stat> - did the file attributes just change?
1307		1582
1308	This watches a filesystem path for attribute changes. That is, it calls	1583	This watches a filesystem path for attribute changes. That is, it calls
…		…
1337	semantics of C<ev_stat> watchers, which means that libev sometimes needs	1612	semantics of C<ev_stat> watchers, which means that libev sometimes needs
1338	to fall back to regular polling again even with inotify, but changes are	1613	to fall back to regular polling again even with inotify, but changes are
1339	usually detected immediately, and if the file exists there will be no	1614	usually detected immediately, and if the file exists there will be no
1340	polling.	1615	polling.
1341		1616
		1617	=head3 ABI Issues (Largefile Support)
		1618
		1619	Libev by default (unless the user overrides this) uses the default
		1620	compilation environment, which means that on systems with optionally
		1621	disabled large file support, you get the 32 bit version of the stat
		1622	structure. When using the library from programs that change the ABI to
		1623	use 64 bit file offsets the programs will fail. In that case you have to
		1624	compile libev with the same flags to get binary compatibility. This is
		1625	obviously the case with any flags that change the ABI, but the problem is
		1626	most noticably with ev_stat and largefile support.
		1627
		1628	=head3 Inotify
		1629
		1630	When C<inotify (7)> support has been compiled into libev (generally only
		1631	available on Linux) and present at runtime, it will be used to speed up
		1632	change detection where possible. The inotify descriptor will be created lazily
		1633	when the first C<ev_stat> watcher is being started.
		1634
		1635	Inotify presense does not change the semantics of C<ev_stat> watchers
		1636	except that changes might be detected earlier, and in some cases, to avoid
		1637	making regular C<stat> calls. Even in the presense of inotify support
		1638	there are many cases where libev has to resort to regular C<stat> polling.
		1639
		1640	(There is no support for kqueue, as apparently it cannot be used to
		1641	implement this functionality, due to the requirement of having a file
		1642	descriptor open on the object at all times).
		1643
		1644	=head3 The special problem of stat time resolution
		1645
		1646	The C<stat ()> syscall only supports full-second resolution portably, and
		1647	even on systems where the resolution is higher, many filesystems still
		1648	only support whole seconds.
		1649
		1650	That means that, if the time is the only thing that changes, you might
		1651	miss updates: on the first update, C<ev_stat> detects a change and calls
		1652	your callback, which does something. When there is another update within
		1653	the same second, C<ev_stat> will be unable to detect it.
		1654
		1655	The solution to this is to delay acting on a change for a second (or till
		1656	the next second boundary), using a roughly one-second delay C<ev_timer>
		1657	(C<ev_timer_set (w, 0., 1.01); ev_timer_again (loop, w)>). The C<.01>
		1658	is added to work around small timing inconsistencies of some operating
		1659	systems.
		1660
		1661	=head3 Watcher-Specific Functions and Data Members
		1662
1342	=over 4	1663	=over 4
1343		1664
1344	=item ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)	1665	=item ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)
1345		1666
1346	=item ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)	1667	=item ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)
…		…
1353		1674
1354	The callback will be receive C<EV_STAT> when a change was detected,	1675	The callback will be receive C<EV_STAT> when a change was detected,
1355	relative to the attributes at the time the watcher was started (or the	1676	relative to the attributes at the time the watcher was started (or the
1356	last change was detected).	1677	last change was detected).
1357		1678
1358	=item ev_stat_stat (ev_stat *)	1679	=item ev_stat_stat (loop, ev_stat *)
1359		1680
1360	Updates the stat buffer immediately with new values. If you change the	1681	Updates the stat buffer immediately with new values. If you change the
1361	watched path in your callback, you could call this fucntion to avoid	1682	watched path in your callback, you could call this fucntion to avoid
1362	detecting this change (while introducing a race condition). Can also be	1683	detecting this change (while introducing a race condition). Can also be
1363	useful simply to find out the new values.	1684	useful simply to find out the new values.
…		…
1381	=item const char *path [read-only]	1702	=item const char *path [read-only]
1382		1703
1383	The filesystem path that is being watched.	1704	The filesystem path that is being watched.
1384		1705
1385	=back	1706	=back
		1707
		1708	=head3 Examples
1386		1709
1387	Example: Watch C</etc/passwd> for attribute changes.	1710	Example: Watch C</etc/passwd> for attribute changes.
1388		1711
1389	static void	1712	static void
1390	passwd_cb (struct ev_loop *loop, ev_stat *w, int revents)	1713	passwd_cb (struct ev_loop *loop, ev_stat *w, int revents)
…		…
1403	}	1726	}
1404		1727
1405	...	1728	...
1406	ev_stat passwd;	1729	ev_stat passwd;
1407		1730
1408	ev_stat_init (&passwd, passwd_cb, "/etc/passwd");	1731	ev_stat_init (&passwd, passwd_cb, "/etc/passwd", 0.);
1409	ev_stat_start (loop, &passwd);	1732	ev_stat_start (loop, &passwd);
		1733
		1734	Example: Like above, but additionally use a one-second delay so we do not
		1735	miss updates (however, frequent updates will delay processing, too, so
		1736	one might do the work both on C<ev_stat> callback invocation I<and> on
		1737	C<ev_timer> callback invocation).
		1738
		1739	static ev_stat passwd;
		1740	static ev_timer timer;
		1741
		1742	static void
		1743	timer_cb (EV_P_ ev_timer *w, int revents)
		1744	{
		1745	ev_timer_stop (EV_A_ w);
		1746
		1747	/* now it's one second after the most recent passwd change */
		1748	}
		1749
		1750	static void
		1751	stat_cb (EV_P_ ev_stat *w, int revents)
		1752	{
		1753	/* reset the one-second timer */
		1754	ev_timer_again (EV_A_ &timer);
		1755	}
		1756
		1757	...
		1758	ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.);
		1759	ev_stat_start (loop, &passwd);
		1760	ev_timer_init (&timer, timer_cb, 0., 1.01);
1410		1761
1411		1762
1412	=head2 C<ev_idle> - when you've got nothing better to do...	1763	=head2 C<ev_idle> - when you've got nothing better to do...
1413		1764
1414	Idle watchers trigger events when no other events of the same or higher	1765	Idle watchers trigger events when no other events of the same or higher
…		…
1428	Apart from keeping your process non-blocking (which is a useful	1779	Apart from keeping your process non-blocking (which is a useful
1429	effect on its own sometimes), idle watchers are a good place to do	1780	effect on its own sometimes), idle watchers are a good place to do
1430	"pseudo-background processing", or delay processing stuff to after the	1781	"pseudo-background processing", or delay processing stuff to after the
1431	event loop has handled all outstanding events.	1782	event loop has handled all outstanding events.
1432		1783
		1784	=head3 Watcher-Specific Functions and Data Members
		1785
1433	=over 4	1786	=over 4
1434		1787
1435	=item ev_idle_init (ev_signal *, callback)	1788	=item ev_idle_init (ev_signal *, callback)
1436		1789
1437	Initialises and configures the idle watcher - it has no parameters of any	1790	Initialises and configures the idle watcher - it has no parameters of any
1438	kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,	1791	kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,
1439	believe me.	1792	believe me.
1440		1793
1441	=back	1794	=back
		1795
		1796	=head3 Examples
1442		1797
1443	Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the	1798	Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the
1444	callback, free it. Also, use no error checking, as usual.	1799	callback, free it. Also, use no error checking, as usual.
1445		1800
1446	static void	1801	static void
1447	idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents)	1802	idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents)
1448	{	1803	{
1449	free (w);	1804	free (w);
1450	// now do something you wanted to do when the program has	1805	// now do something you wanted to do when the program has
1451	// no longer asnything immediate to do.	1806	// no longer anything immediate to do.
1452	}	1807	}
1453		1808
1454	struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle));	1809	struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle));
1455	ev_idle_init (idle_watcher, idle_cb);	1810	ev_idle_init (idle_watcher, idle_cb);
1456	ev_idle_start (loop, idle_cb);	1811	ev_idle_start (loop, idle_cb);
…		…
1498		1853
1499	It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>)	1854	It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>)
1500	priority, to ensure that they are being run before any other watchers	1855	priority, to ensure that they are being run before any other watchers
1501	after the poll. Also, C<ev_check> watchers (and C<ev_prepare> watchers,	1856	after the poll. Also, C<ev_check> watchers (and C<ev_prepare> watchers,
1502	too) should not activate ("feed") events into libev. While libev fully	1857	too) should not activate ("feed") events into libev. While libev fully
1503	supports this, they will be called before other C<ev_check> watchers did	1858	supports this, they will be called before other C<ev_check> watchers
1504	their job. As C<ev_check> watchers are often used to embed other event	1859	did their job. As C<ev_check> watchers are often used to embed other
1505	loops those other event loops might be in an unusable state until their	1860	(non-libev) event loops those other event loops might be in an unusable
1506	C<ev_check> watcher ran (always remind yourself to coexist peacefully with	1861	state until their C<ev_check> watcher ran (always remind yourself to
1507	others).	1862	coexist peacefully with others).
		1863
		1864	=head3 Watcher-Specific Functions and Data Members
1508		1865
1509	=over 4	1866	=over 4
1510		1867
1511	=item ev_prepare_init (ev_prepare *, callback)	1868	=item ev_prepare_init (ev_prepare *, callback)
1512		1869
…		…
1515	Initialises and configures the prepare or check watcher - they have no	1872	Initialises and configures the prepare or check watcher - they have no
1516	parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>	1873	parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>
1517	macros, but using them is utterly, utterly and completely pointless.	1874	macros, but using them is utterly, utterly and completely pointless.
1518		1875
1519	=back	1876	=back
		1877
		1878	=head3 Examples
1520		1879
1521	There are a number of principal ways to embed other event loops or modules	1880	There are a number of principal ways to embed other event loops or modules
1522	into libev. Here are some ideas on how to include libadns into libev	1881	into libev. Here are some ideas on how to include libadns into libev
1523	(there is a Perl module named C<EV::ADNS> that does this, which you could	1882	(there is a Perl module named C<EV::ADNS> that does this, which you could
1524	use for an actually working example. Another Perl module named C<EV::Glib>	1883	use for an actually working example. Another Perl module named C<EV::Glib>
…		…
1693	portable one.	2052	portable one.
1694		2053
1695	So when you want to use this feature you will always have to be prepared	2054	So when you want to use this feature you will always have to be prepared
1696	that you cannot get an embeddable loop. The recommended way to get around	2055	that you cannot get an embeddable loop. The recommended way to get around
1697	this is to have a separate variables for your embeddable loop, try to	2056	this is to have a separate variables for your embeddable loop, try to
1698	create it, and if that fails, use the normal loop for everything:	2057	create it, and if that fails, use the normal loop for everything.
		2058
		2059	=head3 Watcher-Specific Functions and Data Members
		2060
		2061	=over 4
		2062
		2063	=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)
		2064
		2065	=item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)
		2066
		2067	Configures the watcher to embed the given loop, which must be
		2068	embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be
		2069	invoked automatically, otherwise it is the responsibility of the callback
		2070	to invoke it (it will continue to be called until the sweep has been done,
		2071	if you do not want thta, you need to temporarily stop the embed watcher).
		2072
		2073	=item ev_embed_sweep (loop, ev_embed *)
		2074
		2075	Make a single, non-blocking sweep over the embedded loop. This works
		2076	similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most
		2077	apropriate way for embedded loops.
		2078
		2079	=item struct ev_loop *other [read-only]
		2080
		2081	The embedded event loop.
		2082
		2083	=back
		2084
		2085	=head3 Examples
		2086
		2087	Example: Try to get an embeddable event loop and embed it into the default
		2088	event loop. If that is not possible, use the default loop. The default
		2089	loop is stored in C<loop_hi>, while the mebeddable loop is stored in
		2090	C<loop_lo> (which is C<loop_hi> in the acse no embeddable loop can be
		2091	used).
1699		2092
1700	struct ev_loop *loop_hi = ev_default_init (0);	2093	struct ev_loop *loop_hi = ev_default_init (0);
1701	struct ev_loop *loop_lo = 0;	2094	struct ev_loop *loop_lo = 0;
1702	struct ev_embed embed;	2095	struct ev_embed embed;
1703		2096
…		…
1714	ev_embed_start (loop_hi, &embed);	2107	ev_embed_start (loop_hi, &embed);
1715	}	2108	}
1716	else	2109	else
1717	loop_lo = loop_hi;	2110	loop_lo = loop_hi;
1718		2111
1719	=over 4	2112	Example: Check if kqueue is available but not recommended and create
		2113	a kqueue backend for use with sockets (which usually work with any
		2114	kqueue implementation). Store the kqueue/socket-only event loop in
		2115	C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).
1720		2116
1721	=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)	2117	struct ev_loop *loop = ev_default_init (0);
		2118	struct ev_loop *loop_socket = 0;
		2119	struct ev_embed embed;
		2120
		2121	if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
		2122	if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
		2123	{
		2124	ev_embed_init (&embed, 0, loop_socket);
		2125	ev_embed_start (loop, &embed);
		2126	}
1722		2127
1723	=item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)	2128	if (!loop_socket)
		2129	loop_socket = loop;
1724		2130
1725	Configures the watcher to embed the given loop, which must be	2131	// now use loop_socket for all sockets, and loop for everything else
1726	embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be
1727	invoked automatically, otherwise it is the responsibility of the callback
1728	to invoke it (it will continue to be called until the sweep has been done,
1729	if you do not want thta, you need to temporarily stop the embed watcher).
1730
1731	=item ev_embed_sweep (loop, ev_embed *)
1732
1733	Make a single, non-blocking sweep over the embedded loop. This works
1734	similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most
1735	apropriate way for embedded loops.
1736
1737	=item struct ev_loop *loop [read-only]
1738
1739	The embedded event loop.
1740
1741	=back
1742		2132
1743		2133
1744	=head2 C<ev_fork> - the audacity to resume the event loop after a fork	2134	=head2 C<ev_fork> - the audacity to resume the event loop after a fork
1745		2135
1746	Fork watchers are called when a C<fork ()> was detected (usually because	2136	Fork watchers are called when a C<fork ()> was detected (usually because
…		…
1749	event loop blocks next and before C<ev_check> watchers are being called,	2139	event loop blocks next and before C<ev_check> watchers are being called,
1750	and only in the child after the fork. If whoever good citizen calling	2140	and only in the child after the fork. If whoever good citizen calling
1751	C<ev_default_fork> cheats and calls it in the wrong process, the fork	2141	C<ev_default_fork> cheats and calls it in the wrong process, the fork
1752	handlers will be invoked, too, of course.	2142	handlers will be invoked, too, of course.
1753		2143
		2144	=head3 Watcher-Specific Functions and Data Members
		2145
1754	=over 4	2146	=over 4
1755		2147
1756	=item ev_fork_init (ev_signal *, callback)	2148	=item ev_fork_init (ev_signal *, callback)
1757		2149
1758	Initialises and configures the fork watcher - it has no parameters of any	2150	Initialises and configures the fork watcher - it has no parameters of any
1759	kind. There is a C<ev_fork_set> macro, but using it is utterly pointless,	2151	kind. There is a C<ev_fork_set> macro, but using it is utterly pointless,
1760	believe me.	2152	believe me.
		2153
		2154	=back
		2155
		2156
		2157	=head2 C<ev_async> - how to wake up another event loop
		2158
		2159	In general, you cannot use an C<ev_loop> from multiple threads or other
		2160	asynchronous sources such as signal handlers (as opposed to multiple event
		2161	loops - those are of course safe to use in different threads).
		2162
		2163	Sometimes, however, you need to wake up another event loop you do not
		2164	control, for example because it belongs to another thread. This is what
		2165	C<ev_async> watchers do: as long as the C<ev_async> watcher is active, you
		2166	can signal it by calling C<ev_async_send>, which is thread- and signal
		2167	safe.
		2168
		2169	This functionality is very similar to C<ev_signal> watchers, as signals,
		2170	too, are asynchronous in nature, and signals, too, will be compressed
		2171	(i.e. the number of callback invocations may be less than the number of
		2172	C<ev_async_sent> calls).
		2173
		2174	Unlike C<ev_signal> watchers, C<ev_async> works with any event loop, not
		2175	just the default loop.
		2176
		2177	=head3 Queueing
		2178
		2179	C<ev_async> does not support queueing of data in any way. The reason
		2180	is that the author does not know of a simple (or any) algorithm for a
		2181	multiple-writer-single-reader queue that works in all cases and doesn't
		2182	need elaborate support such as pthreads.
		2183
		2184	That means that if you want to queue data, you have to provide your own
		2185	queue. But at least I can tell you would implement locking around your
		2186	queue:
		2187
		2188	=over 4
		2189
		2190	=item queueing from a signal handler context
		2191
		2192	To implement race-free queueing, you simply add to the queue in the signal
		2193	handler but you block the signal handler in the watcher callback. Here is an example that does that for
		2194	some fictitiuous SIGUSR1 handler:
		2195
		2196	static ev_async mysig;
		2197
		2198	static void
		2199	sigusr1_handler (void)
		2200	{
		2201	sometype data;
		2202
		2203	// no locking etc.
		2204	queue_put (data);
		2205	ev_async_send (EV_DEFAULT_ &mysig);
		2206	}
		2207
		2208	static void
		2209	mysig_cb (EV_P_ ev_async *w, int revents)
		2210	{
		2211	sometype data;
		2212	sigset_t block, prev;
		2213
		2214	sigemptyset (&block);
		2215	sigaddset (&block, SIGUSR1);
		2216	sigprocmask (SIG_BLOCK, &block, &prev);
		2217
		2218	while (queue_get (&data))
		2219	process (data);
		2220
		2221	if (sigismember (&prev, SIGUSR1)
		2222	sigprocmask (SIG_UNBLOCK, &block, 0);
		2223	}
		2224
		2225	(Note: pthreads in theory requires you to use C<pthread_setmask>
		2226	instead of C<sigprocmask> when you use threads, but libev doesn't do it
		2227	either...).
		2228
		2229	=item queueing from a thread context
		2230
		2231	The strategy for threads is different, as you cannot (easily) block
		2232	threads but you can easily preempt them, so to queue safely you need to
		2233	employ a traditional mutex lock, such as in this pthread example:
		2234
		2235	static ev_async mysig;
		2236	static pthread_mutex_t mymutex = PTHREAD_MUTEX_INITIALIZER;
		2237
		2238	static void
		2239	otherthread (void)
		2240	{
		2241	// only need to lock the actual queueing operation
		2242	pthread_mutex_lock (&mymutex);
		2243	queue_put (data);
		2244	pthread_mutex_unlock (&mymutex);
		2245
		2246	ev_async_send (EV_DEFAULT_ &mysig);
		2247	}
		2248
		2249	static void
		2250	mysig_cb (EV_P_ ev_async *w, int revents)
		2251	{
		2252	pthread_mutex_lock (&mymutex);
		2253
		2254	while (queue_get (&data))
		2255	process (data);
		2256
		2257	pthread_mutex_unlock (&mymutex);
		2258	}
		2259
		2260	=back
		2261
		2262
		2263	=head3 Watcher-Specific Functions and Data Members
		2264
		2265	=over 4
		2266
		2267	=item ev_async_init (ev_async *, callback)
		2268
		2269	Initialises and configures the async watcher - it has no parameters of any
		2270	kind. There is a C<ev_asynd_set> macro, but using it is utterly pointless,
		2271	believe me.
		2272
		2273	=item ev_async_send (loop, ev_async *)
		2274
		2275	Sends/signals/activates the given C<ev_async> watcher, that is, feeds
		2276	an C<EV_ASYNC> event on the watcher into the event loop. Unlike
		2277	C<ev_feed_event>, this call is safe to do in other threads, signal or
		2278	similar contexts (see the dicusssion of C<EV_ATOMIC_T> in the embedding
		2279	section below on what exactly this means).
		2280
		2281	This call incurs the overhead of a syscall only once per loop iteration,
		2282	so while the overhead might be noticable, it doesn't apply to repeated
		2283	calls to C<ev_async_send>.
1761		2284
1762	=back	2285	=back
1763		2286
1764		2287
1765	=head1 OTHER FUNCTIONS	2288	=head1 OTHER FUNCTIONS
…		…
1974		2497
1975	=item w->stop ()	2498	=item w->stop ()
1976		2499
1977	Stops the watcher if it is active. Again, no C<loop> argument.	2500	Stops the watcher if it is active. Again, no C<loop> argument.
1978		2501
1979	=item w->again () C<ev::timer>, C<ev::periodic> only	2502	=item w->again () (C<ev::timer>, C<ev::periodic> only)
1980		2503
1981	For C<ev::timer> and C<ev::periodic>, this invokes the corresponding	2504	For C<ev::timer> and C<ev::periodic>, this invokes the corresponding
1982	C<ev_TYPE_again> function.	2505	C<ev_TYPE_again> function.
1983		2506
1984	=item w->sweep () C<ev::embed> only	2507	=item w->sweep () (C<ev::embed> only)
1985		2508
1986	Invokes C<ev_embed_sweep>.	2509	Invokes C<ev_embed_sweep>.
1987		2510
1988	=item w->update () C<ev::stat> only	2511	=item w->update () (C<ev::stat> only)
1989		2512
1990	Invokes C<ev_stat_stat>.	2513	Invokes C<ev_stat_stat>.
1991		2514
1992	=back	2515	=back
1993		2516
…		…
1996	Example: Define a class with an IO and idle watcher, start one of them in	2519	Example: Define a class with an IO and idle watcher, start one of them in
1997	the constructor.	2520	the constructor.
1998		2521
1999	class myclass	2522	class myclass
2000	{	2523	{
2001	ev_io io; void io_cb (ev::io &w, int revents);	2524	ev::io io; void io_cb (ev::io &w, int revents);
2002	ev_idle idle void idle_cb (ev::idle &w, int revents);	2525	ev:idle idle void idle_cb (ev::idle &w, int revents);
2003		2526
2004	myclass ();	2527	myclass (int fd)
2005	}
2006
2007	myclass::myclass (int fd)
2008	{	2528	{
2009	io .set <myclass, &myclass::io_cb > (this);	2529	io .set <myclass, &myclass::io_cb > (this);
2010	idle.set <myclass, &myclass::idle_cb> (this);	2530	idle.set <myclass, &myclass::idle_cb> (this);
2011		2531
2012	io.start (fd, ev::READ);	2532	io.start (fd, ev::READ);
		2533	}
2013	}	2534	};
		2535
		2536
		2537	=head1 OTHER LANGUAGE BINDINGS
		2538
		2539	Libev does not offer other language bindings itself, but bindings for a
		2540	numbe rof languages exist in the form of third-party packages. If you know
		2541	any interesting language binding in addition to the ones listed here, drop
		2542	me a note.
		2543
		2544	=over 4
		2545
		2546	=item Perl
		2547
		2548	The EV module implements the full libev API and is actually used to test
		2549	libev. EV is developed together with libev. Apart from the EV core module,
		2550	there are additional modules that implement libev-compatible interfaces
		2551	to C<libadns> (C<EV::ADNS>), C<Net::SNMP> (C<Net::SNMP::EV>) and the
		2552	C<libglib> event core (C<Glib::EV> and C<EV::Glib>).
		2553
		2554	It can be found and installed via CPAN, its homepage is found at
		2555	L<http://software.schmorp.de/pkg/EV>.
		2556
		2557	=item Ruby
		2558
		2559	Tony Arcieri has written a ruby extension that offers access to a subset
		2560	of the libev API and adds filehandle abstractions, asynchronous DNS and
		2561	more on top of it. It can be found via gem servers. Its homepage is at
		2562	L<http://rev.rubyforge.org/>.
		2563
		2564	=item D
		2565
		2566	Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to
		2567	be found at L<http://git.llucax.com.ar/?p=software/ev.d.git;a=summary>.
		2568
		2569	=back
2014		2570
2015		2571
2016	=head1 MACRO MAGIC	2572	=head1 MACRO MAGIC
2017		2573
2018	Libev can be compiled with a variety of options, the most fundemantal is	2574	Libev can be compiled with a variety of options, the most fundamantal
2019	C<EV_MULTIPLICITY>. This option determines whether (most) functions and	2575	of which is C<EV_MULTIPLICITY>. This option determines whether (most)
2020	callbacks have an initial C<struct ev_loop *> argument.	2576	functions and callbacks have an initial C<struct ev_loop *> argument.
2021		2577
2022	To make it easier to write programs that cope with either variant, the	2578	To make it easier to write programs that cope with either variant, the
2023	following macros are defined:	2579	following macros are defined:
2024		2580
2025	=over 4	2581	=over 4
…		…
2079	Libev can (and often is) directly embedded into host	2635	Libev can (and often is) directly embedded into host
2080	applications. Examples of applications that embed it include the Deliantra	2636	applications. Examples of applications that embed it include the Deliantra
2081	Game Server, the EV perl module, the GNU Virtual Private Ethernet (gvpe)	2637	Game Server, the EV perl module, the GNU Virtual Private Ethernet (gvpe)
2082	and rxvt-unicode.	2638	and rxvt-unicode.
2083		2639
2084	The goal is to enable you to just copy the neecssary files into your	2640	The goal is to enable you to just copy the necessary files into your
2085	source directory without having to change even a single line in them, so	2641	source directory without having to change even a single line in them, so
2086	you can easily upgrade by simply copying (or having a checked-out copy of	2642	you can easily upgrade by simply copying (or having a checked-out copy of
2087	libev somewhere in your source tree).	2643	libev somewhere in your source tree).
2088		2644
2089	=head2 FILESETS	2645	=head2 FILESETS
…		…
2179		2735
2180	If defined to be C<1>, libev will try to detect the availability of the	2736	If defined to be C<1>, libev will try to detect the availability of the
2181	monotonic clock option at both compiletime and runtime. Otherwise no use	2737	monotonic clock option at both compiletime and runtime. Otherwise no use
2182	of the monotonic clock option will be attempted. If you enable this, you	2738	of the monotonic clock option will be attempted. If you enable this, you
2183	usually have to link against librt or something similar. Enabling it when	2739	usually have to link against librt or something similar. Enabling it when
2184	the functionality isn't available is safe, though, althoguh you have	2740	the functionality isn't available is safe, though, although you have
2185	to make sure you link against any libraries where the C<clock_gettime>	2741	to make sure you link against any libraries where the C<clock_gettime>
2186	function is hiding in (often F<-lrt>).	2742	function is hiding in (often F<-lrt>).
2187		2743
2188	=item EV_USE_REALTIME	2744	=item EV_USE_REALTIME
2189		2745
2190	If defined to be C<1>, libev will try to detect the availability of the	2746	If defined to be C<1>, libev will try to detect the availability of the
2191	realtime clock option at compiletime (and assume its availability at	2747	realtime clock option at compiletime (and assume its availability at
2192	runtime if successful). Otherwise no use of the realtime clock option will	2748	runtime if successful). Otherwise no use of the realtime clock option will
2193	be attempted. This effectively replaces C<gettimeofday> by C<clock_get	2749	be attempted. This effectively replaces C<gettimeofday> by C<clock_get
2194	(CLOCK_REALTIME, ...)> and will not normally affect correctness. See tzhe note about libraries	2750	(CLOCK_REALTIME, ...)> and will not normally affect correctness. See the
2195	in the description of C<EV_USE_MONOTONIC>, though.	2751	note about libraries in the description of C<EV_USE_MONOTONIC>, though.
		2752
		2753	=item EV_USE_NANOSLEEP
		2754
		2755	If defined to be C<1>, libev will assume that C<nanosleep ()> is available
		2756	and will use it for delays. Otherwise it will use C<select ()>.
2196		2757
2197	=item EV_USE_SELECT	2758	=item EV_USE_SELECT
2198		2759
2199	If undefined or defined to be C<1>, libev will compile in support for the	2760	If undefined or defined to be C<1>, libev will compile in support for the
2200	C<select>(2) backend. No attempt at autodetection will be done: if no	2761	C<select>(2) backend. No attempt at autodetection will be done: if no
…		…
2218	wants osf handles on win32 (this is the case when the select to	2779	wants osf handles on win32 (this is the case when the select to
2219	be used is the winsock select). This means that it will call	2780	be used is the winsock select). This means that it will call
2220	C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise,	2781	C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise,
2221	it is assumed that all these functions actually work on fds, even	2782	it is assumed that all these functions actually work on fds, even
2222	on win32. Should not be defined on non-win32 platforms.	2783	on win32. Should not be defined on non-win32 platforms.
		2784
		2785	=item EV_FD_TO_WIN32_HANDLE
		2786
		2787	If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map
		2788	file descriptors to socket handles. When not defining this symbol (the
		2789	default), then libev will call C<_get_osfhandle>, which is usually
		2790	correct. In some cases, programs use their own file descriptor management,
		2791	in which case they can provide this function to map fds to socket handles.
2223		2792
2224	=item EV_USE_POLL	2793	=item EV_USE_POLL
2225		2794
2226	If defined to be C<1>, libev will compile in support for the C<poll>(2)	2795	If defined to be C<1>, libev will compile in support for the C<poll>(2)
2227	backend. Otherwise it will be enabled on non-win32 platforms. It	2796	backend. Otherwise it will be enabled on non-win32 platforms. It
…		…
2261		2830
2262	If defined to be C<1>, libev will compile in support for the Linux inotify	2831	If defined to be C<1>, libev will compile in support for the Linux inotify
2263	interface to speed up C<ev_stat> watchers. Its actual availability will	2832	interface to speed up C<ev_stat> watchers. Its actual availability will
2264	be detected at runtime.	2833	be detected at runtime.
2265		2834
		2835	=item EV_ATOMIC_T
		2836
		2837	Libev requires an integer type (suitable for storing C<0> or C<1>) whose
		2838	access is atomic with respect to other threads or signal contexts. No such
		2839	type is easily found in the C language, so you can provide your own type
		2840	that you know is safe for your purposes. It is used both for signal handler "locking"
		2841	as well as for signal and thread safety in C<ev_async> watchers.
		2842
		2843	In the absense of this define, libev will use C<sig_atomic_t volatile>
		2844	(from F<signal.h>), which is usually good enough on most platforms.
		2845
2266	=item EV_H	2846	=item EV_H
2267		2847
2268	The name of the F<ev.h> header file used to include it. The default if	2848	The name of the F<ev.h> header file used to include it. The default if
2269	undefined is C<< <ev.h> >> in F<event.h> and C<"ev.h"> in F<ev.c>. This	2849	undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be
2270	can be used to virtually rename the F<ev.h> header file in case of conflicts.	2850	used to virtually rename the F<ev.h> header file in case of conflicts.
2271		2851
2272	=item EV_CONFIG_H	2852	=item EV_CONFIG_H
2273		2853
2274	If C<EV_STANDALONE> isn't C<1>, this variable can be used to override	2854	If C<EV_STANDALONE> isn't C<1>, this variable can be used to override
2275	F<ev.c>'s idea of where to find the F<config.h> file, similarly to	2855	F<ev.c>'s idea of where to find the F<config.h> file, similarly to
2276	C<EV_H>, above.	2856	C<EV_H>, above.
2277		2857
2278	=item EV_EVENT_H	2858	=item EV_EVENT_H
2279		2859
2280	Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea	2860	Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea
2281	of how the F<event.h> header can be found.	2861	of how the F<event.h> header can be found, the default is C<"event.h">.
2282		2862
2283	=item EV_PROTOTYPES	2863	=item EV_PROTOTYPES
2284		2864
2285	If defined to be C<0>, then F<ev.h> will not define any function	2865	If defined to be C<0>, then F<ev.h> will not define any function
2286	prototypes, but still define all the structs and other symbols. This is	2866	prototypes, but still define all the structs and other symbols. This is
…		…
2337	=item EV_FORK_ENABLE	2917	=item EV_FORK_ENABLE
2338		2918
2339	If undefined or defined to be C<1>, then fork watchers are supported. If	2919	If undefined or defined to be C<1>, then fork watchers are supported. If
2340	defined to be C<0>, then they are not.	2920	defined to be C<0>, then they are not.
2341		2921
		2922	=item EV_ASYNC_ENABLE
		2923
		2924	If undefined or defined to be C<1>, then async watchers are supported. If
		2925	defined to be C<0>, then they are not.
		2926
2342	=item EV_MINIMAL	2927	=item EV_MINIMAL
2343		2928
2344	If you need to shave off some kilobytes of code at the expense of some	2929	If you need to shave off some kilobytes of code at the expense of some
2345	speed, define this symbol to C<1>. Currently only used for gcc to override	2930	speed, define this symbol to C<1>. Currently only used for gcc to override
2346	some inlining decisions, saves roughly 30% codesize of amd64.	2931	some inlining decisions, saves roughly 30% codesize of amd64.
…		…
2352	than enough. If you need to manage thousands of children you might want to	2937	than enough. If you need to manage thousands of children you might want to
2353	increase this value (I<must> be a power of two).	2938	increase this value (I<must> be a power of two).
2354		2939
2355	=item EV_INOTIFY_HASHSIZE	2940	=item EV_INOTIFY_HASHSIZE
2356		2941
2357	C<ev_staz> watchers use a small hash table to distribute workload by	2942	C<ev_stat> watchers use a small hash table to distribute workload by
2358	inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>),	2943	inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>),
2359	usually more than enough. If you need to manage thousands of C<ev_stat>	2944	usually more than enough. If you need to manage thousands of C<ev_stat>
2360	watchers you might want to increase this value (I<must> be a power of	2945	watchers you might want to increase this value (I<must> be a power of
2361	two).	2946	two).
2362		2947
…		…
2379		2964
2380	=item ev_set_cb (ev, cb)	2965	=item ev_set_cb (ev, cb)
2381		2966
2382	Can be used to change the callback member declaration in each watcher,	2967	Can be used to change the callback member declaration in each watcher,
2383	and the way callbacks are invoked and set. Must expand to a struct member	2968	and the way callbacks are invoked and set. Must expand to a struct member
2384	definition and a statement, respectively. See the F<ev.v> header file for	2969	definition and a statement, respectively. See the F<ev.h> header file for
2385	their default definitions. One possible use for overriding these is to	2970	their default definitions. One possible use for overriding these is to
2386	avoid the C<struct ev_loop *> as first argument in all cases, or to use	2971	avoid the C<struct ev_loop *> as first argument in all cases, or to use
2387	method calls instead of plain function calls in C++.	2972	method calls instead of plain function calls in C++.
		2973
		2974	=head2 EXPORTED API SYMBOLS
		2975
		2976	If you need to re-export the API (e.g. via a dll) and you need a list of
		2977	exported symbols, you can use the provided F<Symbol.*> files which list
		2978	all public symbols, one per line:
		2979
		2980	Symbols.ev for libev proper
		2981	Symbols.event for the libevent emulation
		2982
		2983	This can also be used to rename all public symbols to avoid clashes with
		2984	multiple versions of libev linked together (which is obviously bad in
		2985	itself, but sometimes it is inconvinient to avoid this).
		2986
		2987	A sed command like this will create wrapper C<#define>'s that you need to
		2988	include before including F<ev.h>:
		2989
		2990	<Symbols.ev sed -e "s/.*/#define & myprefix_&/" >wrap.h
		2991
		2992	This would create a file F<wrap.h> which essentially looks like this:
		2993
		2994	#define ev_backend myprefix_ev_backend
		2995	#define ev_check_start myprefix_ev_check_start
		2996	#define ev_check_stop myprefix_ev_check_stop
		2997	...
2388		2998
2389	=head2 EXAMPLES	2999	=head2 EXAMPLES
2390		3000
2391	For a real-world example of a program the includes libev	3001	For a real-world example of a program the includes libev
2392	verbatim, you can have a look at the EV perl module	3002	verbatim, you can have a look at the EV perl module
…		…
2433		3043
2434	=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers)	3044	=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers)
2435		3045
2436	This means that, when you have a watcher that triggers in one hour and	3046	This means that, when you have a watcher that triggers in one hour and
2437	there are 100 watchers that would trigger before that then inserting will	3047	there are 100 watchers that would trigger before that then inserting will
2438	have to skip those 100 watchers.	3048	have to skip roughly seven (C<ld 100>) of these watchers.
2439		3049
2440	=item Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)	3050	=item Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)
2441		3051
2442	That means that for changing a timer costs less than removing/adding them	3052	That means that changing a timer costs less than removing/adding them
2443	as only the relative motion in the event queue has to be paid for.	3053	as only the relative motion in the event queue has to be paid for.
2444		3054
2445	=item Starting io/check/prepare/idle/signal/child watchers: O(1)	3055	=item Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1)
2446		3056
2447	These just add the watcher into an array or at the head of a list.	3057	These just add the watcher into an array or at the head of a list.
		3058
2448	=item Stopping check/prepare/idle watchers: O(1)	3059	=item Stopping check/prepare/idle/fork/async watchers: O(1)
2449		3060
2450	=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))	3061	=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))
2451		3062
2452	These watchers are stored in lists then need to be walked to find the	3063	These watchers are stored in lists then need to be walked to find the
2453	correct watcher to remove. The lists are usually short (you don't usually	3064	correct watcher to remove. The lists are usually short (you don't usually
2454	have many watchers waiting for the same fd or signal).	3065	have many watchers waiting for the same fd or signal).
2455		3066
2456	=item Finding the next timer per loop iteration: O(1)	3067	=item Finding the next timer in each loop iteration: O(1)
		3068
		3069	By virtue of using a binary heap, the next timer is always found at the
		3070	beginning of the storage array.
2457		3071
2458	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)	3072	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)
2459		3073
2460	A change means an I/O watcher gets started or stopped, which requires	3074	A change means an I/O watcher gets started or stopped, which requires
2461	libev to recalculate its status (and possibly tell the kernel).	3075	libev to recalculate its status (and possibly tell the kernel, depending
		3076	on backend and wether C<ev_io_set> was used).
2462		3077
2463	=item Activating one watcher: O(1)	3078	=item Activating one watcher (putting it into the pending state): O(1)
2464		3079
2465	=item Priority handling: O(number_of_priorities)	3080	=item Priority handling: O(number_of_priorities)
2466		3081
2467	Priorities are implemented by allocating some space for each	3082	Priorities are implemented by allocating some space for each
2468	priority. When doing priority-based operations, libev usually has to	3083	priority. When doing priority-based operations, libev usually has to
2469	linearly search all the priorities.	3084	linearly search all the priorities, but starting/stopping and activating
		3085	watchers becomes O(1) w.r.t. priority handling.
		3086
		3087	=item Sending an ev_async: O(1)
		3088
		3089	=item Processing ev_async_send: O(number_of_async_watchers)
		3090
		3091	=item Processing signals: O(max_signal_number)
		3092
		3093	Sending involves a syscall I<iff> there were no other C<ev_async_send>
		3094	calls in the current loop iteration. Checking for async and signal events
		3095	involves iterating over all running async watchers or all signal numbers.
2470		3096
2471	=back	3097	=back
2472		3098
2473		3099
		3100	=head1 Win32 platform limitations and workarounds
		3101
		3102	Win32 doesn't support any of the standards (e.g. POSIX) that libev
		3103	requires, and its I/O model is fundamentally incompatible with the POSIX
		3104	model. Libev still offers limited functionality on this platform in
		3105	the form of the C<EVBACKEND_SELECT> backend, and only supports socket
		3106	descriptors. This only applies when using Win32 natively, not when using
		3107	e.g. cygwin.
		3108
		3109	There is no supported compilation method available on windows except
		3110	embedding it into other applications.
		3111
		3112	Due to the many, low, and arbitrary limits on the win32 platform and the
		3113	abysmal performance of winsockets, using a large number of sockets is not
		3114	recommended (and not reasonable). If your program needs to use more than
		3115	a hundred or so sockets, then likely it needs to use a totally different
		3116	implementation for windows, as libev offers the POSIX model, which cannot
		3117	be implemented efficiently on windows (microsoft monopoly games).
		3118
		3119	=over 4
		3120
		3121	=item The winsocket select function
		3122
		3123	The winsocket C<select> function doesn't follow POSIX in that it requires
		3124	socket I<handles> and not socket I<file descriptors>. This makes select
		3125	very inefficient, and also requires a mapping from file descriptors
		3126	to socket handles. See the discussion of the C<EV_SELECT_USE_FD_SET>,
		3127	C<EV_SELECT_IS_WINSOCKET> and C<EV_FD_TO_WIN32_HANDLE> preprocessor
		3128	symbols for more info.
		3129
		3130	The configuration for a "naked" win32 using the microsoft runtime
		3131	libraries and raw winsocket select is:
		3132
		3133	#define EV_USE_SELECT 1
		3134	#define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */
		3135
		3136	Note that winsockets handling of fd sets is O(n), so you can easily get a
		3137	complexity in the O(n²) range when using win32.
		3138
		3139	=item Limited number of file descriptors
		3140
		3141	Windows has numerous arbitrary (and low) limits on things. Early versions
		3142	of winsocket's select only supported waiting for a max. of C<64> handles
		3143	(probably owning to the fact that all windows kernels can only wait for
		3144	C<64> things at the same time internally; microsoft recommends spawning a
		3145	chain of threads and wait for 63 handles and the previous thread in each).
		3146
		3147	Newer versions support more handles, but you need to define C<FD_SETSIZE>
		3148	to some high number (e.g. C<2048>) before compiling the winsocket select
		3149	call (which might be in libev or elsewhere, for example, perl does its own
		3150	select emulation on windows).
		3151
		3152	Another limit is the number of file descriptors in the microsoft runtime
		3153	libraries, which by default is C<64> (there must be a hidden I<64> fetish
		3154	or something like this inside microsoft). You can increase this by calling
		3155	C<_setmaxstdio>, which can increase this limit to C<2048> (another
		3156	arbitrary limit), but is broken in many versions of the microsoft runtime
		3157	libraries.
		3158
		3159	This might get you to about C<512> or C<2048> sockets (depending on
		3160	windows version and/or the phase of the moon). To get more, you need to
		3161	wrap all I/O functions and provide your own fd management, but the cost of
		3162	calling select (O(n²)) will likely make this unworkable.
		3163
		3164	=back
		3165
		3166
2474	=head1 AUTHOR	3167	=head1 AUTHOR
2475		3168
2476	Marc Lehmann <libev@schmorp.de>.	3169	Marc Lehmann <libev@schmorp.de>.
2477		3170

Diff Legend

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