ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.256 by root, Tue Jul 14 20:31:21 2009 UTC vs.
Revision 1.431 by root, Fri Nov 22 16:42:10 2013 UTC

		1	=encoding utf-8
		2
1	=head1 NAME	3	=head1 NAME
2		4
3	libev - a high performance full-featured event loop written in C	5	libev - a high performance full-featured event loop written in C
4		6
5	=head1 SYNOPSIS	7	=head1 SYNOPSIS
…		…
26	puts ("stdin ready");	28	puts ("stdin ready");
27	// for one-shot events, one must manually stop the watcher	29	// for one-shot events, one must manually stop the watcher
28	// with its corresponding stop function.	30	// with its corresponding stop function.
29	ev_io_stop (EV_A_ w);	31	ev_io_stop (EV_A_ w);
30		32
31	// this causes all nested ev_loop's to stop iterating	33	// this causes all nested ev_run's to stop iterating
32	ev_unloop (EV_A_ EVUNLOOP_ALL);	34	ev_break (EV_A_ EVBREAK_ALL);
33	}	35	}
34		36
35	// another callback, this time for a time-out	37	// another callback, this time for a time-out
36	static void	38	static void
37	timeout_cb (EV_P_ ev_timer *w, int revents)	39	timeout_cb (EV_P_ ev_timer *w, int revents)
38	{	40	{
39	puts ("timeout");	41	puts ("timeout");
40	// this causes the innermost ev_loop to stop iterating	42	// this causes the innermost ev_run to stop iterating
41	ev_unloop (EV_A_ EVUNLOOP_ONE);	43	ev_break (EV_A_ EVBREAK_ONE);
42	}	44	}
43		45
44	int	46	int
45	main (void)	47	main (void)
46	{	48	{
47	// use the default event loop unless you have special needs	49	// use the default event loop unless you have special needs
48	struct ev_loop *loop = ev_default_loop (0);	50	struct ev_loop *loop = EV_DEFAULT;
49		51
50	// initialise an io watcher, then start it	52	// initialise an io watcher, then start it
51	// this one will watch for stdin to become readable	53	// this one will watch for stdin to become readable
52	ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);	54	ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);
53	ev_io_start (loop, &stdin_watcher);	55	ev_io_start (loop, &stdin_watcher);
…		…
56	// simple non-repeating 5.5 second timeout	58	// simple non-repeating 5.5 second timeout
57	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);	59	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
58	ev_timer_start (loop, &timeout_watcher);	60	ev_timer_start (loop, &timeout_watcher);
59		61
60	// now wait for events to arrive	62	// now wait for events to arrive
61	ev_loop (loop, 0);	63	ev_run (loop, 0);
62		64
63	// unloop was called, so exit	65	// break was called, so exit
64	return 0;	66	return 0;
65	}	67	}
66		68
67	=head1 ABOUT THIS DOCUMENT	69	=head1 ABOUT THIS DOCUMENT
68		70
…		…
75	While this document tries to be as complete as possible in documenting	77	While this document tries to be as complete as possible in documenting
76	libev, its usage and the rationale behind its design, it is not a tutorial	78	libev, its usage and the rationale behind its design, it is not a tutorial
77	on event-based programming, nor will it introduce event-based programming	79	on event-based programming, nor will it introduce event-based programming
78	with libev.	80	with libev.
79		81
80	Familarity with event based programming techniques in general is assumed	82	Familiarity with event based programming techniques in general is assumed
81	throughout this document.	83	throughout this document.
		84
		85	=head1 WHAT TO READ WHEN IN A HURRY
		86
		87	This manual tries to be very detailed, but unfortunately, this also makes
		88	it very long. If you just want to know the basics of libev, I suggest
		89	reading L</ANATOMY OF A WATCHER>, then the L</EXAMPLE PROGRAM> above and
		90	look up the missing functions in L</GLOBAL FUNCTIONS> and the C<ev_io> and
		91	C<ev_timer> sections in L</WATCHER TYPES>.
82		92
83	=head1 ABOUT LIBEV	93	=head1 ABOUT LIBEV
84		94
85	Libev is an event loop: you register interest in certain events (such as a	95	Libev is an event loop: you register interest in certain events (such as a
86	file descriptor being readable or a timeout occurring), and it will manage	96	file descriptor being readable or a timeout occurring), and it will manage
…		…
98	=head2 FEATURES	108	=head2 FEATURES
99		109
100	Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the	110	Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the
101	BSD-specific C<kqueue> and the Solaris-specific event port mechanisms	111	BSD-specific C<kqueue> and the Solaris-specific event port mechanisms
102	for file descriptor events (C<ev_io>), the Linux C<inotify> interface	112	for file descriptor events (C<ev_io>), the Linux C<inotify> interface
103	(for C<ev_stat>), relative timers (C<ev_timer>), absolute timers	113	(for C<ev_stat>), Linux eventfd/signalfd (for faster and cleaner
104	with customised rescheduling (C<ev_periodic>), synchronous signals	114	inter-thread wakeup (C<ev_async>)/signal handling (C<ev_signal>)) relative
105	(C<ev_signal>), process status change events (C<ev_child>), and event	115	timers (C<ev_timer>), absolute timers with customised rescheduling
106	watchers dealing with the event loop mechanism itself (C<ev_idle>,	116	(C<ev_periodic>), synchronous signals (C<ev_signal>), process status
107	C<ev_embed>, C<ev_prepare> and C<ev_check> watchers) as well as	117	change events (C<ev_child>), and event watchers dealing with the event
108	file watchers (C<ev_stat>) and even limited support for fork events	118	loop mechanism itself (C<ev_idle>, C<ev_embed>, C<ev_prepare> and
109	(C<ev_fork>).	119	C<ev_check> watchers) as well as file watchers (C<ev_stat>) and even
		120	limited support for fork events (C<ev_fork>).
110		121
111	It also is quite fast (see this	122	It also is quite fast (see this
112	L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent	123	L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent
113	for example).	124	for example).
114		125
…		…
117	Libev is very configurable. In this manual the default (and most common)	128	Libev is very configurable. In this manual the default (and most common)
118	configuration will be described, which supports multiple event loops. For	129	configuration will be described, which supports multiple event loops. For
119	more info about various configuration options please have a look at	130	more info about various configuration options please have a look at
120	B<EMBED> section in this manual. If libev was configured without support	131	B<EMBED> section in this manual. If libev was configured without support
121	for multiple event loops, then all functions taking an initial argument of	132	for multiple event loops, then all functions taking an initial argument of
122	name C<loop> (which is always of type C<ev_loop *>) will not have	133	name C<loop> (which is always of type C<struct ev_loop *>) will not have
123	this argument.	134	this argument.
124		135
125	=head2 TIME REPRESENTATION	136	=head2 TIME REPRESENTATION
126		137
127	Libev represents time as a single floating point number, representing	138	Libev represents time as a single floating point number, representing
128	the (fractional) number of seconds since the (POSIX) epoch (somewhere	139	the (fractional) number of seconds since the (POSIX) epoch (in practice
129	near the beginning of 1970, details are complicated, don't ask). This	140	somewhere near the beginning of 1970, details are complicated, don't
130	type is called C<ev_tstamp>, which is what you should use too. It usually	141	ask). This type is called C<ev_tstamp>, which is what you should use
131	aliases to the C<double> type in C. When you need to do any calculations	142	too. It usually aliases to the C<double> type in C. When you need to do
132	on it, you should treat it as some floating point value. Unlike the name	143	any calculations on it, you should treat it as some floating point value.
		144
133	component C<stamp> might indicate, it is also used for time differences	145	Unlike the name component C<stamp> might indicate, it is also used for
134	throughout libev.	146	time differences (e.g. delays) throughout libev.
135		147
136	=head1 ERROR HANDLING	148	=head1 ERROR HANDLING
137		149
138	Libev knows three classes of errors: operating system errors, usage errors	150	Libev knows three classes of errors: operating system errors, usage errors
139	and internal errors (bugs).	151	and internal errors (bugs).
…		…
163		175
164	=item ev_tstamp ev_time ()	176	=item ev_tstamp ev_time ()
165		177
166	Returns the current time as libev would use it. Please note that the	178	Returns the current time as libev would use it. Please note that the
167	C<ev_now> function is usually faster and also often returns the timestamp	179	C<ev_now> function is usually faster and also often returns the timestamp
168	you actually want to know.	180	you actually want to know. Also interesting is the combination of
		181	C<ev_now_update> and C<ev_now>.
169		182
170	=item ev_sleep (ev_tstamp interval)	183	=item ev_sleep (ev_tstamp interval)
171		184
172	Sleep for the given interval: The current thread will be blocked until	185	Sleep for the given interval: The current thread will be blocked
173	either it is interrupted or the given time interval has passed. Basically	186	until either it is interrupted or the given time interval has
		187	passed (approximately - it might return a bit earlier even if not
		188	interrupted). Returns immediately if C<< interval <= 0 >>.
		189
174	this is a sub-second-resolution C<sleep ()>.	190	Basically this is a sub-second-resolution C<sleep ()>.
		191
		192	The range of the C<interval> is limited - libev only guarantees to work
		193	with sleep times of up to one day (C<< interval <= 86400 >>).
175		194
176	=item int ev_version_major ()	195	=item int ev_version_major ()
177		196
178	=item int ev_version_minor ()	197	=item int ev_version_minor ()
179		198
…		…
190	as this indicates an incompatible change. Minor versions are usually	209	as this indicates an incompatible change. Minor versions are usually
191	compatible to older versions, so a larger minor version alone is usually	210	compatible to older versions, so a larger minor version alone is usually
192	not a problem.	211	not a problem.
193		212
194	Example: Make sure we haven't accidentally been linked against the wrong	213	Example: Make sure we haven't accidentally been linked against the wrong
195	version.	214	version (note, however, that this will not detect other ABI mismatches,
		215	such as LFS or reentrancy).
196		216
197	assert (("libev version mismatch",	217	assert (("libev version mismatch",
198	ev_version_major () == EV_VERSION_MAJOR	218	ev_version_major () == EV_VERSION_MAJOR
199	&& ev_version_minor () >= EV_VERSION_MINOR));	219	&& ev_version_minor () >= EV_VERSION_MINOR));
200		220
…		…
211	assert (("sorry, no epoll, no sex",	231	assert (("sorry, no epoll, no sex",
212	ev_supported_backends () & EVBACKEND_EPOLL));	232	ev_supported_backends () & EVBACKEND_EPOLL));
213		233
214	=item unsigned int ev_recommended_backends ()	234	=item unsigned int ev_recommended_backends ()
215		235
216	Return the set of all backends compiled into this binary of libev and also	236	Return the set of all backends compiled into this binary of libev and
217	recommended for this platform. This set is often smaller than the one	237	also recommended for this platform, meaning it will work for most file
		238	descriptor types. This set is often smaller than the one returned by
218	returned by C<ev_supported_backends>, as for example kqueue is broken on	239	C<ev_supported_backends>, as for example kqueue is broken on most BSDs
219	most BSDs and will not be auto-detected unless you explicitly request it	240	and will not be auto-detected unless you explicitly request it (assuming
220	(assuming you know what you are doing). This is the set of backends that	241	you know what you are doing). This is the set of backends that libev will
221	libev will probe for if you specify no backends explicitly.	242	probe for if you specify no backends explicitly.
222		243
223	=item unsigned int ev_embeddable_backends ()	244	=item unsigned int ev_embeddable_backends ()
224		245
225	Returns the set of backends that are embeddable in other event loops. This	246	Returns the set of backends that are embeddable in other event loops. This
226	is the theoretical, all-platform, value. To find which backends	247	value is platform-specific but can include backends not available on the
227	might be supported on the current system, you would need to look at	248	current system. To find which embeddable backends might be supported on
228	C<ev_embeddable_backends () & ev_supported_backends ()>, likewise for	249	the current system, you would need to look at C<ev_embeddable_backends ()
229	recommended ones.	250	& ev_supported_backends ()>, likewise for recommended ones.
230		251
231	See the description of C<ev_embed> watchers for more info.	252	See the description of C<ev_embed> watchers for more info.
232		253
233	=item ev_set_allocator (void *(*cb)(void *ptr, long size)) [NOT REENTRANT]	254	=item ev_set_allocator (void *(*cb)(void *ptr, long size) throw ())
234		255
235	Sets the allocation function to use (the prototype is similar - the	256	Sets the allocation function to use (the prototype is similar - the
236	semantics are identical to the C<realloc> C89/SuS/POSIX function). It is	257	semantics are identical to the C<realloc> C89/SuS/POSIX function). It is
237	used to allocate and free memory (no surprises here). If it returns zero	258	used to allocate and free memory (no surprises here). If it returns zero
238	when memory needs to be allocated (C<size != 0>), the library might abort	259	when memory needs to be allocated (C<size != 0>), the library might abort
…		…
264	}	285	}
265		286
266	...	287	...
267	ev_set_allocator (persistent_realloc);	288	ev_set_allocator (persistent_realloc);
268		289
269	=item ev_set_syserr_cb (void (*cb)(const char *msg)); [NOT REENTRANT]	290	=item ev_set_syserr_cb (void (*cb)(const char *msg) throw ())
270		291
271	Set the callback function to call on a retryable system call error (such	292	Set the callback function to call on a retryable system call error (such
272	as failed select, poll, epoll_wait). The message is a printable string	293	as failed select, poll, epoll_wait). The message is a printable string
273	indicating the system call or subsystem causing the problem. If this	294	indicating the system call or subsystem causing the problem. If this
274	callback is set, then libev will expect it to remedy the situation, no	295	callback is set, then libev will expect it to remedy the situation, no
…		…
286	}	307	}
287		308
288	...	309	...
289	ev_set_syserr_cb (fatal_error);	310	ev_set_syserr_cb (fatal_error);
290		311
		312	=item ev_feed_signal (int signum)
		313
		314	This function can be used to "simulate" a signal receive. It is completely
		315	safe to call this function at any time, from any context, including signal
		316	handlers or random threads.
		317
		318	Its main use is to customise signal handling in your process, especially
		319	in the presence of threads. For example, you could block signals
		320	by default in all threads (and specifying C<EVFLAG_NOSIGMASK> when
		321	creating any loops), and in one thread, use C<sigwait> or any other
		322	mechanism to wait for signals, then "deliver" them to libev by calling
		323	C<ev_feed_signal>.
		324
291	=back	325	=back
292		326
293	=head1 FUNCTIONS CONTROLLING THE EVENT LOOP	327	=head1 FUNCTIONS CONTROLLING EVENT LOOPS
294		328
295	An event loop is described by a C<struct ev_loop *> (the C<struct>	329	An event loop is described by a C<struct ev_loop *> (the C<struct> is
296	is I<not> optional in this case, as there is also an C<ev_loop>	330	I<not> optional in this case unless libev 3 compatibility is disabled, as
297	I<function>).	331	libev 3 had an C<ev_loop> function colliding with the struct name).
298		332
299	The library knows two types of such loops, the I<default> loop, which	333	The library knows two types of such loops, the I<default> loop, which
300	supports signals and child events, and dynamically created loops which do	334	supports child process events, and dynamically created event loops which
301	not.	335	do not.
302		336
303	=over 4	337	=over 4
304		338
305	=item struct ev_loop *ev_default_loop (unsigned int flags)	339	=item struct ev_loop *ev_default_loop (unsigned int flags)
306		340
307	This will initialise the default event loop if it hasn't been initialised	341	This returns the "default" event loop object, which is what you should
308	yet and return it. If the default loop could not be initialised, returns	342	normally use when you just need "the event loop". Event loop objects and
309	false. If it already was initialised it simply returns it (and ignores the	343	the C<flags> parameter are described in more detail in the entry for
310	flags. If that is troubling you, check C<ev_backend ()> afterwards).	344	C<ev_loop_new>.
		345
		346	If the default loop is already initialised then this function simply
		347	returns it (and ignores the flags. If that is troubling you, check
		348	C<ev_backend ()> afterwards). Otherwise it will create it with the given
		349	flags, which should almost always be C<0>, unless the caller is also the
		350	one calling C<ev_run> or otherwise qualifies as "the main program".
311		351
312	If you don't know what event loop to use, use the one returned from this	352	If you don't know what event loop to use, use the one returned from this
313	function.	353	function (or via the C<EV_DEFAULT> macro).
314		354
315	Note that this function is I<not> thread-safe, so if you want to use it	355	Note that this function is I<not> thread-safe, so if you want to use it
316	from multiple threads, you have to lock (note also that this is unlikely,	356	from multiple threads, you have to employ some kind of mutex (note also
317	as loops cannot be shared easily between threads anyway).	357	that this case is unlikely, as loops cannot be shared easily between
		358	threads anyway).
318		359
319	The default loop is the only loop that can handle C<ev_signal> and	360	The default loop is the only loop that can handle C<ev_child> watchers,
320	C<ev_child> watchers, and to do this, it always registers a handler	361	and to do this, it always registers a handler for C<SIGCHLD>. If this is
321	for C<SIGCHLD>. If this is a problem for your application you can either	362	a problem for your application you can either create a dynamic loop with
322	create a dynamic loop with C<ev_loop_new> that doesn't do that, or you	363	C<ev_loop_new> which doesn't do that, or you can simply overwrite the
323	can simply overwrite the C<SIGCHLD> signal handler I<after> calling	364	C<SIGCHLD> signal handler I<after> calling C<ev_default_init>.
324	C<ev_default_init>.	365
		366	Example: This is the most typical usage.
		367
		368	if (!ev_default_loop (0))
		369	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
		370
		371	Example: Restrict libev to the select and poll backends, and do not allow
		372	environment settings to be taken into account:
		373
		374	ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV);
		375
		376	=item struct ev_loop *ev_loop_new (unsigned int flags)
		377
		378	This will create and initialise a new event loop object. If the loop
		379	could not be initialised, returns false.
		380
		381	This function is thread-safe, and one common way to use libev with
		382	threads is indeed to create one loop per thread, and using the default
		383	loop in the "main" or "initial" thread.
325		384
326	The flags argument can be used to specify special behaviour or specific	385	The flags argument can be used to specify special behaviour or specific
327	backends to use, and is usually specified as C<0> (or C<EVFLAG_AUTO>).	386	backends to use, and is usually specified as C<0> (or C<EVFLAG_AUTO>).
328		387
329	The following flags are supported:	388	The following flags are supported:
…		…
339		398
340	If this flag bit is or'ed into the flag value (or the program runs setuid	399	If this flag bit is or'ed into the flag value (or the program runs setuid
341	or setgid) then libev will I<not> look at the environment variable	400	or setgid) then libev will I<not> look at the environment variable
342	C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will	401	C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will
343	override the flags completely if it is found in the environment. This is	402	override the flags completely if it is found in the environment. This is
344	useful to try out specific backends to test their performance, or to work	403	useful to try out specific backends to test their performance, to work
345	around bugs.	404	around bugs, or to make libev threadsafe (accessing environment variables
		405	cannot be done in a threadsafe way, but usually it works if no other
		406	thread modifies them).
346		407
347	=item C<EVFLAG_FORKCHECK>	408	=item C<EVFLAG_FORKCHECK>
348		409
349	Instead of calling C<ev_default_fork> or C<ev_loop_fork> manually after	410	Instead of calling C<ev_loop_fork> manually after a fork, you can also
350	a fork, you can also make libev check for a fork in each iteration by	411	make libev check for a fork in each iteration by enabling this flag.
351	enabling this flag.
352		412
353	This works by calling C<getpid ()> on every iteration of the loop,	413	This works by calling C<getpid ()> on every iteration of the loop,
354	and thus this might slow down your event loop if you do a lot of loop	414	and thus this might slow down your event loop if you do a lot of loop
355	iterations and little real work, but is usually not noticeable (on my	415	iterations and little real work, but is usually not noticeable (on my
356	GNU/Linux system for example, C<getpid> is actually a simple 5-insn sequence	416	GNU/Linux system for example, C<getpid> is actually a simple 5-insn sequence
…		…
362	flag.	422	flag.
363		423
364	This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS>	424	This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS>
365	environment variable.	425	environment variable.
366		426
		427	=item C<EVFLAG_NOINOTIFY>
		428
		429	When this flag is specified, then libev will not attempt to use the
		430	I<inotify> API for its C<ev_stat> watchers. Apart from debugging and
		431	testing, this flag can be useful to conserve inotify file descriptors, as
		432	otherwise each loop using C<ev_stat> watchers consumes one inotify handle.
		433
		434	=item C<EVFLAG_SIGNALFD>
		435
		436	When this flag is specified, then libev will attempt to use the
		437	I<signalfd> API for its C<ev_signal> (and C<ev_child>) watchers. This API
		438	delivers signals synchronously, which makes it both faster and might make
		439	it possible to get the queued signal data. It can also simplify signal
		440	handling with threads, as long as you properly block signals in your
		441	threads that are not interested in handling them.
		442
		443	Signalfd will not be used by default as this changes your signal mask, and
		444	there are a lot of shoddy libraries and programs (glib's threadpool for
		445	example) that can't properly initialise their signal masks.
		446
		447	=item C<EVFLAG_NOSIGMASK>
		448
		449	When this flag is specified, then libev will avoid to modify the signal
		450	mask. Specifically, this means you have to make sure signals are unblocked
		451	when you want to receive them.
		452
		453	This behaviour is useful when you want to do your own signal handling, or
		454	want to handle signals only in specific threads and want to avoid libev
		455	unblocking the signals.
		456
		457	It's also required by POSIX in a threaded program, as libev calls
		458	C<sigprocmask>, whose behaviour is officially unspecified.
		459
		460	This flag's behaviour will become the default in future versions of libev.
		461
367	=item C<EVBACKEND_SELECT> (value 1, portable select backend)	462	=item C<EVBACKEND_SELECT> (value 1, portable select backend)
368		463
369	This is your standard select(2) backend. Not I<completely> standard, as	464	This is your standard select(2) backend. Not I<completely> standard, as
370	libev tries to roll its own fd_set with no limits on the number of fds,	465	libev tries to roll its own fd_set with no limits on the number of fds,
371	but if that fails, expect a fairly low limit on the number of fds when	466	but if that fails, expect a fairly low limit on the number of fds when
…		…
395	This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and	490	This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and
396	C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>.	491	C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>.
397		492
398	=item C<EVBACKEND_EPOLL> (value 4, Linux)	493	=item C<EVBACKEND_EPOLL> (value 4, Linux)
399		494
		495	Use the linux-specific epoll(7) interface (for both pre- and post-2.6.9
		496	kernels).
		497
400	For few fds, this backend is a bit little slower than poll and select,	498	For few fds, this backend is a bit little slower than poll and select, but
401	but it scales phenomenally better. While poll and select usually scale	499	it scales phenomenally better. While poll and select usually scale like
402	like O(total_fds) where n is the total number of fds (or the highest fd),	500	O(total_fds) where total_fds is the total number of fds (or the highest
403	epoll scales either O(1) or O(active_fds).	501	fd), epoll scales either O(1) or O(active_fds).
404		502
405	The epoll mechanism deserves honorable mention as the most misdesigned	503	The epoll mechanism deserves honorable mention as the most misdesigned
406	of the more advanced event mechanisms: mere annoyances include silently	504	of the more advanced event mechanisms: mere annoyances include silently
407	dropping file descriptors, requiring a system call per change per file	505	dropping file descriptors, requiring a system call per change per file
408	descriptor (and unnecessary guessing of parameters), problems with dup and	506	descriptor (and unnecessary guessing of parameters), problems with dup,
		507	returning before the timeout value, resulting in additional iterations
		508	(and only giving 5ms accuracy while select on the same platform gives
409	so on. The biggest issue is fork races, however - if a program forks then	509	0.1ms) and so on. The biggest issue is fork races, however - if a program
410	I<both> parent and child process have to recreate the epoll set, which can	510	forks then I<both> parent and child process have to recreate the epoll
411	take considerable time (one syscall per file descriptor) and is of course	511	set, which can take considerable time (one syscall per file descriptor)
412	hard to detect.	512	and is of course hard to detect.
413		513
414	Epoll is also notoriously buggy - embedding epoll fds I<should> work, but	514	Epoll is also notoriously buggy - embedding epoll fds I<should> work,
415	of course I<doesn't>, and epoll just loves to report events for totally	515	but of course I<doesn't>, and epoll just loves to report events for
416	I<different> file descriptors (even already closed ones, so one cannot	516	totally I<different> file descriptors (even already closed ones, so
417	even remove them from the set) than registered in the set (especially	517	one cannot even remove them from the set) than registered in the set
418	on SMP systems). Libev tries to counter these spurious notifications by	518	(especially on SMP systems). Libev tries to counter these spurious
419	employing an additional generation counter and comparing that against the	519	notifications by employing an additional generation counter and comparing
420	events to filter out spurious ones, recreating the set when required.	520	that against the events to filter out spurious ones, recreating the set
		521	when required. Epoll also erroneously rounds down timeouts, but gives you
		522	no way to know when and by how much, so sometimes you have to busy-wait
		523	because epoll returns immediately despite a nonzero timeout. And last
		524	not least, it also refuses to work with some file descriptors which work
		525	perfectly fine with C<select> (files, many character devices...).
		526
		527	Epoll is truly the train wreck among event poll mechanisms, a frankenpoll,
		528	cobbled together in a hurry, no thought to design or interaction with
		529	others. Oh, the pain, will it ever stop...
421		530
422	While stopping, setting and starting an I/O watcher in the same iteration	531	While stopping, setting and starting an I/O watcher in the same iteration
423	will result in some caching, there is still a system call per such	532	will result in some caching, there is still a system call per such
424	incident (because the same I<file descriptor> could point to a different	533	incident (because the same I<file descriptor> could point to a different
425	I<file description> now), so its best to avoid that. Also, C<dup ()>'ed	534	I<file description> now), so its best to avoid that. Also, C<dup ()>'ed
…		…
462		571
463	It scales in the same way as the epoll backend, but the interface to the	572	It scales in the same way as the epoll backend, but the interface to the
464	kernel is more efficient (which says nothing about its actual speed, of	573	kernel is more efficient (which says nothing about its actual speed, of
465	course). While stopping, setting and starting an I/O watcher does never	574	course). While stopping, setting and starting an I/O watcher does never
466	cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to	575	cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to
467	two event changes per incident. Support for C<fork ()> is very bad (but	576	two event changes per incident. Support for C<fork ()> is very bad (you
468	sane, unlike epoll) and it drops fds silently in similarly hard-to-detect	577	might have to leak fd's on fork, but it's more sane than epoll) and it
469	cases	578	drops fds silently in similarly hard-to-detect cases.
470		579
471	This backend usually performs well under most conditions.	580	This backend usually performs well under most conditions.
472		581
473	While nominally embeddable in other event loops, this doesn't work	582	While nominally embeddable in other event loops, this doesn't work
474	everywhere, so you might need to test for this. And since it is broken	583	everywhere, so you might need to test for this. And since it is broken
…		…
491	=item C<EVBACKEND_PORT> (value 32, Solaris 10)	600	=item C<EVBACKEND_PORT> (value 32, Solaris 10)
492		601
493	This uses the Solaris 10 event port mechanism. As with everything on Solaris,	602	This uses the Solaris 10 event port mechanism. As with everything on Solaris,
494	it's really slow, but it still scales very well (O(active_fds)).	603	it's really slow, but it still scales very well (O(active_fds)).
495		604
496	Please note that Solaris event ports can deliver a lot of spurious
497	notifications, so you need to use non-blocking I/O or other means to avoid
498	blocking when no data (or space) is available.
499
500	While this backend scales well, it requires one system call per active	605	While this backend scales well, it requires one system call per active
501	file descriptor per loop iteration. For small and medium numbers of file	606	file descriptor per loop iteration. For small and medium numbers of file
502	descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend	607	descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend
503	might perform better.	608	might perform better.
504		609
505	On the positive side, with the exception of the spurious readiness	610	On the positive side, this backend actually performed fully to
506	notifications, this backend actually performed fully to specification
507	in all tests and is fully embeddable, which is a rare feat among the	611	specification in all tests and is fully embeddable, which is a rare feat
508	OS-specific backends (I vastly prefer correctness over speed hacks).	612	among the OS-specific backends (I vastly prefer correctness over speed
		613	hacks).
		614
		615	On the negative side, the interface is I<bizarre> - so bizarre that
		616	even sun itself gets it wrong in their code examples: The event polling
		617	function sometimes returns events to the caller even though an error
		618	occurred, but with no indication whether it has done so or not (yes, it's
		619	even documented that way) - deadly for edge-triggered interfaces where you
		620	absolutely have to know whether an event occurred or not because you have
		621	to re-arm the watcher.
		622
		623	Fortunately libev seems to be able to work around these idiocies.
509		624
510	This backend maps C<EV_READ> and C<EV_WRITE> in the same way as	625	This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
511	C<EVBACKEND_POLL>.	626	C<EVBACKEND_POLL>.
512		627
513	=item C<EVBACKEND_ALL>	628	=item C<EVBACKEND_ALL>
514		629
515	Try all backends (even potentially broken ones that wouldn't be tried	630	Try all backends (even potentially broken ones that wouldn't be tried
516	with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as	631	with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as
517	C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>.	632	C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>.
518		633
519	It is definitely not recommended to use this flag.	634	It is definitely not recommended to use this flag, use whatever
		635	C<ev_recommended_backends ()> returns, or simply do not specify a backend
		636	at all.
		637
		638	=item C<EVBACKEND_MASK>
		639
		640	Not a backend at all, but a mask to select all backend bits from a
		641	C<flags> value, in case you want to mask out any backends from a flags
		642	value (e.g. when modifying the C<LIBEV_FLAGS> environment variable).
520		643
521	=back	644	=back
522		645
523	If one or more of these are or'ed into the flags value, then only these	646	If one or more of the backend flags are or'ed into the flags value,
524	backends will be tried (in the reverse order as listed here). If none are	647	then only these backends will be tried (in the reverse order as listed
525	specified, all backends in C<ev_recommended_backends ()> will be tried.	648	here). If none are specified, all backends in C<ev_recommended_backends
526		649	()> will be tried.
527	Example: This is the most typical usage.
528
529	if (!ev_default_loop (0))
530	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
531
532	Example: Restrict libev to the select and poll backends, and do not allow
533	environment settings to be taken into account:
534
535	ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV);
536
537	Example: Use whatever libev has to offer, but make sure that kqueue is
538	used if available (warning, breaks stuff, best use only with your own
539	private event loop and only if you know the OS supports your types of
540	fds):
541
542	ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE);
543
544	=item struct ev_loop *ev_loop_new (unsigned int flags)
545
546	Similar to C<ev_default_loop>, but always creates a new event loop that is
547	always distinct from the default loop. Unlike the default loop, it cannot
548	handle signal and child watchers, and attempts to do so will be greeted by
549	undefined behaviour (or a failed assertion if assertions are enabled).
550
551	Note that this function I<is> thread-safe, and the recommended way to use
552	libev with threads is indeed to create one loop per thread, and using the
553	default loop in the "main" or "initial" thread.
554		650
555	Example: Try to create a event loop that uses epoll and nothing else.	651	Example: Try to create a event loop that uses epoll and nothing else.
556		652
557	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);	653	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
558	if (!epoller)	654	if (!epoller)
559	fatal ("no epoll found here, maybe it hides under your chair");	655	fatal ("no epoll found here, maybe it hides under your chair");
560		656
		657	Example: Use whatever libev has to offer, but make sure that kqueue is
		658	used if available.
		659
		660	struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE);
		661
561	=item ev_default_destroy ()	662	=item ev_loop_destroy (loop)
562		663
563	Destroys the default loop again (frees all memory and kernel state	664	Destroys an event loop object (frees all memory and kernel state
564	etc.). None of the active event watchers will be stopped in the normal	665	etc.). None of the active event watchers will be stopped in the normal
565	sense, so e.g. C<ev_is_active> might still return true. It is your	666	sense, so e.g. C<ev_is_active> might still return true. It is your
566	responsibility to either stop all watchers cleanly yourself I<before>	667	responsibility to either stop all watchers cleanly yourself I<before>
567	calling this function, or cope with the fact afterwards (which is usually	668	calling this function, or cope with the fact afterwards (which is usually
568	the easiest thing, you can just ignore the watchers and/or C<free ()> them	669	the easiest thing, you can just ignore the watchers and/or C<free ()> them
…		…
570		671
571	Note that certain global state, such as signal state (and installed signal	672	Note that certain global state, such as signal state (and installed signal
572	handlers), will not be freed by this function, and related watchers (such	673	handlers), will not be freed by this function, and related watchers (such
573	as signal and child watchers) would need to be stopped manually.	674	as signal and child watchers) would need to be stopped manually.
574		675
575	In general it is not advisable to call this function except in the	676	This function is normally used on loop objects allocated by
576	rare occasion where you really need to free e.g. the signal handling	677	C<ev_loop_new>, but it can also be used on the default loop returned by
		678	C<ev_default_loop>, in which case it is not thread-safe.
		679
		680	Note that it is not advisable to call this function on the default loop
		681	except in the rare occasion where you really need to free its resources.
577	pipe fds. If you need dynamically allocated loops it is better to use	682	If you need dynamically allocated loops it is better to use C<ev_loop_new>
578	C<ev_loop_new> and C<ev_loop_destroy>).	683	and C<ev_loop_destroy>.
579		684
580	=item ev_loop_destroy (loop)	685	=item ev_loop_fork (loop)
581		686
582	Like C<ev_default_destroy>, but destroys an event loop created by an
583	earlier call to C<ev_loop_new>.
584
585	=item ev_default_fork ()
586
587	This function sets a flag that causes subsequent C<ev_loop> iterations	687	This function sets a flag that causes subsequent C<ev_run> iterations to
588	to reinitialise the kernel state for backends that have one. Despite the	688	reinitialise the kernel state for backends that have one. Despite the
589	name, you can call it anytime, but it makes most sense after forking, in	689	name, you can call it anytime, but it makes most sense after forking, in
590	the child process (or both child and parent, but that again makes little	690	the child process. You I<must> call it (or use C<EVFLAG_FORKCHECK>) in the
591	sense). You I<must> call it in the child before using any of the libev	691	child before resuming or calling C<ev_run>.
592	functions, and it will only take effect at the next C<ev_loop> iteration.	692
		693	Again, you I<have> to call it on I<any> loop that you want to re-use after
		694	a fork, I<even if you do not plan to use the loop in the parent>. This is
		695	because some kernel interfaces *cough* I<kqueue> *cough* do funny things
		696	during fork.
593		697
594	On the other hand, you only need to call this function in the child	698	On the other hand, you only need to call this function in the child
595	process if and only if you want to use the event library in the child. If	699	process if and only if you want to use the event loop in the child. If
596	you just fork+exec, you don't have to call it at all.	700	you just fork+exec or create a new loop in the child, you don't have to
		701	call it at all (in fact, C<epoll> is so badly broken that it makes a
		702	difference, but libev will usually detect this case on its own and do a
		703	costly reset of the backend).
597		704
598	The function itself is quite fast and it's usually not a problem to call	705	The function itself is quite fast and it's usually not a problem to call
599	it just in case after a fork. To make this easy, the function will fit in	706	it just in case after a fork.
600	quite nicely into a call to C<pthread_atfork>:
601		707
		708	Example: Automate calling C<ev_loop_fork> on the default loop when
		709	using pthreads.
		710
		711	static void
		712	post_fork_child (void)
		713	{
		714	ev_loop_fork (EV_DEFAULT);
		715	}
		716
		717	...
602	pthread_atfork (0, 0, ev_default_fork);	718	pthread_atfork (0, 0, post_fork_child);
603
604	=item ev_loop_fork (loop)
605
606	Like C<ev_default_fork>, but acts on an event loop created by
607	C<ev_loop_new>. Yes, you have to call this on every allocated event loop
608	after fork that you want to re-use in the child, and how you do this is
609	entirely your own problem.
610		719
611	=item int ev_is_default_loop (loop)	720	=item int ev_is_default_loop (loop)
612		721
613	Returns true when the given loop is, in fact, the default loop, and false	722	Returns true when the given loop is, in fact, the default loop, and false
614	otherwise.	723	otherwise.
615		724
616	=item unsigned int ev_loop_count (loop)	725	=item unsigned int ev_iteration (loop)
617		726
618	Returns the count of loop iterations for the loop, which is identical to	727	Returns the current iteration count for the event loop, which is identical
619	the number of times libev did poll for new events. It starts at C<0> and	728	to the number of times libev did poll for new events. It starts at C<0>
620	happily wraps around with enough iterations.	729	and happily wraps around with enough iterations.
621		730
622	This value can sometimes be useful as a generation counter of sorts (it	731	This value can sometimes be useful as a generation counter of sorts (it
623	"ticks" the number of loop iterations), as it roughly corresponds with	732	"ticks" the number of loop iterations), as it roughly corresponds with
624	C<ev_prepare> and C<ev_check> calls.	733	C<ev_prepare> and C<ev_check> calls - and is incremented between the
		734	prepare and check phases.
625		735
626	=item unsigned int ev_loop_depth (loop)	736	=item unsigned int ev_depth (loop)
627		737
628	Returns the number of times C<ev_loop> was entered minus the number of	738	Returns the number of times C<ev_run> was entered minus the number of
629	times C<ev_loop> was exited, in other words, the recursion depth.	739	times C<ev_run> was exited normally, in other words, the recursion depth.
630		740
631	Outside C<ev_loop>, this number is zero. In a callback, this number is	741	Outside C<ev_run>, this number is zero. In a callback, this number is
632	C<1>, unless C<ev_loop> was invoked recursively (or from another thread),	742	C<1>, unless C<ev_run> was invoked recursively (or from another thread),
633	in which case it is higher.	743	in which case it is higher.
634		744
635	Leaving C<ev_loop> abnormally (setjmp/longjmp, cancelling the thread	745	Leaving C<ev_run> abnormally (setjmp/longjmp, cancelling the thread,
636	etc.), doesn't count as exit.	746	throwing an exception etc.), doesn't count as "exit" - consider this
		747	as a hint to avoid such ungentleman-like behaviour unless it's really
		748	convenient, in which case it is fully supported.
637		749
638	=item unsigned int ev_backend (loop)	750	=item unsigned int ev_backend (loop)
639		751
640	Returns one of the C<EVBACKEND_*> flags indicating the event backend in	752	Returns one of the C<EVBACKEND_*> flags indicating the event backend in
641	use.	753	use.
…		…
650		762
651	=item ev_now_update (loop)	763	=item ev_now_update (loop)
652		764
653	Establishes the current time by querying the kernel, updating the time	765	Establishes the current time by querying the kernel, updating the time
654	returned by C<ev_now ()> in the progress. This is a costly operation and	766	returned by C<ev_now ()> in the progress. This is a costly operation and
655	is usually done automatically within C<ev_loop ()>.	767	is usually done automatically within C<ev_run ()>.
656		768
657	This function is rarely useful, but when some event callback runs for a	769	This function is rarely useful, but when some event callback runs for a
658	very long time without entering the event loop, updating libev's idea of	770	very long time without entering the event loop, updating libev's idea of
659	the current time is a good idea.	771	the current time is a good idea.
660		772
661	See also L<The special problem of time updates> in the C<ev_timer> section.	773	See also L</The special problem of time updates> in the C<ev_timer> section.
662		774
663	=item ev_suspend (loop)	775	=item ev_suspend (loop)
664		776
665	=item ev_resume (loop)	777	=item ev_resume (loop)
666		778
667	These two functions suspend and resume a loop, for use when the loop is	779	These two functions suspend and resume an event loop, for use when the
668	not used for a while and timeouts should not be processed.	780	loop is not used for a while and timeouts should not be processed.
669		781
670	A typical use case would be an interactive program such as a game: When	782	A typical use case would be an interactive program such as a game: When
671	the user presses C<^Z> to suspend the game and resumes it an hour later it	783	the user presses C<^Z> to suspend the game and resumes it an hour later it
672	would be best to handle timeouts as if no time had actually passed while	784	would be best to handle timeouts as if no time had actually passed while
673	the program was suspended. This can be achieved by calling C<ev_suspend>	785	the program was suspended. This can be achieved by calling C<ev_suspend>
…		…
675	C<ev_resume> directly afterwards to resume timer processing.	787	C<ev_resume> directly afterwards to resume timer processing.
676		788
677	Effectively, all C<ev_timer> watchers will be delayed by the time spend	789	Effectively, all C<ev_timer> watchers will be delayed by the time spend
678	between C<ev_suspend> and C<ev_resume>, and all C<ev_periodic> watchers	790	between C<ev_suspend> and C<ev_resume>, and all C<ev_periodic> watchers
679	will be rescheduled (that is, they will lose any events that would have	791	will be rescheduled (that is, they will lose any events that would have
680	occured while suspended).	792	occurred while suspended).
681		793
682	After calling C<ev_suspend> you B<must not> call I<any> function on the	794	After calling C<ev_suspend> you B<must not> call I<any> function on the
683	given loop other than C<ev_resume>, and you B<must not> call C<ev_resume>	795	given loop other than C<ev_resume>, and you B<must not> call C<ev_resume>
684	without a previous call to C<ev_suspend>.	796	without a previous call to C<ev_suspend>.
685		797
686	Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the	798	Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the
687	event loop time (see C<ev_now_update>).	799	event loop time (see C<ev_now_update>).
688		800
689	=item ev_loop (loop, int flags)	801	=item bool ev_run (loop, int flags)
690		802
691	Finally, this is it, the event handler. This function usually is called	803	Finally, this is it, the event handler. This function usually is called
692	after you initialised all your watchers and you want to start handling	804	after you have initialised all your watchers and you want to start
693	events.	805	handling events. It will ask the operating system for any new events, call
		806	the watcher callbacks, and then repeat the whole process indefinitely: This
		807	is why event loops are called I<loops>.
694		808
695	If the flags argument is specified as C<0>, it will not return until	809	If the flags argument is specified as C<0>, it will keep handling events
696	either no event watchers are active anymore or C<ev_unloop> was called.	810	until either no event watchers are active anymore or C<ev_break> was
		811	called.
697		812
		813	The return value is false if there are no more active watchers (which
		814	usually means "all jobs done" or "deadlock"), and true in all other cases
		815	(which usually means " you should call C<ev_run> again").
		816
698	Please note that an explicit C<ev_unloop> is usually better than	817	Please note that an explicit C<ev_break> is usually better than
699	relying on all watchers to be stopped when deciding when a program has	818	relying on all watchers to be stopped when deciding when a program has
700	finished (especially in interactive programs), but having a program	819	finished (especially in interactive programs), but having a program
701	that automatically loops as long as it has to and no longer by virtue	820	that automatically loops as long as it has to and no longer by virtue
702	of relying on its watchers stopping correctly, that is truly a thing of	821	of relying on its watchers stopping correctly, that is truly a thing of
703	beauty.	822	beauty.
704		823
		824	This function is I<mostly> exception-safe - you can break out of a
		825	C<ev_run> call by calling C<longjmp> in a callback, throwing a C++
		826	exception and so on. This does not decrement the C<ev_depth> value, nor
		827	will it clear any outstanding C<EVBREAK_ONE> breaks.
		828
705	A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle	829	A flags value of C<EVRUN_NOWAIT> will look for new events, will handle
706	those events and any already outstanding ones, but will not block your	830	those events and any already outstanding ones, but will not wait and
707	process in case there are no events and will return after one iteration of	831	block your process in case there are no events and will return after one
708	the loop.	832	iteration of the loop. This is sometimes useful to poll and handle new
		833	events while doing lengthy calculations, to keep the program responsive.
709		834
710	A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if	835	A flags value of C<EVRUN_ONCE> will look for new events (waiting if
711	necessary) and will handle those and any already outstanding ones. It	836	necessary) and will handle those and any already outstanding ones. It
712	will block your process until at least one new event arrives (which could	837	will block your process until at least one new event arrives (which could
713	be an event internal to libev itself, so there is no guarantee that a	838	be an event internal to libev itself, so there is no guarantee that a
714	user-registered callback will be called), and will return after one	839	user-registered callback will be called), and will return after one
715	iteration of the loop.	840	iteration of the loop.
716		841
717	This is useful if you are waiting for some external event in conjunction	842	This is useful if you are waiting for some external event in conjunction
718	with something not expressible using other libev watchers (i.e. "roll your	843	with something not expressible using other libev watchers (i.e. "roll your
719	own C<ev_loop>"). However, a pair of C<ev_prepare>/C<ev_check> watchers is	844	own C<ev_run>"). However, a pair of C<ev_prepare>/C<ev_check> watchers is
720	usually a better approach for this kind of thing.	845	usually a better approach for this kind of thing.
721		846
722	Here are the gory details of what C<ev_loop> does:	847	Here are the gory details of what C<ev_run> does (this is for your
		848	understanding, not a guarantee that things will work exactly like this in
		849	future versions):
723		850
		851	- Increment loop depth.
		852	- Reset the ev_break status.
724	- Before the first iteration, call any pending watchers.	853	- Before the first iteration, call any pending watchers.
		854	LOOP:
725	* If EVFLAG_FORKCHECK was used, check for a fork.	855	- If EVFLAG_FORKCHECK was used, check for a fork.
726	- If a fork was detected (by any means), queue and call all fork watchers.	856	- If a fork was detected (by any means), queue and call all fork watchers.
727	- Queue and call all prepare watchers.	857	- Queue and call all prepare watchers.
		858	- If ev_break was called, goto FINISH.
728	- If we have been forked, detach and recreate the kernel state	859	- If we have been forked, detach and recreate the kernel state
729	as to not disturb the other process.	860	as to not disturb the other process.
730	- Update the kernel state with all outstanding changes.	861	- Update the kernel state with all outstanding changes.
731	- Update the "event loop time" (ev_now ()).	862	- Update the "event loop time" (ev_now ()).
732	- Calculate for how long to sleep or block, if at all	863	- Calculate for how long to sleep or block, if at all
733	(active idle watchers, EVLOOP_NONBLOCK or not having	864	(active idle watchers, EVRUN_NOWAIT or not having
734	any active watchers at all will result in not sleeping).	865	any active watchers at all will result in not sleeping).
735	- Sleep if the I/O and timer collect interval say so.	866	- Sleep if the I/O and timer collect interval say so.
		867	- Increment loop iteration counter.
736	- Block the process, waiting for any events.	868	- Block the process, waiting for any events.
737	- Queue all outstanding I/O (fd) events.	869	- Queue all outstanding I/O (fd) events.
738	- Update the "event loop time" (ev_now ()), and do time jump adjustments.	870	- Update the "event loop time" (ev_now ()), and do time jump adjustments.
739	- Queue all expired timers.	871	- Queue all expired timers.
740	- Queue all expired periodics.	872	- Queue all expired periodics.
741	- Unless any events are pending now, queue all idle watchers.	873	- Queue all idle watchers with priority higher than that of pending events.
742	- Queue all check watchers.	874	- Queue all check watchers.
743	- Call all queued watchers in reverse order (i.e. check watchers first).	875	- Call all queued watchers in reverse order (i.e. check watchers first).
744	Signals and child watchers are implemented as I/O watchers, and will	876	Signals and child watchers are implemented as I/O watchers, and will
745	be handled here by queueing them when their watcher gets executed.	877	be handled here by queueing them when their watcher gets executed.
746	- If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK	878	- If ev_break has been called, or EVRUN_ONCE or EVRUN_NOWAIT
747	were used, or there are no active watchers, return, otherwise	879	were used, or there are no active watchers, goto FINISH, otherwise
748	continue with step *.	880	continue with step LOOP.
		881	FINISH:
		882	- Reset the ev_break status iff it was EVBREAK_ONE.
		883	- Decrement the loop depth.
		884	- Return.
749		885
750	Example: Queue some jobs and then loop until no events are outstanding	886	Example: Queue some jobs and then loop until no events are outstanding
751	anymore.	887	anymore.
752		888
753	... queue jobs here, make sure they register event watchers as long	889	... queue jobs here, make sure they register event watchers as long
754	... as they still have work to do (even an idle watcher will do..)	890	... as they still have work to do (even an idle watcher will do..)
755	ev_loop (my_loop, 0);	891	ev_run (my_loop, 0);
756	... jobs done or somebody called unloop. yeah!	892	... jobs done or somebody called break. yeah!
757		893
758	=item ev_unloop (loop, how)	894	=item ev_break (loop, how)
759		895
760	Can be used to make a call to C<ev_loop> return early (but only after it	896	Can be used to make a call to C<ev_run> return early (but only after it
761	has processed all outstanding events). The C<how> argument must be either	897	has processed all outstanding events). The C<how> argument must be either
762	C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or	898	C<EVBREAK_ONE>, which will make the innermost C<ev_run> call return, or
763	C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return.	899	C<EVBREAK_ALL>, which will make all nested C<ev_run> calls return.
764		900
765	This "unloop state" will be cleared when entering C<ev_loop> again.	901	This "break state" will be cleared on the next call to C<ev_run>.
766		902
767	It is safe to call C<ev_unloop> from otuside any C<ev_loop> calls.	903	It is safe to call C<ev_break> from outside any C<ev_run> calls, too, in
		904	which case it will have no effect.
768		905
769	=item ev_ref (loop)	906	=item ev_ref (loop)
770		907
771	=item ev_unref (loop)	908	=item ev_unref (loop)
772		909
773	Ref/unref can be used to add or remove a reference count on the event	910	Ref/unref can be used to add or remove a reference count on the event
774	loop: Every watcher keeps one reference, and as long as the reference	911	loop: Every watcher keeps one reference, and as long as the reference
775	count is nonzero, C<ev_loop> will not return on its own.	912	count is nonzero, C<ev_run> will not return on its own.
776		913
777	If you have a watcher you never unregister that should not keep C<ev_loop>	914	This is useful when you have a watcher that you never intend to
778	from returning, call ev_unref() after starting, and ev_ref() before	915	unregister, but that nevertheless should not keep C<ev_run> from
		916	returning. In such a case, call C<ev_unref> after starting, and C<ev_ref>
779	stopping it.	917	before stopping it.
780		918
781	As an example, libev itself uses this for its internal signal pipe: It	919	As an example, libev itself uses this for its internal signal pipe: It
782	is not visible to the libev user and should not keep C<ev_loop> from	920	is not visible to the libev user and should not keep C<ev_run> from
783	exiting if no event watchers registered by it are active. It is also an	921	exiting if no event watchers registered by it are active. It is also an
784	excellent way to do this for generic recurring timers or from within	922	excellent way to do this for generic recurring timers or from within
785	third-party libraries. Just remember to I<unref after start> and I<ref	923	third-party libraries. Just remember to I<unref after start> and I<ref
786	before stop> (but only if the watcher wasn't active before, or was active	924	before stop> (but only if the watcher wasn't active before, or was active
787	before, respectively. Note also that libev might stop watchers itself	925	before, respectively. Note also that libev might stop watchers itself
788	(e.g. non-repeating timers) in which case you have to C<ev_ref>	926	(e.g. non-repeating timers) in which case you have to C<ev_ref>
789	in the callback).	927	in the callback).
790		928
791	Example: Create a signal watcher, but keep it from keeping C<ev_loop>	929	Example: Create a signal watcher, but keep it from keeping C<ev_run>
792	running when nothing else is active.	930	running when nothing else is active.
793		931
794	ev_signal exitsig;	932	ev_signal exitsig;
795	ev_signal_init (&exitsig, sig_cb, SIGINT);	933	ev_signal_init (&exitsig, sig_cb, SIGINT);
796	ev_signal_start (loop, &exitsig);	934	ev_signal_start (loop, &exitsig);
797	evf_unref (loop);	935	ev_unref (loop);
798		936
799	Example: For some weird reason, unregister the above signal handler again.	937	Example: For some weird reason, unregister the above signal handler again.
800		938
801	ev_ref (loop);	939	ev_ref (loop);
802	ev_signal_stop (loop, &exitsig);	940	ev_signal_stop (loop, &exitsig);
…		…
822	overhead for the actual polling but can deliver many events at once.	960	overhead for the actual polling but can deliver many events at once.
823		961
824	By setting a higher I<io collect interval> you allow libev to spend more	962	By setting a higher I<io collect interval> you allow libev to spend more
825	time collecting I/O events, so you can handle more events per iteration,	963	time collecting I/O events, so you can handle more events per iteration,
826	at the cost of increasing latency. Timeouts (both C<ev_periodic> and	964	at the cost of increasing latency. Timeouts (both C<ev_periodic> and
827	C<ev_timer>) will be not affected. Setting this to a non-null value will	965	C<ev_timer>) will not be affected. Setting this to a non-null value will
828	introduce an additional C<ev_sleep ()> call into most loop iterations. The	966	introduce an additional C<ev_sleep ()> call into most loop iterations. The
829	sleep time ensures that libev will not poll for I/O events more often then	967	sleep time ensures that libev will not poll for I/O events more often then
830	once per this interval, on average.	968	once per this interval, on average (as long as the host time resolution is
		969	good enough).
831		970
832	Likewise, by setting a higher I<timeout collect interval> you allow libev	971	Likewise, by setting a higher I<timeout collect interval> you allow libev
833	to spend more time collecting timeouts, at the expense of increased	972	to spend more time collecting timeouts, at the expense of increased
834	latency/jitter/inexactness (the watcher callback will be called	973	latency/jitter/inexactness (the watcher callback will be called
835	later). C<ev_io> watchers will not be affected. Setting this to a non-null	974	later). C<ev_io> watchers will not be affected. Setting this to a non-null
…		…
841	usually doesn't make much sense to set it to a lower value than C<0.01>,	980	usually doesn't make much sense to set it to a lower value than C<0.01>,
842	as this approaches the timing granularity of most systems. Note that if	981	as this approaches the timing granularity of most systems. Note that if
843	you do transactions with the outside world and you can't increase the	982	you do transactions with the outside world and you can't increase the
844	parallelity, then this setting will limit your transaction rate (if you	983	parallelity, then this setting will limit your transaction rate (if you
845	need to poll once per transaction and the I/O collect interval is 0.01,	984	need to poll once per transaction and the I/O collect interval is 0.01,
846	then you can't do more than 100 transations per second).	985	then you can't do more than 100 transactions per second).
847		986
848	Setting the I<timeout collect interval> can improve the opportunity for	987	Setting the I<timeout collect interval> can improve the opportunity for
849	saving power, as the program will "bundle" timer callback invocations that	988	saving power, as the program will "bundle" timer callback invocations that
850	are "near" in time together, by delaying some, thus reducing the number of	989	are "near" in time together, by delaying some, thus reducing the number of
851	times the process sleeps and wakes up again. Another useful technique to	990	times the process sleeps and wakes up again. Another useful technique to
…		…
859	ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01);	998	ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01);
860		999
861	=item ev_invoke_pending (loop)	1000	=item ev_invoke_pending (loop)
862		1001
863	This call will simply invoke all pending watchers while resetting their	1002	This call will simply invoke all pending watchers while resetting their
864	pending state. Normally, C<ev_loop> does this automatically when required,	1003	pending state. Normally, C<ev_run> does this automatically when required,
865	but when overriding the invoke callback this call comes handy.	1004	but when overriding the invoke callback this call comes handy. This
		1005	function can be invoked from a watcher - this can be useful for example
		1006	when you want to do some lengthy calculation and want to pass further
		1007	event handling to another thread (you still have to make sure only one
		1008	thread executes within C<ev_invoke_pending> or C<ev_run> of course).
866		1009
867	=item int ev_pending_count (loop)	1010	=item int ev_pending_count (loop)
868		1011
869	Returns the number of pending watchers - zero indicates that no watchers	1012	Returns the number of pending watchers - zero indicates that no watchers
870	are pending.	1013	are pending.
871		1014
872	=item ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P))	1015	=item ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P))
873		1016
874	This overrides the invoke pending functionality of the loop: Instead of	1017	This overrides the invoke pending functionality of the loop: Instead of
875	invoking all pending watchers when there are any, C<ev_loop> will call	1018	invoking all pending watchers when there are any, C<ev_run> will call
876	this callback instead. This is useful, for example, when you want to	1019	this callback instead. This is useful, for example, when you want to
877	invoke the actual watchers inside another context (another thread etc.).	1020	invoke the actual watchers inside another context (another thread etc.).
878		1021
879	If you want to reset the callback, use C<ev_invoke_pending> as new	1022	If you want to reset the callback, use C<ev_invoke_pending> as new
880	callback.	1023	callback.
881		1024
882	=item ev_set_loop_release_cb (loop, void (*release)(EV_P), void (*acquire)(EV_P))	1025	=item ev_set_loop_release_cb (loop, void (*release)(EV_P) throw (), void (*acquire)(EV_P) throw ())
883		1026
884	Sometimes you want to share the same loop between multiple threads. This	1027	Sometimes you want to share the same loop between multiple threads. This
885	can be done relatively simply by putting mutex_lock/unlock calls around	1028	can be done relatively simply by putting mutex_lock/unlock calls around
886	each call to a libev function.	1029	each call to a libev function.
887		1030
888	However, C<ev_loop> can run an indefinite time, so it is not feasible to	1031	However, C<ev_run> can run an indefinite time, so it is not feasible
889	wait for it to return. One way around this is to wake up the loop via	1032	to wait for it to return. One way around this is to wake up the event
890	C<ev_unloop> and C<av_async_send>, another way is to set these I<release>	1033	loop via C<ev_break> and C<ev_async_send>, another way is to set these
891	and I<acquire> callbacks on the loop.	1034	I<release> and I<acquire> callbacks on the loop.
892		1035
893	When set, then C<release> will be called just before the thread is	1036	When set, then C<release> will be called just before the thread is
894	suspended waiting for new events, and C<acquire> is called just	1037	suspended waiting for new events, and C<acquire> is called just
895	afterwards.	1038	afterwards.
896		1039
…		…
899		1042
900	While event loop modifications are allowed between invocations of	1043	While event loop modifications are allowed between invocations of
901	C<release> and C<acquire> (that's their only purpose after all), no	1044	C<release> and C<acquire> (that's their only purpose after all), no
902	modifications done will affect the event loop, i.e. adding watchers will	1045	modifications done will affect the event loop, i.e. adding watchers will
903	have no effect on the set of file descriptors being watched, or the time	1046	have no effect on the set of file descriptors being watched, or the time
904	waited. USe an C<ev_async> watcher to wake up C<ev_loop> when you want it	1047	waited. Use an C<ev_async> watcher to wake up C<ev_run> when you want it
905	to take note of any changes you made.	1048	to take note of any changes you made.
906		1049
907	In theory, threads executing C<ev_loop> will be async-cancel safe between	1050	In theory, threads executing C<ev_run> will be async-cancel safe between
908	invocations of C<release> and C<acquire>.	1051	invocations of C<release> and C<acquire>.
909		1052
910	See also the locking example in the C<THREADS> section later in this	1053	See also the locking example in the C<THREADS> section later in this
911	document.	1054	document.
912		1055
913	=item ev_set_userdata (loop, void *data)	1056	=item ev_set_userdata (loop, void *data)
914		1057
915	=item ev_userdata (loop)	1058	=item void *ev_userdata (loop)
916		1059
917	Set and retrieve a single C<void *> associated with a loop. When	1060	Set and retrieve a single C<void *> associated with a loop. When
918	C<ev_set_userdata> has never been called, then C<ev_userdata> returns	1061	C<ev_set_userdata> has never been called, then C<ev_userdata> returns
919	C<0.>	1062	C<0>.
920		1063
921	These two functions can be used to associate arbitrary data with a loop,	1064	These two functions can be used to associate arbitrary data with a loop,
922	and are intended solely for the C<invoke_pending_cb>, C<release> and	1065	and are intended solely for the C<invoke_pending_cb>, C<release> and
923	C<acquire> callbacks described above, but of course can be (ab-)used for	1066	C<acquire> callbacks described above, but of course can be (ab-)used for
924	any other purpose as well.	1067	any other purpose as well.
925		1068
926	=item ev_loop_verify (loop)	1069	=item ev_verify (loop)
927		1070
928	This function only does something when C<EV_VERIFY> support has been	1071	This function only does something when C<EV_VERIFY> support has been
929	compiled in, which is the default for non-minimal builds. It tries to go	1072	compiled in, which is the default for non-minimal builds. It tries to go
930	through all internal structures and checks them for validity. If anything	1073	through all internal structures and checks them for validity. If anything
931	is found to be inconsistent, it will print an error message to standard	1074	is found to be inconsistent, it will print an error message to standard
…		…
942		1085
943	In the following description, uppercase C<TYPE> in names stands for the	1086	In the following description, uppercase C<TYPE> in names stands for the
944	watcher type, e.g. C<ev_TYPE_start> can mean C<ev_timer_start> for timer	1087	watcher type, e.g. C<ev_TYPE_start> can mean C<ev_timer_start> for timer
945	watchers and C<ev_io_start> for I/O watchers.	1088	watchers and C<ev_io_start> for I/O watchers.
946		1089
947	A watcher is a structure that you create and register to record your	1090	A watcher is an opaque structure that you allocate and register to record
948	interest in some event. For instance, if you want to wait for STDIN to	1091	your interest in some event. To make a concrete example, imagine you want
949	become readable, you would create an C<ev_io> watcher for that:	1092	to wait for STDIN to become readable, you would create an C<ev_io> watcher
		1093	for that:
950		1094
951	static void my_cb (struct ev_loop *loop, ev_io *w, int revents)	1095	static void my_cb (struct ev_loop *loop, ev_io *w, int revents)
952	{	1096	{
953	ev_io_stop (w);	1097	ev_io_stop (w);
954	ev_unloop (loop, EVUNLOOP_ALL);	1098	ev_break (loop, EVBREAK_ALL);
955	}	1099	}
956		1100
957	struct ev_loop *loop = ev_default_loop (0);	1101	struct ev_loop *loop = ev_default_loop (0);
958		1102
959	ev_io stdin_watcher;	1103	ev_io stdin_watcher;
960		1104
961	ev_init (&stdin_watcher, my_cb);	1105	ev_init (&stdin_watcher, my_cb);
962	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);	1106	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);
963	ev_io_start (loop, &stdin_watcher);	1107	ev_io_start (loop, &stdin_watcher);
964		1108
965	ev_loop (loop, 0);	1109	ev_run (loop, 0);
966		1110
967	As you can see, you are responsible for allocating the memory for your	1111	As you can see, you are responsible for allocating the memory for your
968	watcher structures (and it is I<usually> a bad idea to do this on the	1112	watcher structures (and it is I<usually> a bad idea to do this on the
969	stack).	1113	stack).
970		1114
971	Each watcher has an associated watcher structure (called C<struct ev_TYPE>	1115	Each watcher has an associated watcher structure (called C<struct ev_TYPE>
972	or simply C<ev_TYPE>, as typedefs are provided for all watcher structs).	1116	or simply C<ev_TYPE>, as typedefs are provided for all watcher structs).
973		1117
974	Each watcher structure must be initialised by a call to C<ev_init	1118	Each watcher structure must be initialised by a call to C<ev_init (watcher
975	(watcher *, callback)>, which expects a callback to be provided. This	1119	*, callback)>, which expects a callback to be provided. This callback is
976	callback gets invoked each time the event occurs (or, in the case of I/O	1120	invoked each time the event occurs (or, in the case of I/O watchers, each
977	watchers, each time the event loop detects that the file descriptor given	1121	time the event loop detects that the file descriptor given is readable
978	is readable and/or writable).	1122	and/or writable).
979		1123
980	Each watcher type further has its own C<< ev_TYPE_set (watcher *, ...) >>	1124	Each watcher type further has its own C<< ev_TYPE_set (watcher *, ...) >>
981	macro to configure it, with arguments specific to the watcher type. There	1125	macro to configure it, with arguments specific to the watcher type. There
982	is also a macro to combine initialisation and setting in one call: C<<	1126	is also a macro to combine initialisation and setting in one call: C<<
983	ev_TYPE_init (watcher *, callback, ...) >>.	1127	ev_TYPE_init (watcher *, callback, ...) >>.
…		…
1006	=item C<EV_WRITE>	1150	=item C<EV_WRITE>
1007		1151
1008	The file descriptor in the C<ev_io> watcher has become readable and/or	1152	The file descriptor in the C<ev_io> watcher has become readable and/or
1009	writable.	1153	writable.
1010		1154
1011	=item C<EV_TIMEOUT>	1155	=item C<EV_TIMER>
1012		1156
1013	The C<ev_timer> watcher has timed out.	1157	The C<ev_timer> watcher has timed out.
1014		1158
1015	=item C<EV_PERIODIC>	1159	=item C<EV_PERIODIC>
1016		1160
…		…
1034		1178
1035	=item C<EV_PREPARE>	1179	=item C<EV_PREPARE>
1036		1180
1037	=item C<EV_CHECK>	1181	=item C<EV_CHECK>
1038		1182
1039	All C<ev_prepare> watchers are invoked just I<before> C<ev_loop> starts	1183	All C<ev_prepare> watchers are invoked just I<before> C<ev_run> starts to
1040	to gather new events, and all C<ev_check> watchers are invoked just after	1184	gather new events, and all C<ev_check> watchers are queued (not invoked)
1041	C<ev_loop> has gathered them, but before it invokes any callbacks for any	1185	just after C<ev_run> has gathered them, but before it queues any callbacks
		1186	for any received events. That means C<ev_prepare> watchers are the last
		1187	watchers invoked before the event loop sleeps or polls for new events, and
		1188	C<ev_check> watchers will be invoked before any other watchers of the same
		1189	or lower priority within an event loop iteration.
		1190
1042	received events. Callbacks of both watcher types can start and stop as	1191	Callbacks of both watcher types can start and stop as many watchers as
1043	many watchers as they want, and all of them will be taken into account	1192	they want, and all of them will be taken into account (for example, a
1044	(for example, a C<ev_prepare> watcher might start an idle watcher to keep	1193	C<ev_prepare> watcher might start an idle watcher to keep C<ev_run> from
1045	C<ev_loop> from blocking).	1194	blocking).
1046		1195
1047	=item C<EV_EMBED>	1196	=item C<EV_EMBED>
1048		1197
1049	The embedded event loop specified in the C<ev_embed> watcher needs attention.	1198	The embedded event loop specified in the C<ev_embed> watcher needs attention.
1050		1199
1051	=item C<EV_FORK>	1200	=item C<EV_FORK>
1052		1201
1053	The event loop has been resumed in the child process after fork (see	1202	The event loop has been resumed in the child process after fork (see
1054	C<ev_fork>).	1203	C<ev_fork>).
		1204
		1205	=item C<EV_CLEANUP>
		1206
		1207	The event loop is about to be destroyed (see C<ev_cleanup>).
1055		1208
1056	=item C<EV_ASYNC>	1209	=item C<EV_ASYNC>
1057		1210
1058	The given async watcher has been asynchronously notified (see C<ev_async>).	1211	The given async watcher has been asynchronously notified (see C<ev_async>).
1059		1212
…		…
1106		1259
1107	ev_io w;	1260	ev_io w;
1108	ev_init (&w, my_cb);	1261	ev_init (&w, my_cb);
1109	ev_io_set (&w, STDIN_FILENO, EV_READ);	1262	ev_io_set (&w, STDIN_FILENO, EV_READ);
1110		1263
1111	=item C<ev_TYPE_set> (ev_TYPE *, [args])	1264	=item C<ev_TYPE_set> (ev_TYPE *watcher, [args])
1112		1265
1113	This macro initialises the type-specific parts of a watcher. You need to	1266	This macro initialises the type-specific parts of a watcher. You need to
1114	call C<ev_init> at least once before you call this macro, but you can	1267	call C<ev_init> at least once before you call this macro, but you can
1115	call C<ev_TYPE_set> any number of times. You must not, however, call this	1268	call C<ev_TYPE_set> any number of times. You must not, however, call this
1116	macro on a watcher that is active (it can be pending, however, which is a	1269	macro on a watcher that is active (it can be pending, however, which is a
…		…
1129		1282
1130	Example: Initialise and set an C<ev_io> watcher in one step.	1283	Example: Initialise and set an C<ev_io> watcher in one step.
1131		1284
1132	ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ);	1285	ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ);
1133		1286
1134	=item C<ev_TYPE_start> (loop *, ev_TYPE *watcher)	1287	=item C<ev_TYPE_start> (loop, ev_TYPE *watcher)
1135		1288
1136	Starts (activates) the given watcher. Only active watchers will receive	1289	Starts (activates) the given watcher. Only active watchers will receive
1137	events. If the watcher is already active nothing will happen.	1290	events. If the watcher is already active nothing will happen.
1138		1291
1139	Example: Start the C<ev_io> watcher that is being abused as example in this	1292	Example: Start the C<ev_io> watcher that is being abused as example in this
1140	whole section.	1293	whole section.
1141		1294
1142	ev_io_start (EV_DEFAULT_UC, &w);	1295	ev_io_start (EV_DEFAULT_UC, &w);
1143		1296
1144	=item C<ev_TYPE_stop> (loop *, ev_TYPE *watcher)	1297	=item C<ev_TYPE_stop> (loop, ev_TYPE *watcher)
1145		1298
1146	Stops the given watcher if active, and clears the pending status (whether	1299	Stops the given watcher if active, and clears the pending status (whether
1147	the watcher was active or not).	1300	the watcher was active or not).
1148		1301
1149	It is possible that stopped watchers are pending - for example,	1302	It is possible that stopped watchers are pending - for example,
…		…
1169		1322
1170	=item callback ev_cb (ev_TYPE *watcher)	1323	=item callback ev_cb (ev_TYPE *watcher)
1171		1324
1172	Returns the callback currently set on the watcher.	1325	Returns the callback currently set on the watcher.
1173		1326
1174	=item ev_cb_set (ev_TYPE *watcher, callback)	1327	=item ev_set_cb (ev_TYPE *watcher, callback)
1175		1328
1176	Change the callback. You can change the callback at virtually any time	1329	Change the callback. You can change the callback at virtually any time
1177	(modulo threads).	1330	(modulo threads).
1178		1331
1179	=item ev_set_priority (ev_TYPE *watcher, priority)	1332	=item ev_set_priority (ev_TYPE *watcher, int priority)
1180		1333
1181	=item int ev_priority (ev_TYPE *watcher)	1334	=item int ev_priority (ev_TYPE *watcher)
1182		1335
1183	Set and query the priority of the watcher. The priority is a small	1336	Set and query the priority of the watcher. The priority is a small
1184	integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>	1337	integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>
…		…
1197	or might not have been clamped to the valid range.	1350	or might not have been clamped to the valid range.
1198		1351
1199	The default priority used by watchers when no priority has been set is	1352	The default priority used by watchers when no priority has been set is
1200	always C<0>, which is supposed to not be too high and not be too low :).	1353	always C<0>, which is supposed to not be too high and not be too low :).
1201		1354
1202	See L<WATCHER PRIORITY MODELS>, below, for a more thorough treatment of	1355	See L</WATCHER PRIORITY MODELS>, below, for a more thorough treatment of
1203	priorities.	1356	priorities.
1204		1357
1205	=item ev_invoke (loop, ev_TYPE *watcher, int revents)	1358	=item ev_invoke (loop, ev_TYPE *watcher, int revents)
1206		1359
1207	Invoke the C<watcher> with the given C<loop> and C<revents>. Neither	1360	Invoke the C<watcher> with the given C<loop> and C<revents>. Neither
…		…
1216	watcher isn't pending it does nothing and returns C<0>.	1369	watcher isn't pending it does nothing and returns C<0>.
1217		1370
1218	Sometimes it can be useful to "poll" a watcher instead of waiting for its	1371	Sometimes it can be useful to "poll" a watcher instead of waiting for its
1219	callback to be invoked, which can be accomplished with this function.	1372	callback to be invoked, which can be accomplished with this function.
1220		1373
		1374	=item ev_feed_event (loop, ev_TYPE *watcher, int revents)
		1375
		1376	Feeds the given event set into the event loop, as if the specified event
		1377	had happened for the specified watcher (which must be a pointer to an
		1378	initialised but not necessarily started event watcher). Obviously you must
		1379	not free the watcher as long as it has pending events.
		1380
		1381	Stopping the watcher, letting libev invoke it, or calling
		1382	C<ev_clear_pending> will clear the pending event, even if the watcher was
		1383	not started in the first place.
		1384
		1385	See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related
		1386	functions that do not need a watcher.
		1387
1221	=back	1388	=back
1222		1389
		1390	See also the L</ASSOCIATING CUSTOM DATA WITH A WATCHER> and L</BUILDING YOUR
		1391	OWN COMPOSITE WATCHERS> idioms.
1223		1392
1224	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER	1393	=head2 WATCHER STATES
1225		1394
1226	Each watcher has, by default, a member C<void *data> that you can change	1395	There are various watcher states mentioned throughout this manual -
1227	and read at any time: libev will completely ignore it. This can be used	1396	active, pending and so on. In this section these states and the rules to
1228	to associate arbitrary data with your watcher. If you need more data and	1397	transition between them will be described in more detail - and while these
1229	don't want to allocate memory and store a pointer to it in that data	1398	rules might look complicated, they usually do "the right thing".
1230	member, you can also "subclass" the watcher type and provide your own
1231	data:
1232		1399
1233	struct my_io	1400	=over 4
1234	{
1235	ev_io io;
1236	int otherfd;
1237	void *somedata;
1238	struct whatever *mostinteresting;
1239	};
1240		1401
1241	...	1402	=item initialised
1242	struct my_io w;
1243	ev_io_init (&w.io, my_cb, fd, EV_READ);
1244		1403
1245	And since your callback will be called with a pointer to the watcher, you	1404	Before a watcher can be registered with the event loop it has to be
1246	can cast it back to your own type:	1405	initialised. This can be done with a call to C<ev_TYPE_init>, or calls to
		1406	C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function.
1247		1407
1248	static void my_cb (struct ev_loop *loop, ev_io *w_, int revents)	1408	In this state it is simply some block of memory that is suitable for
1249	{	1409	use in an event loop. It can be moved around, freed, reused etc. at
1250	struct my_io *w = (struct my_io *)w_;	1410	will - as long as you either keep the memory contents intact, or call
1251	...	1411	C<ev_TYPE_init> again.
1252	}
1253		1412
1254	More interesting and less C-conformant ways of casting your callback type	1413	=item started/running/active
1255	instead have been omitted.
1256		1414
1257	Another common scenario is to use some data structure with multiple	1415	Once a watcher has been started with a call to C<ev_TYPE_start> it becomes
1258	embedded watchers:	1416	property of the event loop, and is actively waiting for events. While in
		1417	this state it cannot be accessed (except in a few documented ways), moved,
		1418	freed or anything else - the only legal thing is to keep a pointer to it,
		1419	and call libev functions on it that are documented to work on active watchers.
1259		1420
1260	struct my_biggy	1421	=item pending
1261	{
1262	int some_data;
1263	ev_timer t1;
1264	ev_timer t2;
1265	}
1266		1422
1267	In this case getting the pointer to C<my_biggy> is a bit more	1423	If a watcher is active and libev determines that an event it is interested
1268	complicated: Either you store the address of your C<my_biggy> struct	1424	in has occurred (such as a timer expiring), it will become pending. It will
1269	in the C<data> member of the watcher (for woozies), or you need to use	1425	stay in this pending state until either it is stopped or its callback is
1270	some pointer arithmetic using C<offsetof> inside your watchers (for real	1426	about to be invoked, so it is not normally pending inside the watcher
1271	programmers):	1427	callback.
1272		1428
1273	#include <stddef.h>	1429	The watcher might or might not be active while it is pending (for example,
		1430	an expired non-repeating timer can be pending but no longer active). If it
		1431	is stopped, it can be freely accessed (e.g. by calling C<ev_TYPE_set>),
		1432	but it is still property of the event loop at this time, so cannot be
		1433	moved, freed or reused. And if it is active the rules described in the
		1434	previous item still apply.
1274		1435
1275	static void	1436	It is also possible to feed an event on a watcher that is not active (e.g.
1276	t1_cb (EV_P_ ev_timer *w, int revents)	1437	via C<ev_feed_event>), in which case it becomes pending without being
1277	{	1438	active.
1278	struct my_biggy big = (struct my_biggy *)
1279	(((char *)w) - offsetof (struct my_biggy, t1));
1280	}
1281		1439
1282	static void	1440	=item stopped
1283	t2_cb (EV_P_ ev_timer *w, int revents)	1441
1284	{	1442	A watcher can be stopped implicitly by libev (in which case it might still
1285	struct my_biggy big = (struct my_biggy *)	1443	be pending), or explicitly by calling its C<ev_TYPE_stop> function. The
1286	(((char *)w) - offsetof (struct my_biggy, t2));	1444	latter will clear any pending state the watcher might be in, regardless
1287	}	1445	of whether it was active or not, so stopping a watcher explicitly before
		1446	freeing it is often a good idea.
		1447
		1448	While stopped (and not pending) the watcher is essentially in the
		1449	initialised state, that is, it can be reused, moved, modified in any way
		1450	you wish (but when you trash the memory block, you need to C<ev_TYPE_init>
		1451	it again).
		1452
		1453	=back
1288		1454
1289	=head2 WATCHER PRIORITY MODELS	1455	=head2 WATCHER PRIORITY MODELS
1290		1456
1291	Many event loops support I<watcher priorities>, which are usually small	1457	Many event loops support I<watcher priorities>, which are usually small
1292	integers that influence the ordering of event callback invocation	1458	integers that influence the ordering of event callback invocation
…		…
1335		1501
1336	For example, to emulate how many other event libraries handle priorities,	1502	For example, to emulate how many other event libraries handle priorities,
1337	you can associate an C<ev_idle> watcher to each such watcher, and in	1503	you can associate an C<ev_idle> watcher to each such watcher, and in
1338	the normal watcher callback, you just start the idle watcher. The real	1504	the normal watcher callback, you just start the idle watcher. The real
1339	processing is done in the idle watcher callback. This causes libev to	1505	processing is done in the idle watcher callback. This causes libev to
1340	continously poll and process kernel event data for the watcher, but when	1506	continuously poll and process kernel event data for the watcher, but when
1341	the lock-out case is known to be rare (which in turn is rare :), this is	1507	the lock-out case is known to be rare (which in turn is rare :), this is
1342	workable.	1508	workable.
1343		1509
1344	Usually, however, the lock-out model implemented that way will perform	1510	Usually, however, the lock-out model implemented that way will perform
1345	miserably under the type of load it was designed to handle. In that case,	1511	miserably under the type of load it was designed to handle. In that case,
…		…
1359	{	1525	{
1360	// stop the I/O watcher, we received the event, but	1526	// stop the I/O watcher, we received the event, but
1361	// are not yet ready to handle it.	1527	// are not yet ready to handle it.
1362	ev_io_stop (EV_A_ w);	1528	ev_io_stop (EV_A_ w);
1363		1529
1364	// start the idle watcher to ahndle the actual event.	1530	// start the idle watcher to handle the actual event.
1365	// it will not be executed as long as other watchers	1531	// it will not be executed as long as other watchers
1366	// with the default priority are receiving events.	1532	// with the default priority are receiving events.
1367	ev_idle_start (EV_A_ &idle);	1533	ev_idle_start (EV_A_ &idle);
1368	}	1534	}
1369		1535
…		…
1419	In general you can register as many read and/or write event watchers per	1585	In general you can register as many read and/or write event watchers per
1420	fd as you want (as long as you don't confuse yourself). Setting all file	1586	fd as you want (as long as you don't confuse yourself). Setting all file
1421	descriptors to non-blocking mode is also usually a good idea (but not	1587	descriptors to non-blocking mode is also usually a good idea (but not
1422	required if you know what you are doing).	1588	required if you know what you are doing).
1423		1589
1424	If you cannot use non-blocking mode, then force the use of a
1425	known-to-be-good backend (at the time of this writing, this includes only
1426	C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>). The same applies to file
1427	descriptors for which non-blocking operation makes no sense (such as
1428	files) - libev doesn't guarentee any specific behaviour in that case.
1429
1430	Another thing you have to watch out for is that it is quite easy to	1590	Another thing you have to watch out for is that it is quite easy to
1431	receive "spurious" readiness notifications, that is your callback might	1591	receive "spurious" readiness notifications, that is, your callback might
1432	be called with C<EV_READ> but a subsequent C<read>(2) will actually block	1592	be called with C<EV_READ> but a subsequent C<read>(2) will actually block
1433	because there is no data. Not only are some backends known to create a	1593	because there is no data. It is very easy to get into this situation even
1434	lot of those (for example Solaris ports), it is very easy to get into	1594	with a relatively standard program structure. Thus it is best to always
1435	this situation even with a relatively standard program structure. Thus	1595	use non-blocking I/O: An extra C<read>(2) returning C<EAGAIN> is far
1436	it is best to always use non-blocking I/O: An extra C<read>(2) returning
1437	C<EAGAIN> is far preferable to a program hanging until some data arrives.	1596	preferable to a program hanging until some data arrives.
1438		1597
1439	If you cannot run the fd in non-blocking mode (for example you should	1598	If you cannot run the fd in non-blocking mode (for example you should
1440	not play around with an Xlib connection), then you have to separately	1599	not play around with an Xlib connection), then you have to separately
1441	re-test whether a file descriptor is really ready with a known-to-be good	1600	re-test whether a file descriptor is really ready with a known-to-be good
1442	interface such as poll (fortunately in our Xlib example, Xlib already	1601	interface such as poll (fortunately in the case of Xlib, it already does
1443	does this on its own, so its quite safe to use). Some people additionally	1602	this on its own, so its quite safe to use). Some people additionally
1444	use C<SIGALRM> and an interval timer, just to be sure you won't block	1603	use C<SIGALRM> and an interval timer, just to be sure you won't block
1445	indefinitely.	1604	indefinitely.
1446		1605
1447	But really, best use non-blocking mode.	1606	But really, best use non-blocking mode.
1448		1607
…		…
1476		1635
1477	There is no workaround possible except not registering events	1636	There is no workaround possible except not registering events
1478	for potentially C<dup ()>'ed file descriptors, or to resort to	1637	for potentially C<dup ()>'ed file descriptors, or to resort to
1479	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.	1638	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1480		1639
		1640	=head3 The special problem of files
		1641
		1642	Many people try to use C<select> (or libev) on file descriptors
		1643	representing files, and expect it to become ready when their program
		1644	doesn't block on disk accesses (which can take a long time on their own).
		1645
		1646	However, this cannot ever work in the "expected" way - you get a readiness
		1647	notification as soon as the kernel knows whether and how much data is
		1648	there, and in the case of open files, that's always the case, so you
		1649	always get a readiness notification instantly, and your read (or possibly
		1650	write) will still block on the disk I/O.
		1651
		1652	Another way to view it is that in the case of sockets, pipes, character
		1653	devices and so on, there is another party (the sender) that delivers data
		1654	on its own, but in the case of files, there is no such thing: the disk
		1655	will not send data on its own, simply because it doesn't know what you
		1656	wish to read - you would first have to request some data.
		1657
		1658	Since files are typically not-so-well supported by advanced notification
		1659	mechanism, libev tries hard to emulate POSIX behaviour with respect
		1660	to files, even though you should not use it. The reason for this is
		1661	convenience: sometimes you want to watch STDIN or STDOUT, which is
		1662	usually a tty, often a pipe, but also sometimes files or special devices
		1663	(for example, C<epoll> on Linux works with F</dev/random> but not with
		1664	F</dev/urandom>), and even though the file might better be served with
		1665	asynchronous I/O instead of with non-blocking I/O, it is still useful when
		1666	it "just works" instead of freezing.
		1667
		1668	So avoid file descriptors pointing to files when you know it (e.g. use
		1669	libeio), but use them when it is convenient, e.g. for STDIN/STDOUT, or
		1670	when you rarely read from a file instead of from a socket, and want to
		1671	reuse the same code path.
		1672
1481	=head3 The special problem of fork	1673	=head3 The special problem of fork
1482		1674
1483	Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit	1675	Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit
1484	useless behaviour. Libev fully supports fork, but needs to be told about	1676	useless behaviour. Libev fully supports fork, but needs to be told about
1485	it in the child.	1677	it in the child if you want to continue to use it in the child.
1486		1678
1487	To support fork in your programs, you either have to call	1679	To support fork in your child processes, you have to call C<ev_loop_fork
1488	C<ev_default_fork ()> or C<ev_loop_fork ()> after a fork in the child,	1680	()> after a fork in the child, enable C<EVFLAG_FORKCHECK>, or resort to
1489	enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or	1681	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1490	C<EVBACKEND_POLL>.
1491		1682
1492	=head3 The special problem of SIGPIPE	1683	=head3 The special problem of SIGPIPE
1493		1684
1494	While not really specific to libev, it is easy to forget about C<SIGPIPE>:	1685	While not really specific to libev, it is easy to forget about C<SIGPIPE>:
1495	when writing to a pipe whose other end has been closed, your program gets	1686	when writing to a pipe whose other end has been closed, your program gets
…		…
1498		1689
1499	So when you encounter spurious, unexplained daemon exits, make sure you	1690	So when you encounter spurious, unexplained daemon exits, make sure you
1500	ignore SIGPIPE (and maybe make sure you log the exit status of your daemon	1691	ignore SIGPIPE (and maybe make sure you log the exit status of your daemon
1501	somewhere, as that would have given you a big clue).	1692	somewhere, as that would have given you a big clue).
1502		1693
		1694	=head3 The special problem of accept()ing when you can't
		1695
		1696	Many implementations of the POSIX C<accept> function (for example,
		1697	found in post-2004 Linux) have the peculiar behaviour of not removing a
		1698	connection from the pending queue in all error cases.
		1699
		1700	For example, larger servers often run out of file descriptors (because
		1701	of resource limits), causing C<accept> to fail with C<ENFILE> but not
		1702	rejecting the connection, leading to libev signalling readiness on
		1703	the next iteration again (the connection still exists after all), and
		1704	typically causing the program to loop at 100% CPU usage.
		1705
		1706	Unfortunately, the set of errors that cause this issue differs between
		1707	operating systems, there is usually little the app can do to remedy the
		1708	situation, and no known thread-safe method of removing the connection to
		1709	cope with overload is known (to me).
		1710
		1711	One of the easiest ways to handle this situation is to just ignore it
		1712	- when the program encounters an overload, it will just loop until the
		1713	situation is over. While this is a form of busy waiting, no OS offers an
		1714	event-based way to handle this situation, so it's the best one can do.
		1715
		1716	A better way to handle the situation is to log any errors other than
		1717	C<EAGAIN> and C<EWOULDBLOCK>, making sure not to flood the log with such
		1718	messages, and continue as usual, which at least gives the user an idea of
		1719	what could be wrong ("raise the ulimit!"). For extra points one could stop
		1720	the C<ev_io> watcher on the listening fd "for a while", which reduces CPU
		1721	usage.
		1722
		1723	If your program is single-threaded, then you could also keep a dummy file
		1724	descriptor for overload situations (e.g. by opening F</dev/null>), and
		1725	when you run into C<ENFILE> or C<EMFILE>, close it, run C<accept>,
		1726	close that fd, and create a new dummy fd. This will gracefully refuse
		1727	clients under typical overload conditions.
		1728
		1729	The last way to handle it is to simply log the error and C<exit>, as
		1730	is often done with C<malloc> failures, but this results in an easy
		1731	opportunity for a DoS attack.
1503		1732
1504	=head3 Watcher-Specific Functions	1733	=head3 Watcher-Specific Functions
1505		1734
1506	=over 4	1735	=over 4
1507		1736
…		…
1539	...	1768	...
1540	struct ev_loop *loop = ev_default_init (0);	1769	struct ev_loop *loop = ev_default_init (0);
1541	ev_io stdin_readable;	1770	ev_io stdin_readable;
1542	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);	1771	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);
1543	ev_io_start (loop, &stdin_readable);	1772	ev_io_start (loop, &stdin_readable);
1544	ev_loop (loop, 0);	1773	ev_run (loop, 0);
1545		1774
1546		1775
1547	=head2 C<ev_timer> - relative and optionally repeating timeouts	1776	=head2 C<ev_timer> - relative and optionally repeating timeouts
1548		1777
1549	Timer watchers are simple relative timers that generate an event after a	1778	Timer watchers are simple relative timers that generate an event after a
…		…
1555	detecting time jumps is hard, and some inaccuracies are unavoidable (the	1784	detecting time jumps is hard, and some inaccuracies are unavoidable (the
1556	monotonic clock option helps a lot here).	1785	monotonic clock option helps a lot here).
1557		1786
1558	The callback is guaranteed to be invoked only I<after> its timeout has	1787	The callback is guaranteed to be invoked only I<after> its timeout has
1559	passed (not I<at>, so on systems with very low-resolution clocks this	1788	passed (not I<at>, so on systems with very low-resolution clocks this
1560	might introduce a small delay). If multiple timers become ready during the	1789	might introduce a small delay, see "the special problem of being too
		1790	early", below). If multiple timers become ready during the same loop
1561	same loop iteration then the ones with earlier time-out values are invoked	1791	iteration then the ones with earlier time-out values are invoked before
1562	before ones of the same priority with later time-out values (but this is	1792	ones of the same priority with later time-out values (but this is no
1563	no longer true when a callback calls C<ev_loop> recursively).	1793	longer true when a callback calls C<ev_run> recursively).
1564		1794
1565	=head3 Be smart about timeouts	1795	=head3 Be smart about timeouts
1566		1796
1567	Many real-world problems involve some kind of timeout, usually for error	1797	Many real-world problems involve some kind of timeout, usually for error
1568	recovery. A typical example is an HTTP request - if the other side hangs,	1798	recovery. A typical example is an HTTP request - if the other side hangs,
…		…
1643		1873
1644	In this case, it would be more efficient to leave the C<ev_timer> alone,	1874	In this case, it would be more efficient to leave the C<ev_timer> alone,
1645	but remember the time of last activity, and check for a real timeout only	1875	but remember the time of last activity, and check for a real timeout only
1646	within the callback:	1876	within the callback:
1647		1877
		1878	ev_tstamp timeout = 60.;
1648	ev_tstamp last_activity; // time of last activity	1879	ev_tstamp last_activity; // time of last activity
		1880	ev_timer timer;
1649		1881
1650	static void	1882	static void
1651	callback (EV_P_ ev_timer *w, int revents)	1883	callback (EV_P_ ev_timer *w, int revents)
1652	{	1884	{
1653	ev_tstamp now = ev_now (EV_A);	1885	// calculate when the timeout would happen
1654	ev_tstamp timeout = last_activity + 60.;	1886	ev_tstamp after = last_activity - ev_now (EV_A) + timeout;
1655		1887
1656	// if last_activity + 60. is older than now, we did time out	1888	// if negative, it means we the timeout already occurred
1657	if (timeout < now)	1889	if (after < 0.)
1658	{	1890	{
1659	// timeout occured, take action	1891	// timeout occurred, take action
1660	}	1892	}
1661	else	1893	else
1662	{	1894	{
1663	// callback was invoked, but there was some activity, re-arm	1895	// callback was invoked, but there was some recent
1664	// the watcher to fire in last_activity + 60, which is	1896	// activity. simply restart the timer to time out
1665	// guaranteed to be in the future, so "again" is positive:	1897	// after "after" seconds, which is the earliest time
1666	w->repeat = timeout - now;	1898	// the timeout can occur.
		1899	ev_timer_set (w, after, 0.);
1667	ev_timer_again (EV_A_ w);	1900	ev_timer_start (EV_A_ w);
1668	}	1901	}
1669	}	1902	}
1670		1903
1671	To summarise the callback: first calculate the real timeout (defined	1904	To summarise the callback: first calculate in how many seconds the
1672	as "60 seconds after the last activity"), then check if that time has	1905	timeout will occur (by calculating the absolute time when it would occur,
1673	been reached, which means something I<did>, in fact, time out. Otherwise	1906	C<last_activity + timeout>, and subtracting the current time, C<ev_now
1674	the callback was invoked too early (C<timeout> is in the future), so	1907	(EV_A)> from that).
1675	re-schedule the timer to fire at that future time, to see if maybe we have
1676	a timeout then.
1677		1908
1678	Note how C<ev_timer_again> is used, taking advantage of the	1909	If this value is negative, then we are already past the timeout, i.e. we
1679	C<ev_timer_again> optimisation when the timer is already running.	1910	timed out, and need to do whatever is needed in this case.
		1911
		1912	Otherwise, we now the earliest time at which the timeout would trigger,
		1913	and simply start the timer with this timeout value.
		1914
		1915	In other words, each time the callback is invoked it will check whether
		1916	the timeout occurred. If not, it will simply reschedule itself to check
		1917	again at the earliest time it could time out. Rinse. Repeat.
1680		1918
1681	This scheme causes more callback invocations (about one every 60 seconds	1919	This scheme causes more callback invocations (about one every 60 seconds
1682	minus half the average time between activity), but virtually no calls to	1920	minus half the average time between activity), but virtually no calls to
1683	libev to change the timeout.	1921	libev to change the timeout.
1684		1922
1685	To start the timer, simply initialise the watcher and set C<last_activity>	1923	To start the machinery, simply initialise the watcher and set
1686	to the current time (meaning we just have some activity :), then call the	1924	C<last_activity> to the current time (meaning there was some activity just
1687	callback, which will "do the right thing" and start the timer:	1925	now), then call the callback, which will "do the right thing" and start
		1926	the timer:
1688		1927
		1928	last_activity = ev_now (EV_A);
1689	ev_init (timer, callback);	1929	ev_init (&timer, callback);
1690	last_activity = ev_now (loop);	1930	callback (EV_A_ &timer, 0);
1691	callback (loop, timer, EV_TIMEOUT);
1692		1931
1693	And when there is some activity, simply store the current time in	1932	When there is some activity, simply store the current time in
1694	C<last_activity>, no libev calls at all:	1933	C<last_activity>, no libev calls at all:
1695		1934
		1935	if (activity detected)
1696	last_actiivty = ev_now (loop);	1936	last_activity = ev_now (EV_A);
		1937
		1938	When your timeout value changes, then the timeout can be changed by simply
		1939	providing a new value, stopping the timer and calling the callback, which
		1940	will again do the right thing (for example, time out immediately :).
		1941
		1942	timeout = new_value;
		1943	ev_timer_stop (EV_A_ &timer);
		1944	callback (EV_A_ &timer, 0);
1697		1945
1698	This technique is slightly more complex, but in most cases where the	1946	This technique is slightly more complex, but in most cases where the
1699	time-out is unlikely to be triggered, much more efficient.	1947	time-out is unlikely to be triggered, much more efficient.
1700
1701	Changing the timeout is trivial as well (if it isn't hard-coded in the
1702	callback :) - just change the timeout and invoke the callback, which will
1703	fix things for you.
1704		1948
1705	=item 4. Wee, just use a double-linked list for your timeouts.	1949	=item 4. Wee, just use a double-linked list for your timeouts.
1706		1950
1707	If there is not one request, but many thousands (millions...), all	1951	If there is not one request, but many thousands (millions...), all
1708	employing some kind of timeout with the same timeout value, then one can	1952	employing some kind of timeout with the same timeout value, then one can
…		…
1735	Method #1 is almost always a bad idea, and buys you nothing. Method #4 is	1979	Method #1 is almost always a bad idea, and buys you nothing. Method #4 is
1736	rather complicated, but extremely efficient, something that really pays	1980	rather complicated, but extremely efficient, something that really pays
1737	off after the first million or so of active timers, i.e. it's usually	1981	off after the first million or so of active timers, i.e. it's usually
1738	overkill :)	1982	overkill :)
1739		1983
		1984	=head3 The special problem of being too early
		1985
		1986	If you ask a timer to call your callback after three seconds, then
		1987	you expect it to be invoked after three seconds - but of course, this
		1988	cannot be guaranteed to infinite precision. Less obviously, it cannot be
		1989	guaranteed to any precision by libev - imagine somebody suspending the
		1990	process with a STOP signal for a few hours for example.
		1991
		1992	So, libev tries to invoke your callback as soon as possible I<after> the
		1993	delay has occurred, but cannot guarantee this.
		1994
		1995	A less obvious failure mode is calling your callback too early: many event
		1996	loops compare timestamps with a "elapsed delay >= requested delay", but
		1997	this can cause your callback to be invoked much earlier than you would
		1998	expect.
		1999
		2000	To see why, imagine a system with a clock that only offers full second
		2001	resolution (think windows if you can't come up with a broken enough OS
		2002	yourself). If you schedule a one-second timer at the time 500.9, then the
		2003	event loop will schedule your timeout to elapse at a system time of 500
		2004	(500.9 truncated to the resolution) + 1, or 501.
		2005
		2006	If an event library looks at the timeout 0.1s later, it will see "501 >=
		2007	501" and invoke the callback 0.1s after it was started, even though a
		2008	one-second delay was requested - this is being "too early", despite best
		2009	intentions.
		2010
		2011	This is the reason why libev will never invoke the callback if the elapsed
		2012	delay equals the requested delay, but only when the elapsed delay is
		2013	larger than the requested delay. In the example above, libev would only invoke
		2014	the callback at system time 502, or 1.1s after the timer was started.
		2015
		2016	So, while libev cannot guarantee that your callback will be invoked
		2017	exactly when requested, it I<can> and I<does> guarantee that the requested
		2018	delay has actually elapsed, or in other words, it always errs on the "too
		2019	late" side of things.
		2020
1740	=head3 The special problem of time updates	2021	=head3 The special problem of time updates
1741		2022
1742	Establishing the current time is a costly operation (it usually takes at	2023	Establishing the current time is a costly operation (it usually takes
1743	least two system calls): EV therefore updates its idea of the current	2024	at least one system call): EV therefore updates its idea of the current
1744	time only before and after C<ev_loop> collects new events, which causes a	2025	time only before and after C<ev_run> collects new events, which causes a
1745	growing difference between C<ev_now ()> and C<ev_time ()> when handling	2026	growing difference between C<ev_now ()> and C<ev_time ()> when handling
1746	lots of events in one iteration.	2027	lots of events in one iteration.
1747		2028
1748	The relative timeouts are calculated relative to the C<ev_now ()>	2029	The relative timeouts are calculated relative to the C<ev_now ()>
1749	time. This is usually the right thing as this timestamp refers to the time	2030	time. This is usually the right thing as this timestamp refers to the time
…		…
1755		2036
1756	If the event loop is suspended for a long time, you can also force an	2037	If the event loop is suspended for a long time, you can also force an
1757	update of the time returned by C<ev_now ()> by calling C<ev_now_update	2038	update of the time returned by C<ev_now ()> by calling C<ev_now_update
1758	()>.	2039	()>.
1759		2040
		2041	=head3 The special problem of unsynchronised clocks
		2042
		2043	Modern systems have a variety of clocks - libev itself uses the normal
		2044	"wall clock" clock and, if available, the monotonic clock (to avoid time
		2045	jumps).
		2046
		2047	Neither of these clocks is synchronised with each other or any other clock
		2048	on the system, so C<ev_time ()> might return a considerably different time
		2049	than C<gettimeofday ()> or C<time ()>. On a GNU/Linux system, for example,
		2050	a call to C<gettimeofday> might return a second count that is one higher
		2051	than a directly following call to C<time>.
		2052
		2053	The moral of this is to only compare libev-related timestamps with
		2054	C<ev_time ()> and C<ev_now ()>, at least if you want better precision than
		2055	a second or so.
		2056
		2057	One more problem arises due to this lack of synchronisation: if libev uses
		2058	the system monotonic clock and you compare timestamps from C<ev_time>
		2059	or C<ev_now> from when you started your timer and when your callback is
		2060	invoked, you will find that sometimes the callback is a bit "early".
		2061
		2062	This is because C<ev_timer>s work in real time, not wall clock time, so
		2063	libev makes sure your callback is not invoked before the delay happened,
		2064	I<measured according to the real time>, not the system clock.
		2065
		2066	If your timeouts are based on a physical timescale (e.g. "time out this
		2067	connection after 100 seconds") then this shouldn't bother you as it is
		2068	exactly the right behaviour.
		2069
		2070	If you want to compare wall clock/system timestamps to your timers, then
		2071	you need to use C<ev_periodic>s, as these are based on the wall clock
		2072	time, where your comparisons will always generate correct results.
		2073
		2074	=head3 The special problems of suspended animation
		2075
		2076	When you leave the server world it is quite customary to hit machines that
		2077	can suspend/hibernate - what happens to the clocks during such a suspend?
		2078
		2079	Some quick tests made with a Linux 2.6.28 indicate that a suspend freezes
		2080	all processes, while the clocks (C<times>, C<CLOCK_MONOTONIC>) continue
		2081	to run until the system is suspended, but they will not advance while the
		2082	system is suspended. That means, on resume, it will be as if the program
		2083	was frozen for a few seconds, but the suspend time will not be counted
		2084	towards C<ev_timer> when a monotonic clock source is used. The real time
		2085	clock advanced as expected, but if it is used as sole clocksource, then a
		2086	long suspend would be detected as a time jump by libev, and timers would
		2087	be adjusted accordingly.
		2088
		2089	I would not be surprised to see different behaviour in different between
		2090	operating systems, OS versions or even different hardware.
		2091
		2092	The other form of suspend (job control, or sending a SIGSTOP) will see a
		2093	time jump in the monotonic clocks and the realtime clock. If the program
		2094	is suspended for a very long time, and monotonic clock sources are in use,
		2095	then you can expect C<ev_timer>s to expire as the full suspension time
		2096	will be counted towards the timers. When no monotonic clock source is in
		2097	use, then libev will again assume a timejump and adjust accordingly.
		2098
		2099	It might be beneficial for this latter case to call C<ev_suspend>
		2100	and C<ev_resume> in code that handles C<SIGTSTP>, to at least get
		2101	deterministic behaviour in this case (you can do nothing against
		2102	C<SIGSTOP>).
		2103
1760	=head3 Watcher-Specific Functions and Data Members	2104	=head3 Watcher-Specific Functions and Data Members
1761		2105
1762	=over 4	2106	=over 4
1763		2107
1764	=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)	2108	=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
…		…
1777	keep up with the timer (because it takes longer than those 10 seconds to	2121	keep up with the timer (because it takes longer than those 10 seconds to
1778	do stuff) the timer will not fire more than once per event loop iteration.	2122	do stuff) the timer will not fire more than once per event loop iteration.
1779		2123
1780	=item ev_timer_again (loop, ev_timer *)	2124	=item ev_timer_again (loop, ev_timer *)
1781		2125
1782	This will act as if the timer timed out and restart it again if it is	2126	This will act as if the timer timed out, and restarts it again if it is
1783	repeating. The exact semantics are:	2127	repeating. It basically works like calling C<ev_timer_stop>, updating the
		2128	timeout to the C<repeat> value and calling C<ev_timer_start>.
1784		2129
		2130	The exact semantics are as in the following rules, all of which will be
		2131	applied to the watcher:
		2132
		2133	=over 4
		2134
1785	If the timer is pending, its pending status is cleared.	2135	=item If the timer is pending, the pending status is always cleared.
1786		2136
1787	If the timer is started but non-repeating, stop it (as if it timed out).	2137	=item If the timer is started but non-repeating, stop it (as if it timed
		2138	out, without invoking it).
1788		2139
1789	If the timer is repeating, either start it if necessary (with the	2140	=item If the timer is repeating, make the C<repeat> value the new timeout
1790	C<repeat> value), or reset the running timer to the C<repeat> value.	2141	and start the timer, if necessary.
1791		2142
		2143	=back
		2144
1792	This sounds a bit complicated, see L<Be smart about timeouts>, above, for a	2145	This sounds a bit complicated, see L</Be smart about timeouts>, above, for a
1793	usage example.	2146	usage example.
		2147
		2148	=item ev_tstamp ev_timer_remaining (loop, ev_timer *)
		2149
		2150	Returns the remaining time until a timer fires. If the timer is active,
		2151	then this time is relative to the current event loop time, otherwise it's
		2152	the timeout value currently configured.
		2153
		2154	That is, after an C<ev_timer_set (w, 5, 7)>, C<ev_timer_remaining> returns
		2155	C<5>. When the timer is started and one second passes, C<ev_timer_remaining>
		2156	will return C<4>. When the timer expires and is restarted, it will return
		2157	roughly C<7> (likely slightly less as callback invocation takes some time,
		2158	too), and so on.
1794		2159
1795	=item ev_tstamp repeat [read-write]	2160	=item ev_tstamp repeat [read-write]
1796		2161
1797	The current C<repeat> value. Will be used each time the watcher times out	2162	The current C<repeat> value. Will be used each time the watcher times out
1798	or C<ev_timer_again> is called, and determines the next timeout (if any),	2163	or C<ev_timer_again> is called, and determines the next timeout (if any),
…		…
1824	}	2189	}
1825		2190
1826	ev_timer mytimer;	2191	ev_timer mytimer;
1827	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */	2192	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */
1828	ev_timer_again (&mytimer); /* start timer */	2193	ev_timer_again (&mytimer); /* start timer */
1829	ev_loop (loop, 0);	2194	ev_run (loop, 0);
1830		2195
1831	// and in some piece of code that gets executed on any "activity":	2196	// and in some piece of code that gets executed on any "activity":
1832	// reset the timeout to start ticking again at 10 seconds	2197	// reset the timeout to start ticking again at 10 seconds
1833	ev_timer_again (&mytimer);	2198	ev_timer_again (&mytimer);
1834		2199
…		…
1860		2225
1861	As with timers, the callback is guaranteed to be invoked only when the	2226	As with timers, the callback is guaranteed to be invoked only when the
1862	point in time where it is supposed to trigger has passed. If multiple	2227	point in time where it is supposed to trigger has passed. If multiple
1863	timers become ready during the same loop iteration then the ones with	2228	timers become ready during the same loop iteration then the ones with
1864	earlier time-out values are invoked before ones with later time-out values	2229	earlier time-out values are invoked before ones with later time-out values
1865	(but this is no longer true when a callback calls C<ev_loop> recursively).	2230	(but this is no longer true when a callback calls C<ev_run> recursively).
1866		2231
1867	=head3 Watcher-Specific Functions and Data Members	2232	=head3 Watcher-Specific Functions and Data Members
1868		2233
1869	=over 4	2234	=over 4
1870		2235
…		…
1905		2270
1906	Another way to think about it (for the mathematically inclined) is that	2271	Another way to think about it (for the mathematically inclined) is that
1907	C<ev_periodic> will try to run the callback in this mode at the next possible	2272	C<ev_periodic> will try to run the callback in this mode at the next possible
1908	time where C<time = offset (mod interval)>, regardless of any time jumps.	2273	time where C<time = offset (mod interval)>, regardless of any time jumps.
1909		2274
1910	For numerical stability it is preferable that the C<offset> value is near	2275	The C<interval> I<MUST> be positive, and for numerical stability, the
1911	C<ev_now ()> (the current time), but there is no range requirement for	2276	interval value should be higher than C<1/8192> (which is around 100
1912	this value, and in fact is often specified as zero.	2277	microseconds) and C<offset> should be higher than C<0> and should have
		2278	at most a similar magnitude as the current time (say, within a factor of
		2279	ten). Typical values for offset are, in fact, C<0> or something between
		2280	C<0> and C<interval>, which is also the recommended range.
1913		2281
1914	Note also that there is an upper limit to how often a timer can fire (CPU	2282	Note also that there is an upper limit to how often a timer can fire (CPU
1915	speed for example), so if C<interval> is very small then timing stability	2283	speed for example), so if C<interval> is very small then timing stability
1916	will of course deteriorate. Libev itself tries to be exact to be about one	2284	will of course deteriorate. Libev itself tries to be exact to be about one
1917	millisecond (if the OS supports it and the machine is fast enough).	2285	millisecond (if the OS supports it and the machine is fast enough).
…		…
1998	Example: Call a callback every hour, or, more precisely, whenever the	2366	Example: Call a callback every hour, or, more precisely, whenever the
1999	system time is divisible by 3600. The callback invocation times have	2367	system time is divisible by 3600. The callback invocation times have
2000	potentially a lot of jitter, but good long-term stability.	2368	potentially a lot of jitter, but good long-term stability.
2001		2369
2002	static void	2370	static void
2003	clock_cb (struct ev_loop *loop, ev_io *w, int revents)	2371	clock_cb (struct ev_loop *loop, ev_periodic *w, int revents)
2004	{	2372	{
2005	... its now a full hour (UTC, or TAI or whatever your clock follows)	2373	... its now a full hour (UTC, or TAI or whatever your clock follows)
2006	}	2374	}
2007		2375
2008	ev_periodic hourly_tick;	2376	ev_periodic hourly_tick;
…		…
2031		2399
2032	=head2 C<ev_signal> - signal me when a signal gets signalled!	2400	=head2 C<ev_signal> - signal me when a signal gets signalled!
2033		2401
2034	Signal watchers will trigger an event when the process receives a specific	2402	Signal watchers will trigger an event when the process receives a specific
2035	signal one or more times. Even though signals are very asynchronous, libev	2403	signal one or more times. Even though signals are very asynchronous, libev
2036	will try it's best to deliver signals synchronously, i.e. as part of the	2404	will try its best to deliver signals synchronously, i.e. as part of the
2037	normal event processing, like any other event.	2405	normal event processing, like any other event.
2038		2406
2039	If you want signals asynchronously, just use C<sigaction> as you would	2407	If you want signals to be delivered truly asynchronously, just use
2040	do without libev and forget about sharing the signal. You can even use	2408	C<sigaction> as you would do without libev and forget about sharing
2041	C<ev_async> from a signal handler to synchronously wake up an event loop.	2409	the signal. You can even use C<ev_async> from a signal handler to
		2410	synchronously wake up an event loop.
2042		2411
2043	You can configure as many watchers as you like per signal. Only when the	2412	You can configure as many watchers as you like for the same signal, but
2044	first watcher gets started will libev actually register a signal handler	2413	only within the same loop, i.e. you can watch for C<SIGINT> in your
2045	with the kernel (thus it coexists with your own signal handlers as long as	2414	default loop and for C<SIGIO> in another loop, but you cannot watch for
2046	you don't register any with libev for the same signal). Similarly, when	2415	C<SIGINT> in both the default loop and another loop at the same time. At
2047	the last signal watcher for a signal is stopped, libev will reset the	2416	the moment, C<SIGCHLD> is permanently tied to the default loop.
2048	signal handler to SIG_DFL (regardless of what it was set to before).	2417
		2418	Only after the first watcher for a signal is started will libev actually
		2419	register something with the kernel. It thus coexists with your own signal
		2420	handlers as long as you don't register any with libev for the same signal.
2049		2421
2050	If possible and supported, libev will install its handlers with	2422	If possible and supported, libev will install its handlers with
2051	C<SA_RESTART> behaviour enabled, so system calls should not be unduly	2423	C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should
2052	interrupted. If you have a problem with system calls getting interrupted by	2424	not be unduly interrupted. If you have a problem with system calls getting
2053	signals you can block all signals in an C<ev_check> watcher and unblock	2425	interrupted by signals you can block all signals in an C<ev_check> watcher
2054	them in an C<ev_prepare> watcher.	2426	and unblock them in an C<ev_prepare> watcher.
		2427
		2428	=head3 The special problem of inheritance over fork/execve/pthread_create
		2429
		2430	Both the signal mask (C<sigprocmask>) and the signal disposition
		2431	(C<sigaction>) are unspecified after starting a signal watcher (and after
		2432	stopping it again), that is, libev might or might not block the signal,
		2433	and might or might not set or restore the installed signal handler (but
		2434	see C<EVFLAG_NOSIGMASK>).
		2435
		2436	While this does not matter for the signal disposition (libev never
		2437	sets signals to C<SIG_IGN>, so handlers will be reset to C<SIG_DFL> on
		2438	C<execve>), this matters for the signal mask: many programs do not expect
		2439	certain signals to be blocked.
		2440
		2441	This means that before calling C<exec> (from the child) you should reset
		2442	the signal mask to whatever "default" you expect (all clear is a good
		2443	choice usually).
		2444
		2445	The simplest way to ensure that the signal mask is reset in the child is
		2446	to install a fork handler with C<pthread_atfork> that resets it. That will
		2447	catch fork calls done by libraries (such as the libc) as well.
		2448
		2449	In current versions of libev, the signal will not be blocked indefinitely
		2450	unless you use the C<signalfd> API (C<EV_SIGNALFD>). While this reduces
		2451	the window of opportunity for problems, it will not go away, as libev
		2452	I<has> to modify the signal mask, at least temporarily.
		2453
		2454	So I can't stress this enough: I<If you do not reset your signal mask when
		2455	you expect it to be empty, you have a race condition in your code>. This
		2456	is not a libev-specific thing, this is true for most event libraries.
		2457
		2458	=head3 The special problem of threads signal handling
		2459
		2460	POSIX threads has problematic signal handling semantics, specifically,
		2461	a lot of functionality (sigfd, sigwait etc.) only really works if all
		2462	threads in a process block signals, which is hard to achieve.
		2463
		2464	When you want to use sigwait (or mix libev signal handling with your own
		2465	for the same signals), you can tackle this problem by globally blocking
		2466	all signals before creating any threads (or creating them with a fully set
		2467	sigprocmask) and also specifying the C<EVFLAG_NOSIGMASK> when creating
		2468	loops. Then designate one thread as "signal receiver thread" which handles
		2469	these signals. You can pass on any signals that libev might be interested
		2470	in by calling C<ev_feed_signal>.
2055		2471
2056	=head3 Watcher-Specific Functions and Data Members	2472	=head3 Watcher-Specific Functions and Data Members
2057		2473
2058	=over 4	2474	=over 4
2059		2475
…		…
2075	Example: Try to exit cleanly on SIGINT.	2491	Example: Try to exit cleanly on SIGINT.
2076		2492
2077	static void	2493	static void
2078	sigint_cb (struct ev_loop *loop, ev_signal *w, int revents)	2494	sigint_cb (struct ev_loop *loop, ev_signal *w, int revents)
2079	{	2495	{
2080	ev_unloop (loop, EVUNLOOP_ALL);	2496	ev_break (loop, EVBREAK_ALL);
2081	}	2497	}
2082		2498
2083	ev_signal signal_watcher;	2499	ev_signal signal_watcher;
2084	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);	2500	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
2085	ev_signal_start (loop, &signal_watcher);	2501	ev_signal_start (loop, &signal_watcher);
…		…
2104	libev)	2520	libev)
2105		2521
2106	=head3 Process Interaction	2522	=head3 Process Interaction
2107		2523
2108	Libev grabs C<SIGCHLD> as soon as the default event loop is	2524	Libev grabs C<SIGCHLD> as soon as the default event loop is
2109	initialised. This is necessary to guarantee proper behaviour even if	2525	initialised. This is necessary to guarantee proper behaviour even if the
2110	the first child watcher is started after the child exits. The occurrence	2526	first child watcher is started after the child exits. The occurrence
2111	of C<SIGCHLD> is recorded asynchronously, but child reaping is done	2527	of C<SIGCHLD> is recorded asynchronously, but child reaping is done
2112	synchronously as part of the event loop processing. Libev always reaps all	2528	synchronously as part of the event loop processing. Libev always reaps all
2113	children, even ones not watched.	2529	children, even ones not watched.
2114		2530
2115	=head3 Overriding the Built-In Processing	2531	=head3 Overriding the Built-In Processing
…		…
2125	=head3 Stopping the Child Watcher	2541	=head3 Stopping the Child Watcher
2126		2542
2127	Currently, the child watcher never gets stopped, even when the	2543	Currently, the child watcher never gets stopped, even when the
2128	child terminates, so normally one needs to stop the watcher in the	2544	child terminates, so normally one needs to stop the watcher in the
2129	callback. Future versions of libev might stop the watcher automatically	2545	callback. Future versions of libev might stop the watcher automatically
2130	when a child exit is detected.	2546	when a child exit is detected (calling C<ev_child_stop> twice is not a
		2547	problem).
2131		2548
2132	=head3 Watcher-Specific Functions and Data Members	2549	=head3 Watcher-Specific Functions and Data Members
2133		2550
2134	=over 4	2551	=over 4
2135		2552
…		…
2193		2610
2194	=head2 C<ev_stat> - did the file attributes just change?	2611	=head2 C<ev_stat> - did the file attributes just change?
2195		2612
2196	This watches a file system path for attribute changes. That is, it calls	2613	This watches a file system path for attribute changes. That is, it calls
2197	C<stat> on that path in regular intervals (or when the OS says it changed)	2614	C<stat> on that path in regular intervals (or when the OS says it changed)
2198	and sees if it changed compared to the last time, invoking the callback if	2615	and sees if it changed compared to the last time, invoking the callback
2199	it did.	2616	if it did. Starting the watcher C<stat>'s the file, so only changes that
		2617	happen after the watcher has been started will be reported.
2200		2618
2201	The path does not need to exist: changing from "path exists" to "path does	2619	The path does not need to exist: changing from "path exists" to "path does
2202	not exist" is a status change like any other. The condition "path does not	2620	not exist" is a status change like any other. The condition "path does not
2203	exist" (or more correctly "path cannot be stat'ed") is signified by the	2621	exist" (or more correctly "path cannot be stat'ed") is signified by the
2204	C<st_nlink> field being zero (which is otherwise always forced to be at	2622	C<st_nlink> field being zero (which is otherwise always forced to be at
…		…
2434	Apart from keeping your process non-blocking (which is a useful	2852	Apart from keeping your process non-blocking (which is a useful
2435	effect on its own sometimes), idle watchers are a good place to do	2853	effect on its own sometimes), idle watchers are a good place to do
2436	"pseudo-background processing", or delay processing stuff to after the	2854	"pseudo-background processing", or delay processing stuff to after the
2437	event loop has handled all outstanding events.	2855	event loop has handled all outstanding events.
2438		2856
		2857	=head3 Abusing an C<ev_idle> watcher for its side-effect
		2858
		2859	As long as there is at least one active idle watcher, libev will never
		2860	sleep unnecessarily. Or in other words, it will loop as fast as possible.
		2861	For this to work, the idle watcher doesn't need to be invoked at all - the
		2862	lowest priority will do.
		2863
		2864	This mode of operation can be useful together with an C<ev_check> watcher,
		2865	to do something on each event loop iteration - for example to balance load
		2866	between different connections.
		2867
		2868	See L</Abusing an ev_check watcher for its side-effect> for a longer
		2869	example.
		2870
2439	=head3 Watcher-Specific Functions and Data Members	2871	=head3 Watcher-Specific Functions and Data Members
2440		2872
2441	=over 4	2873	=over 4
2442		2874
2443	=item ev_idle_init (ev_idle *, callback)	2875	=item ev_idle_init (ev_idle *, callback)
…		…
2454	callback, free it. Also, use no error checking, as usual.	2886	callback, free it. Also, use no error checking, as usual.
2455		2887
2456	static void	2888	static void
2457	idle_cb (struct ev_loop *loop, ev_idle *w, int revents)	2889	idle_cb (struct ev_loop *loop, ev_idle *w, int revents)
2458	{	2890	{
		2891	// stop the watcher
		2892	ev_idle_stop (loop, w);
		2893
		2894	// now we can free it
2459	free (w);	2895	free (w);
		2896
2460	// now do something you wanted to do when the program has	2897	// now do something you wanted to do when the program has
2461	// no longer anything immediate to do.	2898	// no longer anything immediate to do.
2462	}	2899	}
2463		2900
2464	ev_idle *idle_watcher = malloc (sizeof (ev_idle));	2901	ev_idle *idle_watcher = malloc (sizeof (ev_idle));
…		…
2466	ev_idle_start (loop, idle_watcher);	2903	ev_idle_start (loop, idle_watcher);
2467		2904
2468		2905
2469	=head2 C<ev_prepare> and C<ev_check> - customise your event loop!	2906	=head2 C<ev_prepare> and C<ev_check> - customise your event loop!
2470		2907
2471	Prepare and check watchers are usually (but not always) used in pairs:	2908	Prepare and check watchers are often (but not always) used in pairs:
2472	prepare watchers get invoked before the process blocks and check watchers	2909	prepare watchers get invoked before the process blocks and check watchers
2473	afterwards.	2910	afterwards.
2474		2911
2475	You I<must not> call C<ev_loop> or similar functions that enter	2912	You I<must not> call C<ev_run> or similar functions that enter
2476	the current event loop from either C<ev_prepare> or C<ev_check>	2913	the current event loop from either C<ev_prepare> or C<ev_check>
2477	watchers. Other loops than the current one are fine, however. The	2914	watchers. Other loops than the current one are fine, however. The
2478	rationale behind this is that you do not need to check for recursion in	2915	rationale behind this is that you do not need to check for recursion in
2479	those watchers, i.e. the sequence will always be C<ev_prepare>, blocking,	2916	those watchers, i.e. the sequence will always be C<ev_prepare>, blocking,
2480	C<ev_check> so if you have one watcher of each kind they will always be	2917	C<ev_check> so if you have one watcher of each kind they will always be
…		…
2504	with priority higher than or equal to the event loop and one coroutine	2941	with priority higher than or equal to the event loop and one coroutine
2505	of lower priority, but only once, using idle watchers to keep the event	2942	of lower priority, but only once, using idle watchers to keep the event
2506	loop from blocking if lower-priority coroutines are active, thus mapping	2943	loop from blocking if lower-priority coroutines are active, thus mapping
2507	low-priority coroutines to idle/background tasks).	2944	low-priority coroutines to idle/background tasks).
2508		2945
2509	It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>)	2946	When used for this purpose, it is recommended to give C<ev_check> watchers
2510	priority, to ensure that they are being run before any other watchers	2947	highest (C<EV_MAXPRI>) priority, to ensure that they are being run before
2511	after the poll (this doesn't matter for C<ev_prepare> watchers).	2948	any other watchers after the poll (this doesn't matter for C<ev_prepare>
		2949	watchers).
2512		2950
2513	Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not	2951	Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not
2514	activate ("feed") events into libev. While libev fully supports this, they	2952	activate ("feed") events into libev. While libev fully supports this, they
2515	might get executed before other C<ev_check> watchers did their job. As	2953	might get executed before other C<ev_check> watchers did their job. As
2516	C<ev_check> watchers are often used to embed other (non-libev) event	2954	C<ev_check> watchers are often used to embed other (non-libev) event
2517	loops those other event loops might be in an unusable state until their	2955	loops those other event loops might be in an unusable state until their
2518	C<ev_check> watcher ran (always remind yourself to coexist peacefully with	2956	C<ev_check> watcher ran (always remind yourself to coexist peacefully with
2519	others).	2957	others).
		2958
		2959	=head3 Abusing an C<ev_check> watcher for its side-effect
		2960
		2961	C<ev_check> (and less often also C<ev_prepare>) watchers can also be
		2962	useful because they are called once per event loop iteration. For
		2963	example, if you want to handle a large number of connections fairly, you
		2964	normally only do a bit of work for each active connection, and if there
		2965	is more work to do, you wait for the next event loop iteration, so other
		2966	connections have a chance of making progress.
		2967
		2968	Using an C<ev_check> watcher is almost enough: it will be called on the
		2969	next event loop iteration. However, that isn't as soon as possible -
		2970	without external events, your C<ev_check> watcher will not be invoked.
		2971
		2972	This is where C<ev_idle> watchers come in handy - all you need is a
		2973	single global idle watcher that is active as long as you have one active
		2974	C<ev_check> watcher. The C<ev_idle> watcher makes sure the event loop
		2975	will not sleep, and the C<ev_check> watcher makes sure a callback gets
		2976	invoked. Neither watcher alone can do that.
2520		2977
2521	=head3 Watcher-Specific Functions and Data Members	2978	=head3 Watcher-Specific Functions and Data Members
2522		2979
2523	=over 4	2980	=over 4
2524		2981
…		…
2648		3105
2649	if (timeout >= 0)	3106	if (timeout >= 0)
2650	// create/start timer	3107	// create/start timer
2651		3108
2652	// poll	3109	// poll
2653	ev_loop (EV_A_ 0);	3110	ev_run (EV_A_ 0);
2654		3111
2655	// stop timer again	3112	// stop timer again
2656	if (timeout >= 0)	3113	if (timeout >= 0)
2657	ev_timer_stop (EV_A_ &to);	3114	ev_timer_stop (EV_A_ &to);
2658		3115
…		…
2725		3182
2726	=over 4	3183	=over 4
2727		3184
2728	=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)	3185	=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)
2729		3186
2730	=item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)	3187	=item ev_embed_set (ev_embed *, struct ev_loop *embedded_loop)
2731		3188
2732	Configures the watcher to embed the given loop, which must be	3189	Configures the watcher to embed the given loop, which must be
2733	embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be	3190	embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be
2734	invoked automatically, otherwise it is the responsibility of the callback	3191	invoked automatically, otherwise it is the responsibility of the callback
2735	to invoke it (it will continue to be called until the sweep has been done,	3192	to invoke it (it will continue to be called until the sweep has been done,
2736	if you do not want that, you need to temporarily stop the embed watcher).	3193	if you do not want that, you need to temporarily stop the embed watcher).
2737		3194
2738	=item ev_embed_sweep (loop, ev_embed *)	3195	=item ev_embed_sweep (loop, ev_embed *)
2739		3196
2740	Make a single, non-blocking sweep over the embedded loop. This works	3197	Make a single, non-blocking sweep over the embedded loop. This works
2741	similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most	3198	similarly to C<ev_run (embedded_loop, EVRUN_NOWAIT)>, but in the most
2742	appropriate way for embedded loops.	3199	appropriate way for embedded loops.
2743		3200
2744	=item struct ev_loop *other [read-only]	3201	=item struct ev_loop *other [read-only]
2745		3202
2746	The embedded event loop.	3203	The embedded event loop.
…		…
2798		3255
2799	=head2 C<ev_fork> - the audacity to resume the event loop after a fork	3256	=head2 C<ev_fork> - the audacity to resume the event loop after a fork
2800		3257
2801	Fork watchers are called when a C<fork ()> was detected (usually because	3258	Fork watchers are called when a C<fork ()> was detected (usually because
2802	whoever is a good citizen cared to tell libev about it by calling	3259	whoever is a good citizen cared to tell libev about it by calling
2803	C<ev_default_fork> or C<ev_loop_fork>). The invocation is done before the	3260	C<ev_loop_fork>). The invocation is done before the event loop blocks next
2804	event loop blocks next and before C<ev_check> watchers are being called,	3261	and before C<ev_check> watchers are being called, and only in the child
2805	and only in the child after the fork. If whoever good citizen calling	3262	after the fork. If whoever good citizen calling C<ev_default_fork> cheats
2806	C<ev_default_fork> cheats and calls it in the wrong process, the fork	3263	and calls it in the wrong process, the fork handlers will be invoked, too,
2807	handlers will be invoked, too, of course.	3264	of course.
2808		3265
2809	=head3 The special problem of life after fork - how is it possible?	3266	=head3 The special problem of life after fork - how is it possible?
2810		3267
2811	Most uses of C<fork()> consist of forking, then some simple calls to ste	3268	Most uses of C<fork()> consist of forking, then some simple calls to set
2812	up/change the process environment, followed by a call to C<exec()>. This	3269	up/change the process environment, followed by a call to C<exec()>. This
2813	sequence should be handled by libev without any problems.	3270	sequence should be handled by libev without any problems.
2814		3271
2815	This changes when the application actually wants to do event handling	3272	This changes when the application actually wants to do event handling
2816	in the child, or both parent in child, in effect "continuing" after the	3273	in the child, or both parent in child, in effect "continuing" after the
…		…
2832	disadvantage of having to use multiple event loops (which do not support	3289	disadvantage of having to use multiple event loops (which do not support
2833	signal watchers).	3290	signal watchers).
2834		3291
2835	When this is not possible, or you want to use the default loop for	3292	When this is not possible, or you want to use the default loop for
2836	other reasons, then in the process that wants to start "fresh", call	3293	other reasons, then in the process that wants to start "fresh", call
2837	C<ev_default_destroy ()> followed by C<ev_default_loop (...)>. Destroying	3294	C<ev_loop_destroy (EV_DEFAULT)> followed by C<ev_default_loop (...)>.
2838	the default loop will "orphan" (not stop) all registered watchers, so you	3295	Destroying the default loop will "orphan" (not stop) all registered
2839	have to be careful not to execute code that modifies those watchers. Note	3296	watchers, so you have to be careful not to execute code that modifies
2840	also that in that case, you have to re-register any signal watchers.	3297	those watchers. Note also that in that case, you have to re-register any
		3298	signal watchers.
2841		3299
2842	=head3 Watcher-Specific Functions and Data Members	3300	=head3 Watcher-Specific Functions and Data Members
2843		3301
2844	=over 4	3302	=over 4
2845		3303
2846	=item ev_fork_init (ev_signal *, callback)	3304	=item ev_fork_init (ev_fork *, callback)
2847		3305
2848	Initialises and configures the fork watcher - it has no parameters of any	3306	Initialises and configures the fork watcher - it has no parameters of any
2849	kind. There is a C<ev_fork_set> macro, but using it is utterly pointless,	3307	kind. There is a C<ev_fork_set> macro, but using it is utterly pointless,
2850	believe me.	3308	really.
2851		3309
2852	=back	3310	=back
2853		3311
2854		3312
		3313	=head2 C<ev_cleanup> - even the best things end
		3314
		3315	Cleanup watchers are called just before the event loop is being destroyed
		3316	by a call to C<ev_loop_destroy>.
		3317
		3318	While there is no guarantee that the event loop gets destroyed, cleanup
		3319	watchers provide a convenient method to install cleanup hooks for your
		3320	program, worker threads and so on - you just to make sure to destroy the
		3321	loop when you want them to be invoked.
		3322
		3323	Cleanup watchers are invoked in the same way as any other watcher. Unlike
		3324	all other watchers, they do not keep a reference to the event loop (which
		3325	makes a lot of sense if you think about it). Like all other watchers, you
		3326	can call libev functions in the callback, except C<ev_cleanup_start>.
		3327
		3328	=head3 Watcher-Specific Functions and Data Members
		3329
		3330	=over 4
		3331
		3332	=item ev_cleanup_init (ev_cleanup *, callback)
		3333
		3334	Initialises and configures the cleanup watcher - it has no parameters of
		3335	any kind. There is a C<ev_cleanup_set> macro, but using it is utterly
		3336	pointless, I assure you.
		3337
		3338	=back
		3339
		3340	Example: Register an atexit handler to destroy the default loop, so any
		3341	cleanup functions are called.
		3342
		3343	static void
		3344	program_exits (void)
		3345	{
		3346	ev_loop_destroy (EV_DEFAULT_UC);
		3347	}
		3348
		3349	...
		3350	atexit (program_exits);
		3351
		3352
2855	=head2 C<ev_async> - how to wake up another event loop	3353	=head2 C<ev_async> - how to wake up an event loop
2856		3354
2857	In general, you cannot use an C<ev_loop> from multiple threads or other	3355	In general, you cannot use an C<ev_loop> from multiple threads or other
2858	asynchronous sources such as signal handlers (as opposed to multiple event	3356	asynchronous sources such as signal handlers (as opposed to multiple event
2859	loops - those are of course safe to use in different threads).	3357	loops - those are of course safe to use in different threads).
2860		3358
2861	Sometimes, however, you need to wake up another event loop you do not	3359	Sometimes, however, you need to wake up an event loop you do not control,
2862	control, for example because it belongs to another thread. This is what	3360	for example because it belongs to another thread. This is what C<ev_async>
2863	C<ev_async> watchers do: as long as the C<ev_async> watcher is active, you	3361	watchers do: as long as the C<ev_async> watcher is active, you can signal
2864	can signal it by calling C<ev_async_send>, which is thread- and signal	3362	it by calling C<ev_async_send>, which is thread- and signal safe.
2865	safe.
2866		3363
2867	This functionality is very similar to C<ev_signal> watchers, as signals,	3364	This functionality is very similar to C<ev_signal> watchers, as signals,
2868	too, are asynchronous in nature, and signals, too, will be compressed	3365	too, are asynchronous in nature, and signals, too, will be compressed
2869	(i.e. the number of callback invocations may be less than the number of	3366	(i.e. the number of callback invocations may be less than the number of
2870	C<ev_async_sent> calls).	3367	C<ev_async_send> calls). In fact, you could use signal watchers as a kind
2871		3368	of "global async watchers" by using a watcher on an otherwise unused
2872	Unlike C<ev_signal> watchers, C<ev_async> works with any event loop, not	3369	signal, and C<ev_feed_signal> to signal this watcher from another thread,
2873	just the default loop.	3370	even without knowing which loop owns the signal.
2874		3371
2875	=head3 Queueing	3372	=head3 Queueing
2876		3373
2877	C<ev_async> does not support queueing of data in any way. The reason	3374	C<ev_async> does not support queueing of data in any way. The reason
2878	is that the author does not know of a simple (or any) algorithm for a	3375	is that the author does not know of a simple (or any) algorithm for a
2879	multiple-writer-single-reader queue that works in all cases and doesn't	3376	multiple-writer-single-reader queue that works in all cases and doesn't
2880	need elaborate support such as pthreads.	3377	need elaborate support such as pthreads or unportable memory access
		3378	semantics.
2881		3379
2882	That means that if you want to queue data, you have to provide your own	3380	That means that if you want to queue data, you have to provide your own
2883	queue. But at least I can tell you how to implement locking around your	3381	queue. But at least I can tell you how to implement locking around your
2884	queue:	3382	queue:
2885		3383
…		…
2969	trust me.	3467	trust me.
2970		3468
2971	=item ev_async_send (loop, ev_async *)	3469	=item ev_async_send (loop, ev_async *)
2972		3470
2973	Sends/signals/activates the given C<ev_async> watcher, that is, feeds	3471	Sends/signals/activates the given C<ev_async> watcher, that is, feeds
2974	an C<EV_ASYNC> event on the watcher into the event loop. Unlike	3472	an C<EV_ASYNC> event on the watcher into the event loop, and instantly
		3473	returns.
		3474
2975	C<ev_feed_event>, this call is safe to do from other threads, signal or	3475	Unlike C<ev_feed_event>, this call is safe to do from other threads,
2976	similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding	3476	signal or similar contexts (see the discussion of C<EV_ATOMIC_T> in the
2977	section below on what exactly this means).	3477	embedding section below on what exactly this means).
2978		3478
2979	Note that, as with other watchers in libev, multiple events might get	3479	Note that, as with other watchers in libev, multiple events might get
2980	compressed into a single callback invocation (another way to look at this	3480	compressed into a single callback invocation (another way to look at
2981	is that C<ev_async> watchers are level-triggered, set on C<ev_async_send>,	3481	this is that C<ev_async> watchers are level-triggered: they are set on
2982	reset when the event loop detects that).	3482	C<ev_async_send>, reset when the event loop detects that).
2983		3483
2984	This call incurs the overhead of a system call only once per event loop	3484	This call incurs the overhead of at most one extra system call per event
2985	iteration, so while the overhead might be noticeable, it doesn't apply to	3485	loop iteration, if the event loop is blocked, and no syscall at all if
2986	repeated calls to C<ev_async_send> for the same event loop.	3486	the event loop (or your program) is processing events. That means that
		3487	repeated calls are basically free (there is no need to avoid calls for
		3488	performance reasons) and that the overhead becomes smaller (typically
		3489	zero) under load.
2987		3490
2988	=item bool = ev_async_pending (ev_async *)	3491	=item bool = ev_async_pending (ev_async *)
2989		3492
2990	Returns a non-zero value when C<ev_async_send> has been called on the	3493	Returns a non-zero value when C<ev_async_send> has been called on the
2991	watcher but the event has not yet been processed (or even noted) by the	3494	watcher but the event has not yet been processed (or even noted) by the
…		…
3024		3527
3025	If C<timeout> is less than 0, then no timeout watcher will be	3528	If C<timeout> is less than 0, then no timeout watcher will be
3026	started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and	3529	started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and
3027	repeat = 0) will be started. C<0> is a valid timeout.	3530	repeat = 0) will be started. C<0> is a valid timeout.
3028		3531
3029	The callback has the type C<void (*cb)(int revents, void *arg)> and gets	3532	The callback has the type C<void (*cb)(int revents, void *arg)> and is
3030	passed an C<revents> set like normal event callbacks (a combination of	3533	passed an C<revents> set like normal event callbacks (a combination of
3031	C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg>	3534	C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMER>) and the C<arg>
3032	value passed to C<ev_once>. Note that it is possible to receive I<both>	3535	value passed to C<ev_once>. Note that it is possible to receive I<both>
3033	a timeout and an io event at the same time - you probably should give io	3536	a timeout and an io event at the same time - you probably should give io
3034	events precedence.	3537	events precedence.
3035		3538
3036	Example: wait up to ten seconds for data to appear on STDIN_FILENO.	3539	Example: wait up to ten seconds for data to appear on STDIN_FILENO.
3037		3540
3038	static void stdin_ready (int revents, void *arg)	3541	static void stdin_ready (int revents, void *arg)
3039	{	3542	{
3040	if (revents & EV_READ)	3543	if (revents & EV_READ)
3041	/* stdin might have data for us, joy! */;	3544	/* stdin might have data for us, joy! */;
3042	else if (revents & EV_TIMEOUT)	3545	else if (revents & EV_TIMER)
3043	/* doh, nothing entered */;	3546	/* doh, nothing entered */;
3044	}	3547	}
3045		3548
3046	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);	3549	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
3047		3550
3048	=item ev_feed_event (struct ev_loop *, watcher *, int revents)
3049
3050	Feeds the given event set into the event loop, as if the specified event
3051	had happened for the specified watcher (which must be a pointer to an
3052	initialised but not necessarily started event watcher).
3053
3054	=item ev_feed_fd_event (struct ev_loop *, int fd, int revents)	3551	=item ev_feed_fd_event (loop, int fd, int revents)
3055		3552
3056	Feed an event on the given fd, as if a file descriptor backend detected	3553	Feed an event on the given fd, as if a file descriptor backend detected
3057	the given events it.	3554	the given events.
3058		3555
3059	=item ev_feed_signal_event (struct ev_loop *loop, int signum)	3556	=item ev_feed_signal_event (loop, int signum)
3060		3557
3061	Feed an event as if the given signal occurred (C<loop> must be the default	3558	Feed an event as if the given signal occurred. See also C<ev_feed_signal>,
3062	loop!).	3559	which is async-safe.
3063		3560
3064	=back	3561	=back
		3562
		3563
		3564	=head1 COMMON OR USEFUL IDIOMS (OR BOTH)
		3565
		3566	This section explains some common idioms that are not immediately
		3567	obvious. Note that examples are sprinkled over the whole manual, and this
		3568	section only contains stuff that wouldn't fit anywhere else.
		3569
		3570	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
		3571
		3572	Each watcher has, by default, a C<void *data> member that you can read
		3573	or modify at any time: libev will completely ignore it. This can be used
		3574	to associate arbitrary data with your watcher. If you need more data and
		3575	don't want to allocate memory separately and store a pointer to it in that
		3576	data member, you can also "subclass" the watcher type and provide your own
		3577	data:
		3578
		3579	struct my_io
		3580	{
		3581	ev_io io;
		3582	int otherfd;
		3583	void *somedata;
		3584	struct whatever *mostinteresting;
		3585	};
		3586
		3587	...
		3588	struct my_io w;
		3589	ev_io_init (&w.io, my_cb, fd, EV_READ);
		3590
		3591	And since your callback will be called with a pointer to the watcher, you
		3592	can cast it back to your own type:
		3593
		3594	static void my_cb (struct ev_loop *loop, ev_io *w_, int revents)
		3595	{
		3596	struct my_io *w = (struct my_io *)w_;
		3597	...
		3598	}
		3599
		3600	More interesting and less C-conformant ways of casting your callback
		3601	function type instead have been omitted.
		3602
		3603	=head2 BUILDING YOUR OWN COMPOSITE WATCHERS
		3604
		3605	Another common scenario is to use some data structure with multiple
		3606	embedded watchers, in effect creating your own watcher that combines
		3607	multiple libev event sources into one "super-watcher":
		3608
		3609	struct my_biggy
		3610	{
		3611	int some_data;
		3612	ev_timer t1;
		3613	ev_timer t2;
		3614	}
		3615
		3616	In this case getting the pointer to C<my_biggy> is a bit more
		3617	complicated: Either you store the address of your C<my_biggy> struct in
		3618	the C<data> member of the watcher (for woozies or C++ coders), or you need
		3619	to use some pointer arithmetic using C<offsetof> inside your watchers (for
		3620	real programmers):
		3621
		3622	#include <stddef.h>
		3623
		3624	static void
		3625	t1_cb (EV_P_ ev_timer *w, int revents)
		3626	{
		3627	struct my_biggy big = (struct my_biggy *)
		3628	(((char *)w) - offsetof (struct my_biggy, t1));
		3629	}
		3630
		3631	static void
		3632	t2_cb (EV_P_ ev_timer *w, int revents)
		3633	{
		3634	struct my_biggy big = (struct my_biggy *)
		3635	(((char *)w) - offsetof (struct my_biggy, t2));
		3636	}
		3637
		3638	=head2 AVOIDING FINISHING BEFORE RETURNING
		3639
		3640	Often you have structures like this in event-based programs:
		3641
		3642	callback ()
		3643	{
		3644	free (request);
		3645	}
		3646
		3647	request = start_new_request (..., callback);
		3648
		3649	The intent is to start some "lengthy" operation. The C<request> could be
		3650	used to cancel the operation, or do other things with it.
		3651
		3652	It's not uncommon to have code paths in C<start_new_request> that
		3653	immediately invoke the callback, for example, to report errors. Or you add
		3654	some caching layer that finds that it can skip the lengthy aspects of the
		3655	operation and simply invoke the callback with the result.
		3656
		3657	The problem here is that this will happen I<before> C<start_new_request>
		3658	has returned, so C<request> is not set.
		3659
		3660	Even if you pass the request by some safer means to the callback, you
		3661	might want to do something to the request after starting it, such as
		3662	canceling it, which probably isn't working so well when the callback has
		3663	already been invoked.
		3664
		3665	A common way around all these issues is to make sure that
		3666	C<start_new_request> I<always> returns before the callback is invoked. If
		3667	C<start_new_request> immediately knows the result, it can artificially
		3668	delay invoking the callback by using a C<prepare> or C<idle> watcher for
		3669	example, or more sneakily, by reusing an existing (stopped) watcher and
		3670	pushing it into the pending queue:
		3671
		3672	ev_set_cb (watcher, callback);
		3673	ev_feed_event (EV_A_ watcher, 0);
		3674
		3675	This way, C<start_new_request> can safely return before the callback is
		3676	invoked, while not delaying callback invocation too much.
		3677
		3678	=head2 MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS
		3679
		3680	Often (especially in GUI toolkits) there are places where you have
		3681	I<modal> interaction, which is most easily implemented by recursively
		3682	invoking C<ev_run>.
		3683
		3684	This brings the problem of exiting - a callback might want to finish the
		3685	main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but
		3686	a modal "Are you sure?" dialog is still waiting), or just the nested one
		3687	and not the main one (e.g. user clocked "Ok" in a modal dialog), or some
		3688	other combination: In these cases, a simple C<ev_break> will not work.
		3689
		3690	The solution is to maintain "break this loop" variable for each C<ev_run>
		3691	invocation, and use a loop around C<ev_run> until the condition is
		3692	triggered, using C<EVRUN_ONCE>:
		3693
		3694	// main loop
		3695	int exit_main_loop = 0;
		3696
		3697	while (!exit_main_loop)
		3698	ev_run (EV_DEFAULT_ EVRUN_ONCE);
		3699
		3700	// in a modal watcher
		3701	int exit_nested_loop = 0;
		3702
		3703	while (!exit_nested_loop)
		3704	ev_run (EV_A_ EVRUN_ONCE);
		3705
		3706	To exit from any of these loops, just set the corresponding exit variable:
		3707
		3708	// exit modal loop
		3709	exit_nested_loop = 1;
		3710
		3711	// exit main program, after modal loop is finished
		3712	exit_main_loop = 1;
		3713
		3714	// exit both
		3715	exit_main_loop = exit_nested_loop = 1;
		3716
		3717	=head2 THREAD LOCKING EXAMPLE
		3718
		3719	Here is a fictitious example of how to run an event loop in a different
		3720	thread from where callbacks are being invoked and watchers are
		3721	created/added/removed.
		3722
		3723	For a real-world example, see the C<EV::Loop::Async> perl module,
		3724	which uses exactly this technique (which is suited for many high-level
		3725	languages).
		3726
		3727	The example uses a pthread mutex to protect the loop data, a condition
		3728	variable to wait for callback invocations, an async watcher to notify the
		3729	event loop thread and an unspecified mechanism to wake up the main thread.
		3730
		3731	First, you need to associate some data with the event loop:
		3732
		3733	typedef struct {
		3734	mutex_t lock; /* global loop lock */
		3735	ev_async async_w;
		3736	thread_t tid;
		3737	cond_t invoke_cv;
		3738	} userdata;
		3739
		3740	void prepare_loop (EV_P)
		3741	{
		3742	// for simplicity, we use a static userdata struct.
		3743	static userdata u;
		3744
		3745	ev_async_init (&u->async_w, async_cb);
		3746	ev_async_start (EV_A_ &u->async_w);
		3747
		3748	pthread_mutex_init (&u->lock, 0);
		3749	pthread_cond_init (&u->invoke_cv, 0);
		3750
		3751	// now associate this with the loop
		3752	ev_set_userdata (EV_A_ u);
		3753	ev_set_invoke_pending_cb (EV_A_ l_invoke);
		3754	ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
		3755
		3756	// then create the thread running ev_run
		3757	pthread_create (&u->tid, 0, l_run, EV_A);
		3758	}
		3759
		3760	The callback for the C<ev_async> watcher does nothing: the watcher is used
		3761	solely to wake up the event loop so it takes notice of any new watchers
		3762	that might have been added:
		3763
		3764	static void
		3765	async_cb (EV_P_ ev_async *w, int revents)
		3766	{
		3767	// just used for the side effects
		3768	}
		3769
		3770	The C<l_release> and C<l_acquire> callbacks simply unlock/lock the mutex
		3771	protecting the loop data, respectively.
		3772
		3773	static void
		3774	l_release (EV_P)
		3775	{
		3776	userdata *u = ev_userdata (EV_A);
		3777	pthread_mutex_unlock (&u->lock);
		3778	}
		3779
		3780	static void
		3781	l_acquire (EV_P)
		3782	{
		3783	userdata *u = ev_userdata (EV_A);
		3784	pthread_mutex_lock (&u->lock);
		3785	}
		3786
		3787	The event loop thread first acquires the mutex, and then jumps straight
		3788	into C<ev_run>:
		3789
		3790	void *
		3791	l_run (void *thr_arg)
		3792	{
		3793	struct ev_loop *loop = (struct ev_loop *)thr_arg;
		3794
		3795	l_acquire (EV_A);
		3796	pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
		3797	ev_run (EV_A_ 0);
		3798	l_release (EV_A);
		3799
		3800	return 0;
		3801	}
		3802
		3803	Instead of invoking all pending watchers, the C<l_invoke> callback will
		3804	signal the main thread via some unspecified mechanism (signals? pipe
		3805	writes? C<Async::Interrupt>?) and then waits until all pending watchers
		3806	have been called (in a while loop because a) spurious wakeups are possible
		3807	and b) skipping inter-thread-communication when there are no pending
		3808	watchers is very beneficial):
		3809
		3810	static void
		3811	l_invoke (EV_P)
		3812	{
		3813	userdata *u = ev_userdata (EV_A);
		3814
		3815	while (ev_pending_count (EV_A))
		3816	{
		3817	wake_up_other_thread_in_some_magic_or_not_so_magic_way ();
		3818	pthread_cond_wait (&u->invoke_cv, &u->lock);
		3819	}
		3820	}
		3821
		3822	Now, whenever the main thread gets told to invoke pending watchers, it
		3823	will grab the lock, call C<ev_invoke_pending> and then signal the loop
		3824	thread to continue:
		3825
		3826	static void
		3827	real_invoke_pending (EV_P)
		3828	{
		3829	userdata *u = ev_userdata (EV_A);
		3830
		3831	pthread_mutex_lock (&u->lock);
		3832	ev_invoke_pending (EV_A);
		3833	pthread_cond_signal (&u->invoke_cv);
		3834	pthread_mutex_unlock (&u->lock);
		3835	}
		3836
		3837	Whenever you want to start/stop a watcher or do other modifications to an
		3838	event loop, you will now have to lock:
		3839
		3840	ev_timer timeout_watcher;
		3841	userdata *u = ev_userdata (EV_A);
		3842
		3843	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
		3844
		3845	pthread_mutex_lock (&u->lock);
		3846	ev_timer_start (EV_A_ &timeout_watcher);
		3847	ev_async_send (EV_A_ &u->async_w);
		3848	pthread_mutex_unlock (&u->lock);
		3849
		3850	Note that sending the C<ev_async> watcher is required because otherwise
		3851	an event loop currently blocking in the kernel will have no knowledge
		3852	about the newly added timer. By waking up the loop it will pick up any new
		3853	watchers in the next event loop iteration.
		3854
		3855	=head2 THREADS, COROUTINES, CONTINUATIONS, QUEUES... INSTEAD OF CALLBACKS
		3856
		3857	While the overhead of a callback that e.g. schedules a thread is small, it
		3858	is still an overhead. If you embed libev, and your main usage is with some
		3859	kind of threads or coroutines, you might want to customise libev so that
		3860	doesn't need callbacks anymore.
		3861
		3862	Imagine you have coroutines that you can switch to using a function
		3863	C<switch_to (coro)>, that libev runs in a coroutine called C<libev_coro>
		3864	and that due to some magic, the currently active coroutine is stored in a
		3865	global called C<current_coro>. Then you can build your own "wait for libev
		3866	event" primitive by changing C<EV_CB_DECLARE> and C<EV_CB_INVOKE> (note
		3867	the differing C<;> conventions):
		3868
		3869	#define EV_CB_DECLARE(type) struct my_coro *cb;
		3870	#define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb)
		3871
		3872	That means instead of having a C callback function, you store the
		3873	coroutine to switch to in each watcher, and instead of having libev call
		3874	your callback, you instead have it switch to that coroutine.
		3875
		3876	A coroutine might now wait for an event with a function called
		3877	C<wait_for_event>. (the watcher needs to be started, as always, but it doesn't
		3878	matter when, or whether the watcher is active or not when this function is
		3879	called):
		3880
		3881	void
		3882	wait_for_event (ev_watcher *w)
		3883	{
		3884	ev_set_cb (w, current_coro);
		3885	switch_to (libev_coro);
		3886	}
		3887
		3888	That basically suspends the coroutine inside C<wait_for_event> and
		3889	continues the libev coroutine, which, when appropriate, switches back to
		3890	this or any other coroutine.
		3891
		3892	You can do similar tricks if you have, say, threads with an event queue -
		3893	instead of storing a coroutine, you store the queue object and instead of
		3894	switching to a coroutine, you push the watcher onto the queue and notify
		3895	any waiters.
		3896
		3897	To embed libev, see L</EMBEDDING>, but in short, it's easiest to create two
		3898	files, F<my_ev.h> and F<my_ev.c> that include the respective libev files:
		3899
		3900	// my_ev.h
		3901	#define EV_CB_DECLARE(type) struct my_coro *cb;
		3902	#define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb);
		3903	#include "../libev/ev.h"
		3904
		3905	// my_ev.c
		3906	#define EV_H "my_ev.h"
		3907	#include "../libev/ev.c"
		3908
		3909	And then use F<my_ev.h> when you would normally use F<ev.h>, and compile
		3910	F<my_ev.c> into your project. When properly specifying include paths, you
		3911	can even use F<ev.h> as header file name directly.
3065		3912
3066		3913
3067	=head1 LIBEVENT EMULATION	3914	=head1 LIBEVENT EMULATION
3068		3915
3069	Libev offers a compatibility emulation layer for libevent. It cannot	3916	Libev offers a compatibility emulation layer for libevent. It cannot
3070	emulate the internals of libevent, so here are some usage hints:	3917	emulate the internals of libevent, so here are some usage hints:
3071		3918
3072	=over 4	3919	=over 4
		3920
		3921	=item * Only the libevent-1.4.1-beta API is being emulated.
		3922
		3923	This was the newest libevent version available when libev was implemented,
		3924	and is still mostly unchanged in 2010.
3073		3925
3074	=item * Use it by including <event.h>, as usual.	3926	=item * Use it by including <event.h>, as usual.
3075		3927
3076	=item * The following members are fully supported: ev_base, ev_callback,	3928	=item * The following members are fully supported: ev_base, ev_callback,
3077	ev_arg, ev_fd, ev_res, ev_events.	3929	ev_arg, ev_fd, ev_res, ev_events.
…		…
3083	=item * Priorities are not currently supported. Initialising priorities	3935	=item * Priorities are not currently supported. Initialising priorities
3084	will fail and all watchers will have the same priority, even though there	3936	will fail and all watchers will have the same priority, even though there
3085	is an ev_pri field.	3937	is an ev_pri field.
3086		3938
3087	=item * In libevent, the last base created gets the signals, in libev, the	3939	=item * In libevent, the last base created gets the signals, in libev, the
3088	first base created (== the default loop) gets the signals.	3940	base that registered the signal gets the signals.
3089		3941
3090	=item * Other members are not supported.	3942	=item * Other members are not supported.
3091		3943
3092	=item * The libev emulation is I<not> ABI compatible to libevent, you need	3944	=item * The libev emulation is I<not> ABI compatible to libevent, you need
3093	to use the libev header file and library.	3945	to use the libev header file and library.
3094		3946
3095	=back	3947	=back
3096		3948
3097	=head1 C++ SUPPORT	3949	=head1 C++ SUPPORT
		3950
		3951	=head2 C API
		3952
		3953	The normal C API should work fine when used from C++: both ev.h and the
		3954	libev sources can be compiled as C++. Therefore, code that uses the C API
		3955	will work fine.
		3956
		3957	Proper exception specifications might have to be added to callbacks passed
		3958	to libev: exceptions may be thrown only from watcher callbacks, all
		3959	other callbacks (allocator, syserr, loop acquire/release and periodic
		3960	reschedule callbacks) must not throw exceptions, and might need a C<throw
		3961	()> specification. If you have code that needs to be compiled as both C
		3962	and C++ you can use the C<EV_THROW> macro for this:
		3963
		3964	static void
		3965	fatal_error (const char *msg) EV_THROW
		3966	{
		3967	perror (msg);
		3968	abort ();
		3969	}
		3970
		3971	...
		3972	ev_set_syserr_cb (fatal_error);
		3973
		3974	The only API functions that can currently throw exceptions are C<ev_run>,
		3975	C<ev_invoke>, C<ev_invoke_pending> and C<ev_loop_destroy> (the latter
		3976	because it runs cleanup watchers).
		3977
		3978	Throwing exceptions in watcher callbacks is only supported if libev itself
		3979	is compiled with a C++ compiler or your C and C++ environments allow
		3980	throwing exceptions through C libraries (most do).
		3981
		3982	=head2 C++ API
3098		3983
3099	Libev comes with some simplistic wrapper classes for C++ that mainly allow	3984	Libev comes with some simplistic wrapper classes for C++ that mainly allow
3100	you to use some convenience methods to start/stop watchers and also change	3985	you to use some convenience methods to start/stop watchers and also change
3101	the callback model to a model using method callbacks on objects.	3986	the callback model to a model using method callbacks on objects.
3102		3987
3103	To use it,	3988	To use it,
3104		3989
3105	#include <ev++.h>	3990	#include <ev++.h>
3106		3991
3107	This automatically includes F<ev.h> and puts all of its definitions (many	3992	This automatically includes F<ev.h> and puts all of its definitions (many
3108	of them macros) into the global namespace. All C++ specific things are	3993	of them macros) into the global namespace. All C++ specific things are
3109	put into the C<ev> namespace. It should support all the same embedding	3994	put into the C<ev> namespace. It should support all the same embedding
…		…
3112	Care has been taken to keep the overhead low. The only data member the C++	3997	Care has been taken to keep the overhead low. The only data member the C++
3113	classes add (compared to plain C-style watchers) is the event loop pointer	3998	classes add (compared to plain C-style watchers) is the event loop pointer
3114	that the watcher is associated with (or no additional members at all if	3999	that the watcher is associated with (or no additional members at all if
3115	you disable C<EV_MULTIPLICITY> when embedding libev).	4000	you disable C<EV_MULTIPLICITY> when embedding libev).
3116		4001
3117	Currently, functions, and static and non-static member functions can be	4002	Currently, functions, static and non-static member functions and classes
3118	used as callbacks. Other types should be easy to add as long as they only	4003	with C<operator ()> can be used as callbacks. Other types should be easy
3119	need one additional pointer for context. If you need support for other	4004	to add as long as they only need one additional pointer for context. If
3120	types of functors please contact the author (preferably after implementing	4005	you need support for other types of functors please contact the author
3121	it).	4006	(preferably after implementing it).
		4007
		4008	For all this to work, your C++ compiler either has to use the same calling
		4009	conventions as your C compiler (for static member functions), or you have
		4010	to embed libev and compile libev itself as C++.
3122		4011
3123	Here is a list of things available in the C<ev> namespace:	4012	Here is a list of things available in the C<ev> namespace:
3124		4013
3125	=over 4	4014	=over 4
3126		4015
…		…
3136	=item C<ev::io>, C<ev::timer>, C<ev::periodic>, C<ev::idle>, C<ev::sig> etc.	4025	=item C<ev::io>, C<ev::timer>, C<ev::periodic>, C<ev::idle>, C<ev::sig> etc.
3137		4026
3138	For each C<ev_TYPE> watcher in F<ev.h> there is a corresponding class of	4027	For each C<ev_TYPE> watcher in F<ev.h> there is a corresponding class of
3139	the same name in the C<ev> namespace, with the exception of C<ev_signal>	4028	the same name in the C<ev> namespace, with the exception of C<ev_signal>
3140	which is called C<ev::sig> to avoid clashes with the C<signal> macro	4029	which is called C<ev::sig> to avoid clashes with the C<signal> macro
3141	defines by many implementations.	4030	defined by many implementations.
3142		4031
3143	All of those classes have these methods:	4032	All of those classes have these methods:
3144		4033
3145	=over 4	4034	=over 4
3146		4035
3147	=item ev::TYPE::TYPE ()	4036	=item ev::TYPE::TYPE ()
3148		4037
3149	=item ev::TYPE::TYPE (struct ev_loop *)	4038	=item ev::TYPE::TYPE (loop)
3150		4039
3151	=item ev::TYPE::~TYPE	4040	=item ev::TYPE::~TYPE
3152		4041
3153	The constructor (optionally) takes an event loop to associate the watcher	4042	The constructor (optionally) takes an event loop to associate the watcher
3154	with. If it is omitted, it will use C<EV_DEFAULT>.	4043	with. If it is omitted, it will use C<EV_DEFAULT>.
…		…
3187	myclass obj;	4076	myclass obj;
3188	ev::io iow;	4077	ev::io iow;
3189	iow.set <myclass, &myclass::io_cb> (&obj);	4078	iow.set <myclass, &myclass::io_cb> (&obj);
3190		4079
3191	=item w->set (object *)	4080	=item w->set (object *)
3192
3193	This is an B<experimental> feature that might go away in a future version.
3194		4081
3195	This is a variation of a method callback - leaving out the method to call	4082	This is a variation of a method callback - leaving out the method to call
3196	will default the method to C<operator ()>, which makes it possible to use	4083	will default the method to C<operator ()>, which makes it possible to use
3197	functor objects without having to manually specify the C<operator ()> all	4084	functor objects without having to manually specify the C<operator ()> all
3198	the time. Incidentally, you can then also leave out the template argument	4085	the time. Incidentally, you can then also leave out the template argument
…		…
3231	Example: Use a plain function as callback.	4118	Example: Use a plain function as callback.
3232		4119
3233	static void io_cb (ev::io &w, int revents) { }	4120	static void io_cb (ev::io &w, int revents) { }
3234	iow.set <io_cb> ();	4121	iow.set <io_cb> ();
3235		4122
3236	=item w->set (struct ev_loop *)	4123	=item w->set (loop)
3237		4124
3238	Associates a different C<struct ev_loop> with this watcher. You can only	4125	Associates a different C<struct ev_loop> with this watcher. You can only
3239	do this when the watcher is inactive (and not pending either).	4126	do this when the watcher is inactive (and not pending either).
3240		4127
3241	=item w->set ([arguments])	4128	=item w->set ([arguments])
3242		4129
3243	Basically the same as C<ev_TYPE_set>, with the same arguments. Must be	4130	Basically the same as C<ev_TYPE_set> (except for C<ev::embed> watchers>),
		4131	with the same arguments. Either this method or a suitable start method
3244	called at least once. Unlike the C counterpart, an active watcher gets	4132	must be called at least once. Unlike the C counterpart, an active watcher
3245	automatically stopped and restarted when reconfiguring it with this	4133	gets automatically stopped and restarted when reconfiguring it with this
3246	method.	4134	method.
		4135
		4136	For C<ev::embed> watchers this method is called C<set_embed>, to avoid
		4137	clashing with the C<set (loop)> method.
3247		4138
3248	=item w->start ()	4139	=item w->start ()
3249		4140
3250	Starts the watcher. Note that there is no C<loop> argument, as the	4141	Starts the watcher. Note that there is no C<loop> argument, as the
3251	constructor already stores the event loop.	4142	constructor already stores the event loop.
3252		4143
		4144	=item w->start ([arguments])
		4145
		4146	Instead of calling C<set> and C<start> methods separately, it is often
		4147	convenient to wrap them in one call. Uses the same type of arguments as
		4148	the configure C<set> method of the watcher.
		4149
3253	=item w->stop ()	4150	=item w->stop ()
3254		4151
3255	Stops the watcher if it is active. Again, no C<loop> argument.	4152	Stops the watcher if it is active. Again, no C<loop> argument.
3256		4153
3257	=item w->again () (C<ev::timer>, C<ev::periodic> only)	4154	=item w->again () (C<ev::timer>, C<ev::periodic> only)
…		…
3269		4166
3270	=back	4167	=back
3271		4168
3272	=back	4169	=back
3273		4170
3274	Example: Define a class with an IO and idle watcher, start one of them in	4171	Example: Define a class with two I/O and idle watchers, start the I/O
3275	the constructor.	4172	watchers in the constructor.
3276		4173
3277	class myclass	4174	class myclass
3278	{	4175	{
3279	ev::io io ; void io_cb (ev::io &w, int revents);	4176	ev::io io ; void io_cb (ev::io &w, int revents);
		4177	ev::io io2 ; void io2_cb (ev::io &w, int revents);
3280	ev::idle idle; void idle_cb (ev::idle &w, int revents);	4178	ev::idle idle; void idle_cb (ev::idle &w, int revents);
3281		4179
3282	myclass (int fd)	4180	myclass (int fd)
3283	{	4181	{
3284	io .set <myclass, &myclass::io_cb > (this);	4182	io .set <myclass, &myclass::io_cb > (this);
		4183	io2 .set <myclass, &myclass::io2_cb > (this);
3285	idle.set <myclass, &myclass::idle_cb> (this);	4184	idle.set <myclass, &myclass::idle_cb> (this);
3286		4185
3287	io.start (fd, ev::READ);	4186	io.set (fd, ev::WRITE); // configure the watcher
		4187	io.start (); // start it whenever convenient
		4188
		4189	io2.start (fd, ev::READ); // set + start in one call
3288	}	4190	}
3289	};	4191	};
3290		4192
3291		4193
3292	=head1 OTHER LANGUAGE BINDINGS	4194	=head1 OTHER LANGUAGE BINDINGS
…		…
3331	L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>.	4233	L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>.
3332		4234
3333	=item D	4235	=item D
3334		4236
3335	Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to	4237	Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to
3336	be found at L<http://proj.llucax.com.ar/wiki/evd>.	4238	be found at L<http://www.llucax.com.ar/proj/ev.d/index.html>.
3337		4239
3338	=item Ocaml	4240	=item Ocaml
3339		4241
3340	Erkki Seppala has written Ocaml bindings for libev, to be found at	4242	Erkki Seppala has written Ocaml bindings for libev, to be found at
3341	L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.	4243	L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.
		4244
		4245	=item Lua
		4246
		4247	Brian Maher has written a partial interface to libev for lua (at the
		4248	time of this writing, only C<ev_io> and C<ev_timer>), to be found at
		4249	L<http://github.com/brimworks/lua-ev>.
		4250
		4251	=item Javascript
		4252
		4253	Node.js (L<http://nodejs.org>) uses libev as the underlying event library.
		4254
		4255	=item Others
		4256
		4257	There are others, and I stopped counting.
3342		4258
3343	=back	4259	=back
3344		4260
3345		4261
3346	=head1 MACRO MAGIC	4262	=head1 MACRO MAGIC
…		…
3360	loop argument"). The C<EV_A> form is used when this is the sole argument,	4276	loop argument"). The C<EV_A> form is used when this is the sole argument,
3361	C<EV_A_> is used when other arguments are following. Example:	4277	C<EV_A_> is used when other arguments are following. Example:
3362		4278
3363	ev_unref (EV_A);	4279	ev_unref (EV_A);
3364	ev_timer_add (EV_A_ watcher);	4280	ev_timer_add (EV_A_ watcher);
3365	ev_loop (EV_A_ 0);	4281	ev_run (EV_A_ 0);
3366		4282
3367	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,	4283	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,
3368	which is often provided by the following macro.	4284	which is often provided by the following macro.
3369		4285
3370	=item C<EV_P>, C<EV_P_>	4286	=item C<EV_P>, C<EV_P_>
…		…
3383	suitable for use with C<EV_A>.	4299	suitable for use with C<EV_A>.
3384		4300
3385	=item C<EV_DEFAULT>, C<EV_DEFAULT_>	4301	=item C<EV_DEFAULT>, C<EV_DEFAULT_>
3386		4302
3387	Similar to the other two macros, this gives you the value of the default	4303	Similar to the other two macros, this gives you the value of the default
3388	loop, if multiple loops are supported ("ev loop default").	4304	loop, if multiple loops are supported ("ev loop default"). The default loop
		4305	will be initialised if it isn't already initialised.
		4306
		4307	For non-multiplicity builds, these macros do nothing, so you always have
		4308	to initialise the loop somewhere.
3389		4309
3390	=item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_>	4310	=item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_>
3391		4311
3392	Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the	4312	Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the
3393	default loop has been initialised (C<UC> == unchecked). Their behaviour	4313	default loop has been initialised (C<UC> == unchecked). Their behaviour
…		…
3410	}	4330	}
3411		4331
3412	ev_check check;	4332	ev_check check;
3413	ev_check_init (&check, check_cb);	4333	ev_check_init (&check, check_cb);
3414	ev_check_start (EV_DEFAULT_ &check);	4334	ev_check_start (EV_DEFAULT_ &check);
3415	ev_loop (EV_DEFAULT_ 0);	4335	ev_run (EV_DEFAULT_ 0);
3416		4336
3417	=head1 EMBEDDING	4337	=head1 EMBEDDING
3418		4338
3419	Libev can (and often is) directly embedded into host	4339	Libev can (and often is) directly embedded into host
3420	applications. Examples of applications that embed it include the Deliantra	4340	applications. Examples of applications that embed it include the Deliantra
…		…
3500	libev.m4	4420	libev.m4
3501		4421
3502	=head2 PREPROCESSOR SYMBOLS/MACROS	4422	=head2 PREPROCESSOR SYMBOLS/MACROS
3503		4423
3504	Libev can be configured via a variety of preprocessor symbols you have to	4424	Libev can be configured via a variety of preprocessor symbols you have to
3505	define before including any of its files. The default in the absence of	4425	define before including (or compiling) any of its files. The default in
3506	autoconf is documented for every option.	4426	the absence of autoconf is documented for every option.
		4427
		4428	Symbols marked with "(h)" do not change the ABI, and can have different
		4429	values when compiling libev vs. including F<ev.h>, so it is permissible
		4430	to redefine them before including F<ev.h> without breaking compatibility
		4431	to a compiled library. All other symbols change the ABI, which means all
		4432	users of libev and the libev code itself must be compiled with compatible
		4433	settings.
3507		4434
3508	=over 4	4435	=over 4
3509		4436
		4437	=item EV_COMPAT3 (h)
		4438
		4439	Backwards compatibility is a major concern for libev. This is why this
		4440	release of libev comes with wrappers for the functions and symbols that
		4441	have been renamed between libev version 3 and 4.
		4442
		4443	You can disable these wrappers (to test compatibility with future
		4444	versions) by defining C<EV_COMPAT3> to C<0> when compiling your
		4445	sources. This has the additional advantage that you can drop the C<struct>
		4446	from C<struct ev_loop> declarations, as libev will provide an C<ev_loop>
		4447	typedef in that case.
		4448
		4449	In some future version, the default for C<EV_COMPAT3> will become C<0>,
		4450	and in some even more future version the compatibility code will be
		4451	removed completely.
		4452
3510	=item EV_STANDALONE	4453	=item EV_STANDALONE (h)
3511		4454
3512	Must always be C<1> if you do not use autoconf configuration, which	4455	Must always be C<1> if you do not use autoconf configuration, which
3513	keeps libev from including F<config.h>, and it also defines dummy	4456	keeps libev from including F<config.h>, and it also defines dummy
3514	implementations for some libevent functions (such as logging, which is not	4457	implementations for some libevent functions (such as logging, which is not
3515	supported). It will also not define any of the structs usually found in	4458	supported). It will also not define any of the structs usually found in
3516	F<event.h> that are not directly supported by the libev core alone.	4459	F<event.h> that are not directly supported by the libev core alone.
3517		4460
3518	In stanbdalone mode, libev will still try to automatically deduce the	4461	In standalone mode, libev will still try to automatically deduce the
3519	configuration, but has to be more conservative.	4462	configuration, but has to be more conservative.
		4463
		4464	=item EV_USE_FLOOR
		4465
		4466	If defined to be C<1>, libev will use the C<floor ()> function for its
		4467	periodic reschedule calculations, otherwise libev will fall back on a
		4468	portable (slower) implementation. If you enable this, you usually have to
		4469	link against libm or something equivalent. Enabling this when the C<floor>
		4470	function is not available will fail, so the safe default is to not enable
		4471	this.
3520		4472
3521	=item EV_USE_MONOTONIC	4473	=item EV_USE_MONOTONIC
3522		4474
3523	If defined to be C<1>, libev will try to detect the availability of the	4475	If defined to be C<1>, libev will try to detect the availability of the
3524	monotonic clock option at both compile time and runtime. Otherwise no	4476	monotonic clock option at both compile time and runtime. Otherwise no
…		…
3588	be used is the winsock select). This means that it will call	4540	be used is the winsock select). This means that it will call
3589	C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise,	4541	C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise,
3590	it is assumed that all these functions actually work on fds, even	4542	it is assumed that all these functions actually work on fds, even
3591	on win32. Should not be defined on non-win32 platforms.	4543	on win32. Should not be defined on non-win32 platforms.
3592		4544
3593	=item EV_FD_TO_WIN32_HANDLE	4545	=item EV_FD_TO_WIN32_HANDLE(fd)
3594		4546
3595	If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map	4547	If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map
3596	file descriptors to socket handles. When not defining this symbol (the	4548	file descriptors to socket handles. When not defining this symbol (the
3597	default), then libev will call C<_get_osfhandle>, which is usually	4549	default), then libev will call C<_get_osfhandle>, which is usually
3598	correct. In some cases, programs use their own file descriptor management,	4550	correct. In some cases, programs use their own file descriptor management,
3599	in which case they can provide this function to map fds to socket handles.	4551	in which case they can provide this function to map fds to socket handles.
		4552
		4553	=item EV_WIN32_HANDLE_TO_FD(handle)
		4554
		4555	If C<EV_SELECT_IS_WINSOCKET> then libev maps handles to file descriptors
		4556	using the standard C<_open_osfhandle> function. For programs implementing
		4557	their own fd to handle mapping, overwriting this function makes it easier
		4558	to do so. This can be done by defining this macro to an appropriate value.
		4559
		4560	=item EV_WIN32_CLOSE_FD(fd)
		4561
		4562	If programs implement their own fd to handle mapping on win32, then this
		4563	macro can be used to override the C<close> function, useful to unregister
		4564	file descriptors again. Note that the replacement function has to close
		4565	the underlying OS handle.
		4566
		4567	=item EV_USE_WSASOCKET
		4568
		4569	If defined to be C<1>, libev will use C<WSASocket> to create its internal
		4570	communication socket, which works better in some environments. Otherwise,
		4571	the normal C<socket> function will be used, which works better in other
		4572	environments.
3600		4573
3601	=item EV_USE_POLL	4574	=item EV_USE_POLL
3602		4575
3603	If defined to be C<1>, libev will compile in support for the C<poll>(2)	4576	If defined to be C<1>, libev will compile in support for the C<poll>(2)
3604	backend. Otherwise it will be enabled on non-win32 platforms. It	4577	backend. Otherwise it will be enabled on non-win32 platforms. It
…		…
3640	If defined to be C<1>, libev will compile in support for the Linux inotify	4613	If defined to be C<1>, libev will compile in support for the Linux inotify
3641	interface to speed up C<ev_stat> watchers. Its actual availability will	4614	interface to speed up C<ev_stat> watchers. Its actual availability will
3642	be detected at runtime. If undefined, it will be enabled if the headers	4615	be detected at runtime. If undefined, it will be enabled if the headers
3643	indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.	4616	indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
3644		4617
		4618	=item EV_NO_SMP
		4619
		4620	If defined to be C<1>, libev will assume that memory is always coherent
		4621	between threads, that is, threads can be used, but threads never run on
		4622	different cpus (or different cpu cores). This reduces dependencies
		4623	and makes libev faster.
		4624
		4625	=item EV_NO_THREADS
		4626
		4627	If defined to be C<1>, libev will assume that it will never be called from
		4628	different threads (that includes signal handlers), which is a stronger
		4629	assumption than C<EV_NO_SMP>, above. This reduces dependencies and makes
		4630	libev faster.
		4631
3645	=item EV_ATOMIC_T	4632	=item EV_ATOMIC_T
3646		4633
3647	Libev requires an integer type (suitable for storing C<0> or C<1>) whose	4634	Libev requires an integer type (suitable for storing C<0> or C<1>) whose
3648	access is atomic with respect to other threads or signal contexts. No such	4635	access is atomic with respect to other threads or signal contexts. No
3649	type is easily found in the C language, so you can provide your own type	4636	such type is easily found in the C language, so you can provide your own
3650	that you know is safe for your purposes. It is used both for signal handler "locking"	4637	type that you know is safe for your purposes. It is used both for signal
3651	as well as for signal and thread safety in C<ev_async> watchers.	4638	handler "locking" as well as for signal and thread safety in C<ev_async>
		4639	watchers.
3652		4640
3653	In the absence of this define, libev will use C<sig_atomic_t volatile>	4641	In the absence of this define, libev will use C<sig_atomic_t volatile>
3654	(from F<signal.h>), which is usually good enough on most platforms.	4642	(from F<signal.h>), which is usually good enough on most platforms.
3655		4643
3656	=item EV_H	4644	=item EV_H (h)
3657		4645
3658	The name of the F<ev.h> header file used to include it. The default if	4646	The name of the F<ev.h> header file used to include it. The default if
3659	undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be	4647	undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be
3660	used to virtually rename the F<ev.h> header file in case of conflicts.	4648	used to virtually rename the F<ev.h> header file in case of conflicts.
3661		4649
3662	=item EV_CONFIG_H	4650	=item EV_CONFIG_H (h)
3663		4651
3664	If C<EV_STANDALONE> isn't C<1>, this variable can be used to override	4652	If C<EV_STANDALONE> isn't C<1>, this variable can be used to override
3665	F<ev.c>'s idea of where to find the F<config.h> file, similarly to	4653	F<ev.c>'s idea of where to find the F<config.h> file, similarly to
3666	C<EV_H>, above.	4654	C<EV_H>, above.
3667		4655
3668	=item EV_EVENT_H	4656	=item EV_EVENT_H (h)
3669		4657
3670	Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea	4658	Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea
3671	of how the F<event.h> header can be found, the default is C<"event.h">.	4659	of how the F<event.h> header can be found, the default is C<"event.h">.
3672		4660
3673	=item EV_PROTOTYPES	4661	=item EV_PROTOTYPES (h)
3674		4662
3675	If defined to be C<0>, then F<ev.h> will not define any function	4663	If defined to be C<0>, then F<ev.h> will not define any function
3676	prototypes, but still define all the structs and other symbols. This is	4664	prototypes, but still define all the structs and other symbols. This is
3677	occasionally useful if you want to provide your own wrapper functions	4665	occasionally useful if you want to provide your own wrapper functions
3678	around libev functions.	4666	around libev functions.
…		…
3683	will have the C<struct ev_loop *> as first argument, and you can create	4671	will have the C<struct ev_loop *> as first argument, and you can create
3684	additional independent event loops. Otherwise there will be no support	4672	additional independent event loops. Otherwise there will be no support
3685	for multiple event loops and there is no first event loop pointer	4673	for multiple event loops and there is no first event loop pointer
3686	argument. Instead, all functions act on the single default loop.	4674	argument. Instead, all functions act on the single default loop.
3687		4675
		4676	Note that C<EV_DEFAULT> and C<EV_DEFAULT_> will no longer provide a
		4677	default loop when multiplicity is switched off - you always have to
		4678	initialise the loop manually in this case.
		4679
3688	=item EV_MINPRI	4680	=item EV_MINPRI
3689		4681
3690	=item EV_MAXPRI	4682	=item EV_MAXPRI
3691		4683
3692	The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to	4684	The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to
…		…
3700	fine.	4692	fine.
3701		4693
3702	If your embedding application does not need any priorities, defining these	4694	If your embedding application does not need any priorities, defining these
3703	both to C<0> will save some memory and CPU.	4695	both to C<0> will save some memory and CPU.
3704		4696
3705	=item EV_PERIODIC_ENABLE	4697	=item EV_PERIODIC_ENABLE, EV_IDLE_ENABLE, EV_EMBED_ENABLE, EV_STAT_ENABLE,
		4698	EV_PREPARE_ENABLE, EV_CHECK_ENABLE, EV_FORK_ENABLE, EV_SIGNAL_ENABLE,
		4699	EV_ASYNC_ENABLE, EV_CHILD_ENABLE.
3706		4700
3707	If undefined or defined to be C<1>, then periodic timers are supported. If	4701	If undefined or defined to be C<1> (and the platform supports it), then
3708	defined to be C<0>, then they are not. Disabling them saves a few kB of	4702	the respective watcher type is supported. If defined to be C<0>, then it
3709	code.	4703	is not. Disabling watcher types mainly saves code size.
3710		4704
3711	=item EV_IDLE_ENABLE	4705	=item EV_FEATURES
3712
3713	If undefined or defined to be C<1>, then idle watchers are supported. If
3714	defined to be C<0>, then they are not. Disabling them saves a few kB of
3715	code.
3716
3717	=item EV_EMBED_ENABLE
3718
3719	If undefined or defined to be C<1>, then embed watchers are supported. If
3720	defined to be C<0>, then they are not. Embed watchers rely on most other
3721	watcher types, which therefore must not be disabled.
3722
3723	=item EV_STAT_ENABLE
3724
3725	If undefined or defined to be C<1>, then stat watchers are supported. If
3726	defined to be C<0>, then they are not.
3727
3728	=item EV_FORK_ENABLE
3729
3730	If undefined or defined to be C<1>, then fork watchers are supported. If
3731	defined to be C<0>, then they are not.
3732
3733	=item EV_ASYNC_ENABLE
3734
3735	If undefined or defined to be C<1>, then async watchers are supported. If
3736	defined to be C<0>, then they are not.
3737
3738	=item EV_MINIMAL
3739		4706
3740	If you need to shave off some kilobytes of code at the expense of some	4707	If you need to shave off some kilobytes of code at the expense of some
3741	speed (but with the full API), define this symbol to C<1>. Currently this	4708	speed (but with the full API), you can define this symbol to request
3742	is used to override some inlining decisions, saves roughly 30% code size	4709	certain subsets of functionality. The default is to enable all features
3743	on amd64. It also selects a much smaller 2-heap for timer management over	4710	that can be enabled on the platform.
3744	the default 4-heap.
3745		4711
3746	You can save even more by disabling watcher types you do not need	4712	A typical way to use this symbol is to define it to C<0> (or to a bitset
3747	and setting C<EV_MAXPRI> == C<EV_MINPRI>. Also, disabling C<assert>	4713	with some broad features you want) and then selectively re-enable
3748	(C<-DNDEBUG>) will usually reduce code size a lot.	4714	additional parts you want, for example if you want everything minimal,
		4715	but multiple event loop support, async and child watchers and the poll
		4716	backend, use this:
3749		4717
3750	Defining C<EV_MINIMAL> to C<2> will additionally reduce the core API to	4718	#define EV_FEATURES 0
3751	provide a bare-bones event library. See C<ev.h> for details on what parts	4719	#define EV_MULTIPLICITY 1
3752	of the API are still available, and do not complain if this subset changes	4720	#define EV_USE_POLL 1
3753	over time.	4721	#define EV_CHILD_ENABLE 1
		4722	#define EV_ASYNC_ENABLE 1
		4723
		4724	The actual value is a bitset, it can be a combination of the following
		4725	values (by default, all of these are enabled):
		4726
		4727	=over 4
		4728
		4729	=item C<1> - faster/larger code
		4730
		4731	Use larger code to speed up some operations.
		4732
		4733	Currently this is used to override some inlining decisions (enlarging the
		4734	code size by roughly 30% on amd64).
		4735
		4736	When optimising for size, use of compiler flags such as C<-Os> with
		4737	gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of
		4738	assertions.
		4739
		4740	The default is off when C<__OPTIMIZE_SIZE__> is defined by your compiler
		4741	(e.g. gcc with C<-Os>).
		4742
		4743	=item C<2> - faster/larger data structures
		4744
		4745	Replaces the small 2-heap for timer management by a faster 4-heap, larger
		4746	hash table sizes and so on. This will usually further increase code size
		4747	and can additionally have an effect on the size of data structures at
		4748	runtime.
		4749
		4750	The default is off when C<__OPTIMIZE_SIZE__> is defined by your compiler
		4751	(e.g. gcc with C<-Os>).
		4752
		4753	=item C<4> - full API configuration
		4754
		4755	This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and
		4756	enables multiplicity (C<EV_MULTIPLICITY>=1).
		4757
		4758	=item C<8> - full API
		4759
		4760	This enables a lot of the "lesser used" API functions. See C<ev.h> for
		4761	details on which parts of the API are still available without this
		4762	feature, and do not complain if this subset changes over time.
		4763
		4764	=item C<16> - enable all optional watcher types
		4765
		4766	Enables all optional watcher types. If you want to selectively enable
		4767	only some watcher types other than I/O and timers (e.g. prepare,
		4768	embed, async, child...) you can enable them manually by defining
		4769	C<EV_watchertype_ENABLE> to C<1> instead.
		4770
		4771	=item C<32> - enable all backends
		4772
		4773	This enables all backends - without this feature, you need to enable at
		4774	least one backend manually (C<EV_USE_SELECT> is a good choice).
		4775
		4776	=item C<64> - enable OS-specific "helper" APIs
		4777
		4778	Enable inotify, eventfd, signalfd and similar OS-specific helper APIs by
		4779	default.
		4780
		4781	=back
		4782
		4783	Compiling with C<gcc -Os -DEV_STANDALONE -DEV_USE_EPOLL=1 -DEV_FEATURES=0>
		4784	reduces the compiled size of libev from 24.7Kb code/2.8Kb data to 6.5Kb
		4785	code/0.3Kb data on my GNU/Linux amd64 system, while still giving you I/O
		4786	watchers, timers and monotonic clock support.
		4787
		4788	With an intelligent-enough linker (gcc+binutils are intelligent enough
		4789	when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by
		4790	your program might be left out as well - a binary starting a timer and an
		4791	I/O watcher then might come out at only 5Kb.
		4792
		4793	=item EV_API_STATIC
		4794
		4795	If this symbol is defined (by default it is not), then all identifiers
		4796	will have static linkage. This means that libev will not export any
		4797	identifiers, and you cannot link against libev anymore. This can be useful
		4798	when you embed libev, only want to use libev functions in a single file,
		4799	and do not want its identifiers to be visible.
		4800
		4801	To use this, define C<EV_API_STATIC> and include F<ev.c> in the file that
		4802	wants to use libev.
		4803
		4804	This option only works when libev is compiled with a C compiler, as C++
		4805	doesn't support the required declaration syntax.
		4806
		4807	=item EV_AVOID_STDIO
		4808
		4809	If this is set to C<1> at compiletime, then libev will avoid using stdio
		4810	functions (printf, scanf, perror etc.). This will increase the code size
		4811	somewhat, but if your program doesn't otherwise depend on stdio and your
		4812	libc allows it, this avoids linking in the stdio library which is quite
		4813	big.
		4814
		4815	Note that error messages might become less precise when this option is
		4816	enabled.
		4817
		4818	=item EV_NSIG
		4819
		4820	The highest supported signal number, +1 (or, the number of
		4821	signals): Normally, libev tries to deduce the maximum number of signals
		4822	automatically, but sometimes this fails, in which case it can be
		4823	specified. Also, using a lower number than detected (C<32> should be
		4824	good for about any system in existence) can save some memory, as libev
		4825	statically allocates some 12-24 bytes per signal number.
3754		4826
3755	=item EV_PID_HASHSIZE	4827	=item EV_PID_HASHSIZE
3756		4828
3757	C<ev_child> watchers use a small hash table to distribute workload by	4829	C<ev_child> watchers use a small hash table to distribute workload by
3758	pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more	4830	pid. The default size is C<16> (or C<1> with C<EV_FEATURES> disabled),
3759	than enough. If you need to manage thousands of children you might want to	4831	usually more than enough. If you need to manage thousands of children you
3760	increase this value (I<must> be a power of two).	4832	might want to increase this value (I<must> be a power of two).
3761		4833
3762	=item EV_INOTIFY_HASHSIZE	4834	=item EV_INOTIFY_HASHSIZE
3763		4835
3764	C<ev_stat> watchers use a small hash table to distribute workload by	4836	C<ev_stat> watchers use a small hash table to distribute workload by
3765	inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>),	4837	inotify watch id. The default size is C<16> (or C<1> with C<EV_FEATURES>
3766	usually more than enough. If you need to manage thousands of C<ev_stat>	4838	disabled), usually more than enough. If you need to manage thousands of
3767	watchers you might want to increase this value (I<must> be a power of	4839	C<ev_stat> watchers you might want to increase this value (I<must> be a
3768	two).	4840	power of two).
3769		4841
3770	=item EV_USE_4HEAP	4842	=item EV_USE_4HEAP
3771		4843
3772	Heaps are not very cache-efficient. To improve the cache-efficiency of the	4844	Heaps are not very cache-efficient. To improve the cache-efficiency of the
3773	timer and periodics heaps, libev uses a 4-heap when this symbol is defined	4845	timer and periodics heaps, libev uses a 4-heap when this symbol is defined
3774	to C<1>. The 4-heap uses more complicated (longer) code but has noticeably	4846	to C<1>. The 4-heap uses more complicated (longer) code but has noticeably
3775	faster performance with many (thousands) of watchers.	4847	faster performance with many (thousands) of watchers.
3776		4848
3777	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>	4849	The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
3778	(disabled).	4850	will be C<0>.
3779		4851
3780	=item EV_HEAP_CACHE_AT	4852	=item EV_HEAP_CACHE_AT
3781		4853
3782	Heaps are not very cache-efficient. To improve the cache-efficiency of the	4854	Heaps are not very cache-efficient. To improve the cache-efficiency of the
3783	timer and periodics heaps, libev can cache the timestamp (I<at>) within	4855	timer and periodics heaps, libev can cache the timestamp (I<at>) within
3784	the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>),	4856	the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>),
3785	which uses 8-12 bytes more per watcher and a few hundred bytes more code,	4857	which uses 8-12 bytes more per watcher and a few hundred bytes more code,
3786	but avoids random read accesses on heap changes. This improves performance	4858	but avoids random read accesses on heap changes. This improves performance
3787	noticeably with many (hundreds) of watchers.	4859	noticeably with many (hundreds) of watchers.
3788		4860
3789	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>	4861	The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
3790	(disabled).	4862	will be C<0>.
3791		4863
3792	=item EV_VERIFY	4864	=item EV_VERIFY
3793		4865
3794	Controls how much internal verification (see C<ev_loop_verify ()>) will	4866	Controls how much internal verification (see C<ev_verify ()>) will
3795	be done: If set to C<0>, no internal verification code will be compiled	4867	be done: If set to C<0>, no internal verification code will be compiled
3796	in. If set to C<1>, then verification code will be compiled in, but not	4868	in. If set to C<1>, then verification code will be compiled in, but not
3797	called. If set to C<2>, then the internal verification code will be	4869	called. If set to C<2>, then the internal verification code will be
3798	called once per loop, which can slow down libev. If set to C<3>, then the	4870	called once per loop, which can slow down libev. If set to C<3>, then the
3799	verification code will be called very frequently, which will slow down	4871	verification code will be called very frequently, which will slow down
3800	libev considerably.	4872	libev considerably.
3801		4873
3802	The default is C<1>, unless C<EV_MINIMAL> is set, in which case it will be	4874	The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
3803	C<0>.	4875	will be C<0>.
3804		4876
3805	=item EV_COMMON	4877	=item EV_COMMON
3806		4878
3807	By default, all watchers have a C<void *data> member. By redefining	4879	By default, all watchers have a C<void *data> member. By redefining
3808	this macro to a something else you can include more and other types of	4880	this macro to something else you can include more and other types of
3809	members. You have to define it each time you include one of the files,	4881	members. You have to define it each time you include one of the files,
3810	though, and it must be identical each time.	4882	though, and it must be identical each time.
3811		4883
3812	For example, the perl EV module uses something like this:	4884	For example, the perl EV module uses something like this:
3813		4885
…		…
3866	file.	4938	file.
3867		4939
3868	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file	4940	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file
3869	that everybody includes and which overrides some configure choices:	4941	that everybody includes and which overrides some configure choices:
3870		4942
3871	#define EV_MINIMAL 1	4943	#define EV_FEATURES 8
3872	#define EV_USE_POLL 0	4944	#define EV_USE_SELECT 1
3873	#define EV_MULTIPLICITY 0
3874	#define EV_PERIODIC_ENABLE 0	4945	#define EV_PREPARE_ENABLE 1
		4946	#define EV_IDLE_ENABLE 1
3875	#define EV_STAT_ENABLE 0	4947	#define EV_SIGNAL_ENABLE 1
3876	#define EV_FORK_ENABLE 0	4948	#define EV_CHILD_ENABLE 1
		4949	#define EV_USE_STDEXCEPT 0
3877	#define EV_CONFIG_H <config.h>	4950	#define EV_CONFIG_H <config.h>
3878	#define EV_MINPRI 0
3879	#define EV_MAXPRI 0
3880		4951
3881	#include "ev++.h"	4952	#include "ev++.h"
3882		4953
3883	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:	4954	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
3884		4955
3885	#include "ev_cpp.h"	4956	#include "ev_cpp.h"
3886	#include "ev.c"	4957	#include "ev.c"
3887		4958
3888	=head1 INTERACTION WITH OTHER PROGRAMS OR LIBRARIES	4959	=head1 INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT
3889		4960
3890	=head2 THREADS AND COROUTINES	4961	=head2 THREADS AND COROUTINES
3891		4962
3892	=head3 THREADS	4963	=head3 THREADS
3893		4964
…		…
3944	default loop and triggering an C<ev_async> watcher from the default loop	5015	default loop and triggering an C<ev_async> watcher from the default loop
3945	watcher callback into the event loop interested in the signal.	5016	watcher callback into the event loop interested in the signal.
3946		5017
3947	=back	5018	=back
3948		5019
3949	=head4 THREAD LOCKING EXAMPLE	5020	See also L</THREAD LOCKING EXAMPLE>.
3950
3951	Here is a fictitious example of how to run an event loop in a different
3952	thread than where callbacks are being invoked and watchers are
3953	created/added/removed.
3954
3955	For a real-world example, see the C<EV::Loop::Async> perl module,
3956	which uses exactly this technique (which is suited for many high-level
3957	languages).
3958
3959	The example uses a pthread mutex to protect the loop data, a condition
3960	variable to wait for callback invocations, an async watcher to notify the
3961	event loop thread and an unspecified mechanism to wake up the main thread.
3962
3963	First, you need to associate some data with the event loop:
3964
3965	typedef struct {
3966	mutex_t lock; /* global loop lock */
3967	ev_async async_w;
3968	thread_t tid;
3969	cond_t invoke_cv;
3970	} userdata;
3971
3972	void prepare_loop (EV_P)
3973	{
3974	// for simplicity, we use a static userdata struct.
3975	static userdata u;
3976
3977	ev_async_init (&u->async_w, async_cb);
3978	ev_async_start (EV_A_ &u->async_w);
3979
3980	pthread_mutex_init (&u->lock, 0);
3981	pthread_cond_init (&u->invoke_cv, 0);
3982
3983	// now associate this with the loop
3984	ev_set_userdata (EV_A_ u);
3985	ev_set_invoke_pending_cb (EV_A_ l_invoke);
3986	ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
3987
3988	// then create the thread running ev_loop
3989	pthread_create (&u->tid, 0, l_run, EV_A);
3990	}
3991
3992	The callback for the C<ev_async> watcher does nothing: the watcher is used
3993	solely to wake up the event loop so it takes notice of any new watchers
3994	that might have been added:
3995
3996	static void
3997	async_cb (EV_P_ ev_async *w, int revents)
3998	{
3999	// just used for the side effects
4000	}
4001
4002	The C<l_release> and C<l_acquire> callbacks simply unlock/lock the mutex
4003	protecting the loop data, respectively.
4004
4005	static void
4006	l_release (EV_P)
4007	{
4008	userdata *u = ev_userdata (EV_A);
4009	pthread_mutex_unlock (&u->lock);
4010	}
4011
4012	static void
4013	l_acquire (EV_P)
4014	{
4015	userdata *u = ev_userdata (EV_A);
4016	pthread_mutex_lock (&u->lock);
4017	}
4018
4019	The event loop thread first acquires the mutex, and then jumps straight
4020	into C<ev_loop>:
4021
4022	void *
4023	l_run (void *thr_arg)
4024	{
4025	struct ev_loop *loop = (struct ev_loop *)thr_arg;
4026
4027	l_acquire (EV_A);
4028	pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
4029	ev_loop (EV_A_ 0);
4030	l_release (EV_A);
4031
4032	return 0;
4033	}
4034
4035	Instead of invoking all pending watchers, the C<l_invoke> callback will
4036	signal the main thread via some unspecified mechanism (signals? pipe
4037	writes? C<Async::Interrupt>?) and then waits until all pending watchers
4038	have been called (in a while loop because a) spurious wakeups are possible
4039	and b) skipping inter-thread-communication when there are no pending
4040	watchers is very beneficial):
4041
4042	static void
4043	l_invoke (EV_P)
4044	{
4045	userdata *u = ev_userdata (EV_A);
4046
4047	while (ev_pending_count (EV_A))
4048	{
4049	wake_up_other_thread_in_some_magic_or_not_so_magic_way ();
4050	pthread_cond_wait (&u->invoke_cv, &u->lock);
4051	}
4052	}
4053
4054	Now, whenever the main thread gets told to invoke pending watchers, it
4055	will grab the lock, call C<ev_invoke_pending> and then signal the loop
4056	thread to continue:
4057
4058	static void
4059	real_invoke_pending (EV_P)
4060	{
4061	userdata *u = ev_userdata (EV_A);
4062
4063	pthread_mutex_lock (&u->lock);
4064	ev_invoke_pending (EV_A);
4065	pthread_cond_signal (&u->invoke_cv);
4066	pthread_mutex_unlock (&u->lock);
4067	}
4068
4069	Whenever you want to start/stop a watcher or do other modifications to an
4070	event loop, you will now have to lock:
4071
4072	ev_timer timeout_watcher;
4073	userdata *u = ev_userdata (EV_A);
4074
4075	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
4076
4077	pthread_mutex_lock (&u->lock);
4078	ev_timer_start (EV_A_ &timeout_watcher);
4079	ev_async_send (EV_A_ &u->async_w);
4080	pthread_mutex_unlock (&u->lock);
4081
4082	Note that sending the C<ev_async> watcher is required because otherwise
4083	an event loop currently blocking in the kernel will have no knowledge
4084	about the newly added timer. By waking up the loop it will pick up any new
4085	watchers in the next event loop iteration.
4086		5021
4087	=head3 COROUTINES	5022	=head3 COROUTINES
4088		5023
4089	Libev is very accommodating to coroutines ("cooperative threads"):	5024	Libev is very accommodating to coroutines ("cooperative threads"):
4090	libev fully supports nesting calls to its functions from different	5025	libev fully supports nesting calls to its functions from different
4091	coroutines (e.g. you can call C<ev_loop> on the same loop from two	5026	coroutines (e.g. you can call C<ev_run> on the same loop from two
4092	different coroutines, and switch freely between both coroutines running	5027	different coroutines, and switch freely between both coroutines running
4093	the loop, as long as you don't confuse yourself). The only exception is	5028	the loop, as long as you don't confuse yourself). The only exception is
4094	that you must not do this from C<ev_periodic> reschedule callbacks.	5029	that you must not do this from C<ev_periodic> reschedule callbacks.
4095		5030
4096	Care has been taken to ensure that libev does not keep local state inside	5031	Care has been taken to ensure that libev does not keep local state inside
4097	C<ev_loop>, and other calls do not usually allow for coroutine switches as	5032	C<ev_run>, and other calls do not usually allow for coroutine switches as
4098	they do not call any callbacks.	5033	they do not call any callbacks.
4099		5034
4100	=head2 COMPILER WARNINGS	5035	=head2 COMPILER WARNINGS
4101		5036
4102	Depending on your compiler and compiler settings, you might get no or a	5037	Depending on your compiler and compiler settings, you might get no or a
…		…
4113	maintainable.	5048	maintainable.
4114		5049
4115	And of course, some compiler warnings are just plain stupid, or simply	5050	And of course, some compiler warnings are just plain stupid, or simply
4116	wrong (because they don't actually warn about the condition their message	5051	wrong (because they don't actually warn about the condition their message
4117	seems to warn about). For example, certain older gcc versions had some	5052	seems to warn about). For example, certain older gcc versions had some
4118	warnings that resulted an extreme number of false positives. These have	5053	warnings that resulted in an extreme number of false positives. These have
4119	been fixed, but some people still insist on making code warn-free with	5054	been fixed, but some people still insist on making code warn-free with
4120	such buggy versions.	5055	such buggy versions.
4121		5056
4122	While libev is written to generate as few warnings as possible,	5057	While libev is written to generate as few warnings as possible,
4123	"warn-free" code is not a goal, and it is recommended not to build libev	5058	"warn-free" code is not a goal, and it is recommended not to build libev
…		…
4159	I suggest using suppression lists.	5094	I suggest using suppression lists.
4160		5095
4161		5096
4162	=head1 PORTABILITY NOTES	5097	=head1 PORTABILITY NOTES
4163		5098
		5099	=head2 GNU/LINUX 32 BIT LIMITATIONS
		5100
		5101	GNU/Linux is the only common platform that supports 64 bit file/large file
		5102	interfaces but I<disables> them by default.
		5103
		5104	That means that libev compiled in the default environment doesn't support
		5105	files larger than 2GiB or so, which mainly affects C<ev_stat> watchers.
		5106
		5107	Unfortunately, many programs try to work around this GNU/Linux issue
		5108	by enabling the large file API, which makes them incompatible with the
		5109	standard libev compiled for their system.
		5110
		5111	Likewise, libev cannot enable the large file API itself as this would
		5112	suddenly make it incompatible to the default compile time environment,
		5113	i.e. all programs not using special compile switches.
		5114
		5115	=head2 OS/X AND DARWIN BUGS
		5116
		5117	The whole thing is a bug if you ask me - basically any system interface
		5118	you touch is broken, whether it is locales, poll, kqueue or even the
		5119	OpenGL drivers.
		5120
		5121	=head3 C<kqueue> is buggy
		5122
		5123	The kqueue syscall is broken in all known versions - most versions support
		5124	only sockets, many support pipes.
		5125
		5126	Libev tries to work around this by not using C<kqueue> by default on this
		5127	rotten platform, but of course you can still ask for it when creating a
		5128	loop - embedding a socket-only kqueue loop into a select-based one is
		5129	probably going to work well.
		5130
		5131	=head3 C<poll> is buggy
		5132
		5133	Instead of fixing C<kqueue>, Apple replaced their (working) C<poll>
		5134	implementation by something calling C<kqueue> internally around the 10.5.6
		5135	release, so now C<kqueue> I<and> C<poll> are broken.
		5136
		5137	Libev tries to work around this by not using C<poll> by default on
		5138	this rotten platform, but of course you can still ask for it when creating
		5139	a loop.
		5140
		5141	=head3 C<select> is buggy
		5142
		5143	All that's left is C<select>, and of course Apple found a way to fuck this
		5144	one up as well: On OS/X, C<select> actively limits the number of file
		5145	descriptors you can pass in to 1024 - your program suddenly crashes when
		5146	you use more.
		5147
		5148	There is an undocumented "workaround" for this - defining
		5149	C<_DARWIN_UNLIMITED_SELECT>, which libev tries to use, so select I<should>
		5150	work on OS/X.
		5151
		5152	=head2 SOLARIS PROBLEMS AND WORKAROUNDS
		5153
		5154	=head3 C<errno> reentrancy
		5155
		5156	The default compile environment on Solaris is unfortunately so
		5157	thread-unsafe that you can't even use components/libraries compiled
		5158	without C<-D_REENTRANT> in a threaded program, which, of course, isn't
		5159	defined by default. A valid, if stupid, implementation choice.
		5160
		5161	If you want to use libev in threaded environments you have to make sure
		5162	it's compiled with C<_REENTRANT> defined.
		5163
		5164	=head3 Event port backend
		5165
		5166	The scalable event interface for Solaris is called "event
		5167	ports". Unfortunately, this mechanism is very buggy in all major
		5168	releases. If you run into high CPU usage, your program freezes or you get
		5169	a large number of spurious wakeups, make sure you have all the relevant
		5170	and latest kernel patches applied. No, I don't know which ones, but there
		5171	are multiple ones to apply, and afterwards, event ports actually work
		5172	great.
		5173
		5174	If you can't get it to work, you can try running the program by setting
		5175	the environment variable C<LIBEV_FLAGS=3> to only allow C<poll> and
		5176	C<select> backends.
		5177
		5178	=head2 AIX POLL BUG
		5179
		5180	AIX unfortunately has a broken C<poll.h> header. Libev works around
		5181	this by trying to avoid the poll backend altogether (i.e. it's not even
		5182	compiled in), which normally isn't a big problem as C<select> works fine
		5183	with large bitsets on AIX, and AIX is dead anyway.
		5184
4164	=head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS	5185	=head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS
		5186
		5187	=head3 General issues
4165		5188
4166	Win32 doesn't support any of the standards (e.g. POSIX) that libev	5189	Win32 doesn't support any of the standards (e.g. POSIX) that libev
4167	requires, and its I/O model is fundamentally incompatible with the POSIX	5190	requires, and its I/O model is fundamentally incompatible with the POSIX
4168	model. Libev still offers limited functionality on this platform in	5191	model. Libev still offers limited functionality on this platform in
4169	the form of the C<EVBACKEND_SELECT> backend, and only supports socket	5192	the form of the C<EVBACKEND_SELECT> backend, and only supports socket
4170	descriptors. This only applies when using Win32 natively, not when using	5193	descriptors. This only applies when using Win32 natively, not when using
4171	e.g. cygwin.	5194	e.g. cygwin. Actually, it only applies to the microsofts own compilers,
		5195	as every compiler comes with a slightly differently broken/incompatible
		5196	environment.
4172		5197
4173	Lifting these limitations would basically require the full	5198	Lifting these limitations would basically require the full
4174	re-implementation of the I/O system. If you are into these kinds of	5199	re-implementation of the I/O system. If you are into this kind of thing,
4175	things, then note that glib does exactly that for you in a very portable	5200	then note that glib does exactly that for you in a very portable way (note
4176	way (note also that glib is the slowest event library known to man).	5201	also that glib is the slowest event library known to man).
4177		5202
4178	There is no supported compilation method available on windows except	5203	There is no supported compilation method available on windows except
4179	embedding it into other applications.	5204	embedding it into other applications.
4180		5205
4181	Sensible signal handling is officially unsupported by Microsoft - libev	5206	Sensible signal handling is officially unsupported by Microsoft - libev
…		…
4209	you do I<not> compile the F<ev.c> or any other embedded source files!):	5234	you do I<not> compile the F<ev.c> or any other embedded source files!):
4210		5235
4211	#include "evwrap.h"	5236	#include "evwrap.h"
4212	#include "ev.c"	5237	#include "ev.c"
4213		5238
4214	=over 4
4215
4216	=item The winsocket select function	5239	=head3 The winsocket C<select> function
4217		5240
4218	The winsocket C<select> function doesn't follow POSIX in that it	5241	The winsocket C<select> function doesn't follow POSIX in that it
4219	requires socket I<handles> and not socket I<file descriptors> (it is	5242	requires socket I<handles> and not socket I<file descriptors> (it is
4220	also extremely buggy). This makes select very inefficient, and also	5243	also extremely buggy). This makes select very inefficient, and also
4221	requires a mapping from file descriptors to socket handles (the Microsoft	5244	requires a mapping from file descriptors to socket handles (the Microsoft
…		…
4230	#define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */	5253	#define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */
4231		5254
4232	Note that winsockets handling of fd sets is O(n), so you can easily get a	5255	Note that winsockets handling of fd sets is O(n), so you can easily get a
4233	complexity in the O(n²) range when using win32.	5256	complexity in the O(n²) range when using win32.
4234		5257
4235	=item Limited number of file descriptors	5258	=head3 Limited number of file descriptors
4236		5259
4237	Windows has numerous arbitrary (and low) limits on things.	5260	Windows has numerous arbitrary (and low) limits on things.
4238		5261
4239	Early versions of winsocket's select only supported waiting for a maximum	5262	Early versions of winsocket's select only supported waiting for a maximum
4240	of C<64> handles (probably owning to the fact that all windows kernels	5263	of C<64> handles (probably owning to the fact that all windows kernels
…		…
4255	runtime libraries. This might get you to about C<512> or C<2048> sockets	5278	runtime libraries. This might get you to about C<512> or C<2048> sockets
4256	(depending on windows version and/or the phase of the moon). To get more,	5279	(depending on windows version and/or the phase of the moon). To get more,
4257	you need to wrap all I/O functions and provide your own fd management, but	5280	you need to wrap all I/O functions and provide your own fd management, but
4258	the cost of calling select (O(n²)) will likely make this unworkable.	5281	the cost of calling select (O(n²)) will likely make this unworkable.
4259		5282
4260	=back
4261
4262	=head2 PORTABILITY REQUIREMENTS	5283	=head2 PORTABILITY REQUIREMENTS
4263		5284
4264	In addition to a working ISO-C implementation and of course the	5285	In addition to a working ISO-C implementation and of course the
4265	backend-specific APIs, libev relies on a few additional extensions:	5286	backend-specific APIs, libev relies on a few additional extensions:
4266		5287
…		…
4272	Libev assumes not only that all watcher pointers have the same internal	5293	Libev assumes not only that all watcher pointers have the same internal
4273	structure (guaranteed by POSIX but not by ISO C for example), but it also	5294	structure (guaranteed by POSIX but not by ISO C for example), but it also
4274	assumes that the same (machine) code can be used to call any watcher	5295	assumes that the same (machine) code can be used to call any watcher
4275	callback: The watcher callbacks have different type signatures, but libev	5296	callback: The watcher callbacks have different type signatures, but libev
4276	calls them using an C<ev_watcher *> internally.	5297	calls them using an C<ev_watcher *> internally.
		5298
		5299	=item pointer accesses must be thread-atomic
		5300
		5301	Accessing a pointer value must be atomic, it must both be readable and
		5302	writable in one piece - this is the case on all current architectures.
4277		5303
4278	=item C<sig_atomic_t volatile> must be thread-atomic as well	5304	=item C<sig_atomic_t volatile> must be thread-atomic as well
4279		5305
4280	The type C<sig_atomic_t volatile> (or whatever is defined as	5306	The type C<sig_atomic_t volatile> (or whatever is defined as
4281	C<EV_ATOMIC_T>) must be atomic with respect to accesses from different	5307	C<EV_ATOMIC_T>) must be atomic with respect to accesses from different
…		…
4290	thread" or will block signals process-wide, both behaviours would	5316	thread" or will block signals process-wide, both behaviours would
4291	be compatible with libev. Interaction between C<sigprocmask> and	5317	be compatible with libev. Interaction between C<sigprocmask> and
4292	C<pthread_sigmask> could complicate things, however.	5318	C<pthread_sigmask> could complicate things, however.
4293		5319
4294	The most portable way to handle signals is to block signals in all threads	5320	The most portable way to handle signals is to block signals in all threads
4295	except the initial one, and run the default loop in the initial thread as	5321	except the initial one, and run the signal handling loop in the initial
4296	well.	5322	thread as well.
4297		5323
4298	=item C<long> must be large enough for common memory allocation sizes	5324	=item C<long> must be large enough for common memory allocation sizes
4299		5325
4300	To improve portability and simplify its API, libev uses C<long> internally	5326	To improve portability and simplify its API, libev uses C<long> internally
4301	instead of C<size_t> when allocating its data structures. On non-POSIX	5327	instead of C<size_t> when allocating its data structures. On non-POSIX
…		…
4304	watchers.	5330	watchers.
4305		5331
4306	=item C<double> must hold a time value in seconds with enough accuracy	5332	=item C<double> must hold a time value in seconds with enough accuracy
4307		5333
4308	The type C<double> is used to represent timestamps. It is required to	5334	The type C<double> is used to represent timestamps. It is required to
4309	have at least 51 bits of mantissa (and 9 bits of exponent), which is good	5335	have at least 51 bits of mantissa (and 9 bits of exponent), which is
4310	enough for at least into the year 4000. This requirement is fulfilled by	5336	good enough for at least into the year 4000 with millisecond accuracy
		5337	(the design goal for libev). This requirement is overfulfilled by
4311	implementations implementing IEEE 754, which is basically all existing	5338	implementations using IEEE 754, which is basically all existing ones.
		5339
4312	ones. With IEEE 754 doubles, you get microsecond accuracy until at least	5340	With IEEE 754 doubles, you get microsecond accuracy until at least the
4313	2200.	5341	year 2255 (and millisecond accuracy till the year 287396 - by then, libev
		5342	is either obsolete or somebody patched it to use C<long double> or
		5343	something like that, just kidding).
4314		5344
4315	=back	5345	=back
4316		5346
4317	If you know of other additional requirements drop me a note.	5347	If you know of other additional requirements drop me a note.
4318		5348
…		…
4380	=item Processing ev_async_send: O(number_of_async_watchers)	5410	=item Processing ev_async_send: O(number_of_async_watchers)
4381		5411
4382	=item Processing signals: O(max_signal_number)	5412	=item Processing signals: O(max_signal_number)
4383		5413
4384	Sending involves a system call I<iff> there were no other C<ev_async_send>	5414	Sending involves a system call I<iff> there were no other C<ev_async_send>
4385	calls in the current loop iteration. Checking for async and signal events	5415	calls in the current loop iteration and the loop is currently
		5416	blocked. Checking for async and signal events involves iterating over all
4386	involves iterating over all running async watchers or all signal numbers.	5417	running async watchers or all signal numbers.
4387		5418
4388	=back	5419	=back
4389		5420
4390		5421
		5422	=head1 PORTING FROM LIBEV 3.X TO 4.X
		5423
		5424	The major version 4 introduced some incompatible changes to the API.
		5425
		5426	At the moment, the C<ev.h> header file provides compatibility definitions
		5427	for all changes, so most programs should still compile. The compatibility
		5428	layer might be removed in later versions of libev, so better update to the
		5429	new API early than late.
		5430
		5431	=over 4
		5432
		5433	=item C<EV_COMPAT3> backwards compatibility mechanism
		5434
		5435	The backward compatibility mechanism can be controlled by
		5436	C<EV_COMPAT3>. See L</"PREPROCESSOR SYMBOLS/MACROS"> in the L</EMBEDDING>
		5437	section.
		5438
		5439	=item C<ev_default_destroy> and C<ev_default_fork> have been removed
		5440
		5441	These calls can be replaced easily by their C<ev_loop_xxx> counterparts:
		5442
		5443	ev_loop_destroy (EV_DEFAULT_UC);
		5444	ev_loop_fork (EV_DEFAULT);
		5445
		5446	=item function/symbol renames
		5447
		5448	A number of functions and symbols have been renamed:
		5449
		5450	ev_loop => ev_run
		5451	EVLOOP_NONBLOCK => EVRUN_NOWAIT
		5452	EVLOOP_ONESHOT => EVRUN_ONCE
		5453
		5454	ev_unloop => ev_break
		5455	EVUNLOOP_CANCEL => EVBREAK_CANCEL
		5456	EVUNLOOP_ONE => EVBREAK_ONE
		5457	EVUNLOOP_ALL => EVBREAK_ALL
		5458
		5459	EV_TIMEOUT => EV_TIMER
		5460
		5461	ev_loop_count => ev_iteration
		5462	ev_loop_depth => ev_depth
		5463	ev_loop_verify => ev_verify
		5464
		5465	Most functions working on C<struct ev_loop> objects don't have an
		5466	C<ev_loop_> prefix, so it was removed; C<ev_loop>, C<ev_unloop> and
		5467	associated constants have been renamed to not collide with the C<struct
		5468	ev_loop> anymore and C<EV_TIMER> now follows the same naming scheme
		5469	as all other watcher types. Note that C<ev_loop_fork> is still called
		5470	C<ev_loop_fork> because it would otherwise clash with the C<ev_fork>
		5471	typedef.
		5472
		5473	=item C<EV_MINIMAL> mechanism replaced by C<EV_FEATURES>
		5474
		5475	The preprocessor symbol C<EV_MINIMAL> has been replaced by a different
		5476	mechanism, C<EV_FEATURES>. Programs using C<EV_MINIMAL> usually compile
		5477	and work, but the library code will of course be larger.
		5478
		5479	=back
		5480
		5481
4391	=head1 GLOSSARY	5482	=head1 GLOSSARY
4392		5483
4393	=over 4	5484	=over 4
4394		5485
4395	=item active	5486	=item active
4396		5487
4397	A watcher is active as long as it has been started (has been attached to	5488	A watcher is active as long as it has been started and not yet stopped.
4398	an event loop) but not yet stopped (disassociated from the event loop).	5489	See L</WATCHER STATES> for details.
4399		5490
4400	=item application	5491	=item application
4401		5492
4402	In this document, an application is whatever is using libev.	5493	In this document, an application is whatever is using libev.
		5494
		5495	=item backend
		5496
		5497	The part of the code dealing with the operating system interfaces.
4403		5498
4404	=item callback	5499	=item callback
4405		5500
4406	The address of a function that is called when some event has been	5501	The address of a function that is called when some event has been
4407	detected. Callbacks are being passed the event loop, the watcher that	5502	detected. Callbacks are being passed the event loop, the watcher that
4408	received the event, and the actual event bitset.	5503	received the event, and the actual event bitset.
4409		5504
4410	=item callback invocation	5505	=item callback/watcher invocation
4411		5506
4412	The act of calling the callback associated with a watcher.	5507	The act of calling the callback associated with a watcher.
4413		5508
4414	=item event	5509	=item event
4415		5510
4416	A change of state of some external event, such as data now being available	5511	A change of state of some external event, such as data now being available
4417	for reading on a file descriptor, time having passed or simply not having	5512	for reading on a file descriptor, time having passed or simply not having
4418	any other events happening anymore.	5513	any other events happening anymore.
4419		5514
4420	In libev, events are represented as single bits (such as C<EV_READ> or	5515	In libev, events are represented as single bits (such as C<EV_READ> or
4421	C<EV_TIMEOUT>).	5516	C<EV_TIMER>).
4422		5517
4423	=item event library	5518	=item event library
4424		5519
4425	A software package implementing an event model and loop.	5520	A software package implementing an event model and loop.
4426		5521
…		…
4434	The model used to describe how an event loop handles and processes	5529	The model used to describe how an event loop handles and processes
4435	watchers and events.	5530	watchers and events.
4436		5531
4437	=item pending	5532	=item pending
4438		5533
4439	A watcher is pending as soon as the corresponding event has been detected,	5534	A watcher is pending as soon as the corresponding event has been
4440	and stops being pending as soon as the watcher will be invoked or its	5535	detected. See L</WATCHER STATES> for details.
4441	pending status is explicitly cleared by the application.
4442
4443	A watcher can be pending, but not active. Stopping a watcher also clears
4444	its pending status.
4445		5536
4446	=item real time	5537	=item real time
4447		5538
4448	The physical time that is observed. It is apparently strictly monotonic :)	5539	The physical time that is observed. It is apparently strictly monotonic :)
4449		5540
4450	=item wall-clock time	5541	=item wall-clock time
4451		5542
4452	The time and date as shown on clocks. Unlike real time, it can actually	5543	The time and date as shown on clocks. Unlike real time, it can actually
4453	be wrong and jump forwards and backwards, e.g. when the you adjust your	5544	be wrong and jump forwards and backwards, e.g. when you adjust your
4454	clock.	5545	clock.
4455		5546
4456	=item watcher	5547	=item watcher
4457		5548
4458	A data structure that describes interest in certain events. Watchers need	5549	A data structure that describes interest in certain events. Watchers need
4459	to be started (attached to an event loop) before they can receive events.	5550	to be started (attached to an event loop) before they can receive events.
4460		5551
4461	=item watcher invocation
4462
4463	The act of calling the callback associated with a watcher.
4464
4465	=back	5552	=back
4466		5553
4467	=head1 AUTHOR	5554	=head1 AUTHOR
4468		5555
4469	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson.	5556	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael
		5557	Magnusson and Emanuele Giaquinta, and minor corrections by many others.
4470		5558

Diff Legend

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