ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.259 by root, Sun Jul 19 01:36:34 2009 UTC vs.
Revision 1.327 by root, Sun Oct 24 20:05:43 2010 UTC

…		…
26	puts ("stdin ready");	26	puts ("stdin ready");
27	// for one-shot events, one must manually stop the watcher	27	// for one-shot events, one must manually stop the watcher
28	// with its corresponding stop function.	28	// with its corresponding stop function.
29	ev_io_stop (EV_A_ w);	29	ev_io_stop (EV_A_ w);
30		30
31	// this causes all nested ev_loop's to stop iterating	31	// this causes all nested ev_run's to stop iterating
32	ev_unloop (EV_A_ EVUNLOOP_ALL);	32	ev_break (EV_A_ EVBREAK_ALL);
33	}	33	}
34		34
35	// another callback, this time for a time-out	35	// another callback, this time for a time-out
36	static void	36	static void
37	timeout_cb (EV_P_ ev_timer *w, int revents)	37	timeout_cb (EV_P_ ev_timer *w, int revents)
38	{	38	{
39	puts ("timeout");	39	puts ("timeout");
40	// this causes the innermost ev_loop to stop iterating	40	// this causes the innermost ev_run to stop iterating
41	ev_unloop (EV_A_ EVUNLOOP_ONE);	41	ev_break (EV_A_ EVBREAK_ONE);
42	}	42	}
43		43
44	int	44	int
45	main (void)	45	main (void)
46	{	46	{
47	// use the default event loop unless you have special needs	47	// use the default event loop unless you have special needs
48	struct ev_loop *loop = ev_default_loop (0);	48	struct ev_loop *loop = EV_DEFAULT;
49		49
50	// initialise an io watcher, then start it	50	// initialise an io watcher, then start it
51	// this one will watch for stdin to become readable	51	// this one will watch for stdin to become readable
52	ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);	52	ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);
53	ev_io_start (loop, &stdin_watcher);	53	ev_io_start (loop, &stdin_watcher);
…		…
56	// simple non-repeating 5.5 second timeout	56	// simple non-repeating 5.5 second timeout
57	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);	57	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
58	ev_timer_start (loop, &timeout_watcher);	58	ev_timer_start (loop, &timeout_watcher);
59		59
60	// now wait for events to arrive	60	// now wait for events to arrive
61	ev_loop (loop, 0);	61	ev_run (loop, 0);
62		62
63	// unloop was called, so exit	63	// unloop was called, so exit
64	return 0;	64	return 0;
65	}	65	}
66		66
…		…
75	While this document tries to be as complete as possible in documenting	75	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	76	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	77	on event-based programming, nor will it introduce event-based programming
78	with libev.	78	with libev.
79		79
80	Familarity with event based programming techniques in general is assumed	80	Familiarity with event based programming techniques in general is assumed
81	throughout this document.	81	throughout this document.
82		82
83	=head1 ABOUT LIBEV	83	=head1 ABOUT LIBEV
84		84
85	Libev is an event loop: you register interest in certain events (such as a	85	Libev is an event loop: you register interest in certain events (such as a
…		…
98	=head2 FEATURES	98	=head2 FEATURES
99		99
100	Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the	100	Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the
101	BSD-specific C<kqueue> and the Solaris-specific event port mechanisms	101	BSD-specific C<kqueue> and the Solaris-specific event port mechanisms
102	for file descriptor events (C<ev_io>), the Linux C<inotify> interface	102	for file descriptor events (C<ev_io>), the Linux C<inotify> interface
103	(for C<ev_stat>), relative timers (C<ev_timer>), absolute timers	103	(for C<ev_stat>), Linux eventfd/signalfd (for faster and cleaner
104	with customised rescheduling (C<ev_periodic>), synchronous signals	104	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	105	timers (C<ev_timer>), absolute timers with customised rescheduling
106	watchers dealing with the event loop mechanism itself (C<ev_idle>,	106	(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	107	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	108	loop mechanism itself (C<ev_idle>, C<ev_embed>, C<ev_prepare> and
109	(C<ev_fork>).	109	C<ev_check> watchers) as well as file watchers (C<ev_stat>) and even
		110	limited support for fork events (C<ev_fork>).
110		111
111	It also is quite fast (see this	112	It also is quite fast (see this
112	L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent	113	L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent
113	for example).	114	for example).
114		115
…		…
117	Libev is very configurable. In this manual the default (and most common)	118	Libev is very configurable. In this manual the default (and most common)
118	configuration will be described, which supports multiple event loops. For	119	configuration will be described, which supports multiple event loops. For
119	more info about various configuration options please have a look at	120	more info about various configuration options please have a look at
120	B<EMBED> section in this manual. If libev was configured without support	121	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	122	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	123	name C<loop> (which is always of type C<struct ev_loop *>) will not have
123	this argument.	124	this argument.
124		125
125	=head2 TIME REPRESENTATION	126	=head2 TIME REPRESENTATION
126		127
127	Libev represents time as a single floating point number, representing	128	Libev represents time as a single floating point number, representing
128	the (fractional) number of seconds since the (POSIX) epoch (somewhere	129	the (fractional) number of seconds since the (POSIX) epoch (in practice
129	near the beginning of 1970, details are complicated, don't ask). This	130	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	131	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	132	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	133	any calculations on it, you should treat it as some floating point value.
		134
133	component C<stamp> might indicate, it is also used for time differences	135	Unlike the name component C<stamp> might indicate, it is also used for
134	throughout libev.	136	time differences (e.g. delays) throughout libev.
135		137
136	=head1 ERROR HANDLING	138	=head1 ERROR HANDLING
137		139
138	Libev knows three classes of errors: operating system errors, usage errors	140	Libev knows three classes of errors: operating system errors, usage errors
139	and internal errors (bugs).	141	and internal errors (bugs).
…		…
163		165
164	=item ev_tstamp ev_time ()	166	=item ev_tstamp ev_time ()
165		167
166	Returns the current time as libev would use it. Please note that the	168	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	169	C<ev_now> function is usually faster and also often returns the timestamp
168	you actually want to know.	170	you actually want to know. Also interesting is the combination of
		171	C<ev_update_now> and C<ev_now>.
169		172
170	=item ev_sleep (ev_tstamp interval)	173	=item ev_sleep (ev_tstamp interval)
171		174
172	Sleep for the given interval: The current thread will be blocked until	175	Sleep for the given interval: The current thread will be blocked until
173	either it is interrupted or the given time interval has passed. Basically	176	either it is interrupted or the given time interval has passed. Basically
…		…
190	as this indicates an incompatible change. Minor versions are usually	193	as this indicates an incompatible change. Minor versions are usually
191	compatible to older versions, so a larger minor version alone is usually	194	compatible to older versions, so a larger minor version alone is usually
192	not a problem.	195	not a problem.
193		196
194	Example: Make sure we haven't accidentally been linked against the wrong	197	Example: Make sure we haven't accidentally been linked against the wrong
195	version.	198	version (note, however, that this will not detect other ABI mismatches,
		199	such as LFS or reentrancy).
196		200
197	assert (("libev version mismatch",	201	assert (("libev version mismatch",
198	ev_version_major () == EV_VERSION_MAJOR	202	ev_version_major () == EV_VERSION_MAJOR
199	&& ev_version_minor () >= EV_VERSION_MINOR));	203	&& ev_version_minor () >= EV_VERSION_MINOR));
200		204
…		…
211	assert (("sorry, no epoll, no sex",	215	assert (("sorry, no epoll, no sex",
212	ev_supported_backends () & EVBACKEND_EPOLL));	216	ev_supported_backends () & EVBACKEND_EPOLL));
213		217
214	=item unsigned int ev_recommended_backends ()	218	=item unsigned int ev_recommended_backends ()
215		219
216	Return the set of all backends compiled into this binary of libev and also	220	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	221	also recommended for this platform, meaning it will work for most file
		222	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	223	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	224	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	225	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.	226	probe for if you specify no backends explicitly.
222		227
223	=item unsigned int ev_embeddable_backends ()	228	=item unsigned int ev_embeddable_backends ()
224		229
225	Returns the set of backends that are embeddable in other event loops. This	230	Returns the set of backends that are embeddable in other event loops. This
226	is the theoretical, all-platform, value. To find which backends	231	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	232	current system. To find which embeddable backends might be supported on
228	C<ev_embeddable_backends () & ev_supported_backends ()>, likewise for	233	the current system, you would need to look at C<ev_embeddable_backends ()
229	recommended ones.	234	& ev_supported_backends ()>, likewise for recommended ones.
230		235
231	See the description of C<ev_embed> watchers for more info.	236	See the description of C<ev_embed> watchers for more info.
232		237
233	=item ev_set_allocator (void *(*cb)(void *ptr, long size)) [NOT REENTRANT]	238	=item ev_set_allocator (void *(*cb)(void *ptr, long size)) [NOT REENTRANT]
234		239
…		…
288	...	293	...
289	ev_set_syserr_cb (fatal_error);	294	ev_set_syserr_cb (fatal_error);
290		295
291	=back	296	=back
292		297
293	=head1 FUNCTIONS CONTROLLING THE EVENT LOOP	298	=head1 FUNCTIONS CONTROLLING EVENT LOOPS
294		299
295	An event loop is described by a C<struct ev_loop *> (the C<struct>	300	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>	301	I<not> optional in this case unless libev 3 compatibility is disabled, as
297	I<function>).	302	libev 3 had an C<ev_loop> function colliding with the struct name).
298		303
299	The library knows two types of such loops, the I<default> loop, which	304	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	305	supports signals and child events, and dynamically created event loops
301	not.	306	which do not.
302		307
303	=over 4	308	=over 4
304		309
305	=item struct ev_loop *ev_default_loop (unsigned int flags)	310	=item struct ev_loop *ev_default_loop (unsigned int flags)
306		311
307	This will initialise the default event loop if it hasn't been initialised	312	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	313	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	314	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).	315	C<ev_loop_new>.
		316
		317	If the default loop is already initialised then this function simply
		318	returns it (and ignores the flags. If that is troubling you, check
		319	C<ev_backend ()> afterwards). Otherwise it will create it with the given
		320	flags, which should almost always be C<0>, unless the caller is also the
		321	one calling C<ev_run> or otherwise qualifies as "the main program".
311		322
312	If you don't know what event loop to use, use the one returned from this	323	If you don't know what event loop to use, use the one returned from this
313	function.	324	function (or via the C<EV_DEFAULT> macro).
314		325
315	Note that this function is I<not> thread-safe, so if you want to use it	326	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,	327	from multiple threads, you have to employ some kind of mutex (note also
317	as loops cannot be shared easily between threads anyway).	328	that this case is unlikely, as loops cannot be shared easily between
		329	threads anyway).
318		330
319	The default loop is the only loop that can handle C<ev_signal> and	331	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	332	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	333	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	334	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	335	C<SIGCHLD> signal handler I<after> calling C<ev_default_init>.
324	C<ev_default_init>.	336
		337	Example: This is the most typical usage.
		338
		339	if (!ev_default_loop (0))
		340	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
		341
		342	Example: Restrict libev to the select and poll backends, and do not allow
		343	environment settings to be taken into account:
		344
		345	ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV);
		346
		347	=item struct ev_loop *ev_loop_new (unsigned int flags)
		348
		349	This will create and initialise a new event loop object. If the loop
		350	could not be initialised, returns false.
		351
		352	Note that this function I<is> thread-safe, and one common way to use
		353	libev with threads is indeed to create one loop per thread, and using the
		354	default loop in the "main" or "initial" thread.
325		355
326	The flags argument can be used to specify special behaviour or specific	356	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>).	357	backends to use, and is usually specified as C<0> (or C<EVFLAG_AUTO>).
328		358
329	The following flags are supported:	359	The following flags are supported:
…		…
344	useful to try out specific backends to test their performance, or to work	374	useful to try out specific backends to test their performance, or to work
345	around bugs.	375	around bugs.
346		376
347	=item C<EVFLAG_FORKCHECK>	377	=item C<EVFLAG_FORKCHECK>
348		378
349	Instead of calling C<ev_default_fork> or C<ev_loop_fork> manually after	379	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	380	make libev check for a fork in each iteration by enabling this flag.
351	enabling this flag.
352		381
353	This works by calling C<getpid ()> on every iteration of the loop,	382	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	383	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	384	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	385	GNU/Linux system for example, C<getpid> is actually a simple 5-insn sequence
…		…
362	flag.	391	flag.
363		392
364	This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS>	393	This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS>
365	environment variable.	394	environment variable.
366		395
		396	=item C<EVFLAG_NOINOTIFY>
		397
		398	When this flag is specified, then libev will not attempt to use the
		399	I<inotify> API for it's C<ev_stat> watchers. Apart from debugging and
		400	testing, this flag can be useful to conserve inotify file descriptors, as
		401	otherwise each loop using C<ev_stat> watchers consumes one inotify handle.
		402
		403	=item C<EVFLAG_SIGNALFD>
		404
		405	When this flag is specified, then libev will attempt to use the
		406	I<signalfd> API for it's C<ev_signal> (and C<ev_child>) watchers. This API
		407	delivers signals synchronously, which makes it both faster and might make
		408	it possible to get the queued signal data. It can also simplify signal
		409	handling with threads, as long as you properly block signals in your
		410	threads that are not interested in handling them.
		411
		412	Signalfd will not be used by default as this changes your signal mask, and
		413	there are a lot of shoddy libraries and programs (glib's threadpool for
		414	example) that can't properly initialise their signal masks.
		415
367	=item C<EVBACKEND_SELECT> (value 1, portable select backend)	416	=item C<EVBACKEND_SELECT> (value 1, portable select backend)
368		417
369	This is your standard select(2) backend. Not I<completely> standard, as	418	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,	419	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	420	but if that fails, expect a fairly low limit on the number of fds when
…		…
394		443
395	This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and	444	This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and
396	C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>.	445	C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>.
397		446
398	=item C<EVBACKEND_EPOLL> (value 4, Linux)	447	=item C<EVBACKEND_EPOLL> (value 4, Linux)
		448
		449	Use the linux-specific epoll(7) interface (for both pre- and post-2.6.9
		450	kernels).
399		451
400	For few fds, this backend is a bit little slower than poll and select,	452	For few fds, this backend is a bit little slower than poll and select,
401	but it scales phenomenally better. While poll and select usually scale	453	but it scales phenomenally better. While poll and select usually scale
402	like O(total_fds) where n is the total number of fds (or the highest fd),	454	like O(total_fds) where n is the total number of fds (or the highest fd),
403	epoll scales either O(1) or O(active_fds).	455	epoll scales either O(1) or O(active_fds).
…		…
415	of course I<doesn't>, and epoll just loves to report events for totally	467	of course I<doesn't>, and epoll just loves to report events for totally
416	I<different> file descriptors (even already closed ones, so one cannot	468	I<different> file descriptors (even already closed ones, so one cannot
417	even remove them from the set) than registered in the set (especially	469	even remove them from the set) than registered in the set (especially
418	on SMP systems). Libev tries to counter these spurious notifications by	470	on SMP systems). Libev tries to counter these spurious notifications by
419	employing an additional generation counter and comparing that against the	471	employing an additional generation counter and comparing that against the
420	events to filter out spurious ones, recreating the set when required.	472	events to filter out spurious ones, recreating the set when required. Last
		473	not least, it also refuses to work with some file descriptors which work
		474	perfectly fine with C<select> (files, many character devices...).
421		475
422	While stopping, setting and starting an I/O watcher in the same iteration	476	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	477	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	478	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	479	I<file description> now), so its best to avoid that. Also, C<dup ()>'ed
…		…
518		572
519	It is definitely not recommended to use this flag.	573	It is definitely not recommended to use this flag.
520		574
521	=back	575	=back
522		576
523	If one or more of these are or'ed into the flags value, then only these	577	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	578	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.	579	here). If none are specified, all backends in C<ev_recommended_backends
526		580	()> 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		581
555	Example: Try to create a event loop that uses epoll and nothing else.	582	Example: Try to create a event loop that uses epoll and nothing else.
556		583
557	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);	584	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
558	if (!epoller)	585	if (!epoller)
559	fatal ("no epoll found here, maybe it hides under your chair");	586	fatal ("no epoll found here, maybe it hides under your chair");
560		587
		588	Example: Use whatever libev has to offer, but make sure that kqueue is
		589	used if available.
		590
		591	struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE);
		592
561	=item ev_default_destroy ()	593	=item ev_loop_destroy (loop)
562		594
563	Destroys the default loop again (frees all memory and kernel state	595	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	596	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	597	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>	598	responsibility to either stop all watchers cleanly yourself I<before>
567	calling this function, or cope with the fact afterwards (which is usually	599	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	600	the easiest thing, you can just ignore the watchers and/or C<free ()> them
…		…
570		602
571	Note that certain global state, such as signal state (and installed signal	603	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	604	handlers), will not be freed by this function, and related watchers (such
573	as signal and child watchers) would need to be stopped manually.	605	as signal and child watchers) would need to be stopped manually.
574		606
575	In general it is not advisable to call this function except in the	607	This function is normally used on loop objects allocated by
576	rare occasion where you really need to free e.g. the signal handling	608	C<ev_loop_new>, but it can also be used on the default loop returned by
		609	C<ev_default_loop>, in which case it is not thread-safe.
		610
		611	Note that it is not advisable to call this function on the default loop
		612	except in the rare occasion where you really need to free it's resources.
577	pipe fds. If you need dynamically allocated loops it is better to use	613	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>).	614	and C<ev_loop_destroy>.
579		615
580	=item ev_loop_destroy (loop)	616	=item ev_loop_fork (loop)
581		617
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	618	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	619	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	620	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	621	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	622	child before resuming or calling C<ev_run>.
592	functions, and it will only take effect at the next C<ev_loop> iteration.	623
		624	Again, you I<have> to call it on I<any> loop that you want to re-use after
		625	a fork, I<even if you do not plan to use the loop in the parent>. This is
		626	because some kernel interfaces *cough* I<kqueue> *cough* do funny things
		627	during fork.
593		628
594	On the other hand, you only need to call this function in the child	629	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	630	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.	631	you just fork+exec or create a new loop in the child, you don't have to
		632	call it at all (in fact, C<epoll> is so badly broken that it makes a
		633	difference, but libev will usually detect this case on its own and do a
		634	costly reset of the backend).
597		635
598	The function itself is quite fast and it's usually not a problem to call	636	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	637	it just in case after a fork.
600	quite nicely into a call to C<pthread_atfork>:
601		638
		639	Example: Automate calling C<ev_loop_fork> on the default loop when
		640	using pthreads.
		641
		642	static void
		643	post_fork_child (void)
		644	{
		645	ev_loop_fork (EV_DEFAULT);
		646	}
		647
		648	...
602	pthread_atfork (0, 0, ev_default_fork);	649	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		650
611	=item int ev_is_default_loop (loop)	651	=item int ev_is_default_loop (loop)
612		652
613	Returns true when the given loop is, in fact, the default loop, and false	653	Returns true when the given loop is, in fact, the default loop, and false
614	otherwise.	654	otherwise.
615		655
616	=item unsigned int ev_loop_count (loop)	656	=item unsigned int ev_iteration (loop)
617		657
618	Returns the count of loop iterations for the loop, which is identical to	658	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	659	to the number of times libev did poll for new events. It starts at C<0>
620	happily wraps around with enough iterations.	660	and happily wraps around with enough iterations.
621		661
622	This value can sometimes be useful as a generation counter of sorts (it	662	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	663	"ticks" the number of loop iterations), as it roughly corresponds with
624	C<ev_prepare> and C<ev_check> calls.	664	C<ev_prepare> and C<ev_check> calls - and is incremented between the
		665	prepare and check phases.
625		666
626	=item unsigned int ev_loop_depth (loop)	667	=item unsigned int ev_depth (loop)
627		668
628	Returns the number of times C<ev_loop> was entered minus the number of	669	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.	670	times C<ev_run> was exited, in other words, the recursion depth.
630		671
631	Outside C<ev_loop>, this number is zero. In a callback, this number is	672	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),	673	C<1>, unless C<ev_run> was invoked recursively (or from another thread),
633	in which case it is higher.	674	in which case it is higher.
634		675
635	Leaving C<ev_loop> abnormally (setjmp/longjmp, cancelling the thread	676	Leaving C<ev_run> abnormally (setjmp/longjmp, cancelling the thread
636	etc.), doesn't count as exit.	677	etc.), doesn't count as "exit" - consider this as a hint to avoid such
		678	ungentleman-like behaviour unless it's really convenient.
637		679
638	=item unsigned int ev_backend (loop)	680	=item unsigned int ev_backend (loop)
639		681
640	Returns one of the C<EVBACKEND_*> flags indicating the event backend in	682	Returns one of the C<EVBACKEND_*> flags indicating the event backend in
641	use.	683	use.
…		…
650		692
651	=item ev_now_update (loop)	693	=item ev_now_update (loop)
652		694
653	Establishes the current time by querying the kernel, updating the time	695	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	696	returned by C<ev_now ()> in the progress. This is a costly operation and
655	is usually done automatically within C<ev_loop ()>.	697	is usually done automatically within C<ev_run ()>.
656		698
657	This function is rarely useful, but when some event callback runs for a	699	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	700	very long time without entering the event loop, updating libev's idea of
659	the current time is a good idea.	701	the current time is a good idea.
660		702
…		…
662		704
663	=item ev_suspend (loop)	705	=item ev_suspend (loop)
664		706
665	=item ev_resume (loop)	707	=item ev_resume (loop)
666		708
667	These two functions suspend and resume a loop, for use when the loop is	709	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.	710	loop is not used for a while and timeouts should not be processed.
669		711
670	A typical use case would be an interactive program such as a game: When	712	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	713	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	714	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>	715	the program was suspended. This can be achieved by calling C<ev_suspend>
…		…
675	C<ev_resume> directly afterwards to resume timer processing.	717	C<ev_resume> directly afterwards to resume timer processing.
676		718
677	Effectively, all C<ev_timer> watchers will be delayed by the time spend	719	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	720	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	721	will be rescheduled (that is, they will lose any events that would have
680	occured while suspended).	722	occurred while suspended).
681		723
682	After calling C<ev_suspend> you B<must not> call I<any> function on the	724	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>	725	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>.	726	without a previous call to C<ev_suspend>.
685		727
686	Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the	728	Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the
687	event loop time (see C<ev_now_update>).	729	event loop time (see C<ev_now_update>).
688		730
689	=item ev_loop (loop, int flags)	731	=item ev_run (loop, int flags)
690		732
691	Finally, this is it, the event handler. This function usually is called	733	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	734	after you have initialised all your watchers and you want to start
693	events.	735	handling events. It will ask the operating system for any new events, call
		736	the watcher callbacks, an then repeat the whole process indefinitely: This
		737	is why event loops are called I<loops>.
694		738
695	If the flags argument is specified as C<0>, it will not return until	739	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.	740	until either no event watchers are active anymore or C<ev_break> was
		741	called.
697		742
698	Please note that an explicit C<ev_unloop> is usually better than	743	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	744	relying on all watchers to be stopped when deciding when a program has
700	finished (especially in interactive programs), but having a program	745	finished (especially in interactive programs), but having a program
701	that automatically loops as long as it has to and no longer by virtue	746	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	747	of relying on its watchers stopping correctly, that is truly a thing of
703	beauty.	748	beauty.
704		749
705	A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle	750	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	751	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	752	block your process in case there are no events and will return after one
708	the loop.	753	iteration of the loop. This is sometimes useful to poll and handle new
		754	events while doing lengthy calculations, to keep the program responsive.
709		755
710	A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if	756	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	757	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	758	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	759	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	760	user-registered callback will be called), and will return after one
715	iteration of the loop.	761	iteration of the loop.
716		762
717	This is useful if you are waiting for some external event in conjunction	763	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	764	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	765	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.	766	usually a better approach for this kind of thing.
721		767
722	Here are the gory details of what C<ev_loop> does:	768	Here are the gory details of what C<ev_run> does:
723		769
		770	- Increment loop depth.
		771	- Reset the ev_break status.
724	- Before the first iteration, call any pending watchers.	772	- Before the first iteration, call any pending watchers.
		773	LOOP:
725	* If EVFLAG_FORKCHECK was used, check for a fork.	774	- If EVFLAG_FORKCHECK was used, check for a fork.
726	- If a fork was detected (by any means), queue and call all fork watchers.	775	- If a fork was detected (by any means), queue and call all fork watchers.
727	- Queue and call all prepare watchers.	776	- Queue and call all prepare watchers.
		777	- If ev_break was called, goto FINISH.
728	- If we have been forked, detach and recreate the kernel state	778	- If we have been forked, detach and recreate the kernel state
729	as to not disturb the other process.	779	as to not disturb the other process.
730	- Update the kernel state with all outstanding changes.	780	- Update the kernel state with all outstanding changes.
731	- Update the "event loop time" (ev_now ()).	781	- Update the "event loop time" (ev_now ()).
732	- Calculate for how long to sleep or block, if at all	782	- Calculate for how long to sleep or block, if at all
733	(active idle watchers, EVLOOP_NONBLOCK or not having	783	(active idle watchers, EVRUN_NOWAIT or not having
734	any active watchers at all will result in not sleeping).	784	any active watchers at all will result in not sleeping).
735	- Sleep if the I/O and timer collect interval say so.	785	- Sleep if the I/O and timer collect interval say so.
		786	- Increment loop iteration counter.
736	- Block the process, waiting for any events.	787	- Block the process, waiting for any events.
737	- Queue all outstanding I/O (fd) events.	788	- Queue all outstanding I/O (fd) events.
738	- Update the "event loop time" (ev_now ()), and do time jump adjustments.	789	- Update the "event loop time" (ev_now ()), and do time jump adjustments.
739	- Queue all expired timers.	790	- Queue all expired timers.
740	- Queue all expired periodics.	791	- Queue all expired periodics.
741	- Unless any events are pending now, queue all idle watchers.	792	- Queue all idle watchers with priority higher than that of pending events.
742	- Queue all check watchers.	793	- Queue all check watchers.
743	- Call all queued watchers in reverse order (i.e. check watchers first).	794	- 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	795	Signals and child watchers are implemented as I/O watchers, and will
745	be handled here by queueing them when their watcher gets executed.	796	be handled here by queueing them when their watcher gets executed.
746	- If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK	797	- If ev_break has been called, or EVRUN_ONCE or EVRUN_NOWAIT
747	were used, or there are no active watchers, return, otherwise	798	were used, or there are no active watchers, goto FINISH, otherwise
748	continue with step *.	799	continue with step LOOP.
		800	FINISH:
		801	- Reset the ev_break status iff it was EVBREAK_ONE.
		802	- Decrement the loop depth.
		803	- Return.
749		804
750	Example: Queue some jobs and then loop until no events are outstanding	805	Example: Queue some jobs and then loop until no events are outstanding
751	anymore.	806	anymore.
752		807
753	... queue jobs here, make sure they register event watchers as long	808	... 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..)	809	... as they still have work to do (even an idle watcher will do..)
755	ev_loop (my_loop, 0);	810	ev_run (my_loop, 0);
756	... jobs done or somebody called unloop. yeah!	811	... jobs done or somebody called unloop. yeah!
757		812
758	=item ev_unloop (loop, how)	813	=item ev_break (loop, how)
759		814
760	Can be used to make a call to C<ev_loop> return early (but only after it	815	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	816	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	817	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.	818	C<EVBREAK_ALL>, which will make all nested C<ev_run> calls return.
764		819
765	This "unloop state" will be cleared when entering C<ev_loop> again.	820	This "unloop state" will be cleared when entering C<ev_run> again.
766		821
767	It is safe to call C<ev_unloop> from otuside any C<ev_loop> calls.	822	It is safe to call C<ev_break> from outside any C<ev_run> calls. ##TODO##
768		823
769	=item ev_ref (loop)	824	=item ev_ref (loop)
770		825
771	=item ev_unref (loop)	826	=item ev_unref (loop)
772		827
773	Ref/unref can be used to add or remove a reference count on the event	828	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	829	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.	830	count is nonzero, C<ev_run> will not return on its own.
776		831
777	If you have a watcher you never unregister that should not keep C<ev_loop>	832	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	833	unregister, but that nevertheless should not keep C<ev_run> from
		834	returning. In such a case, call C<ev_unref> after starting, and C<ev_ref>
779	stopping it.	835	before stopping it.
780		836
781	As an example, libev itself uses this for its internal signal pipe: It	837	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	838	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	839	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	840	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	841	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	842	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	843	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>	844	(e.g. non-repeating timers) in which case you have to C<ev_ref>
789	in the callback).	845	in the callback).
790		846
791	Example: Create a signal watcher, but keep it from keeping C<ev_loop>	847	Example: Create a signal watcher, but keep it from keeping C<ev_run>
792	running when nothing else is active.	848	running when nothing else is active.
793		849
794	ev_signal exitsig;	850	ev_signal exitsig;
795	ev_signal_init (&exitsig, sig_cb, SIGINT);	851	ev_signal_init (&exitsig, sig_cb, SIGINT);
796	ev_signal_start (loop, &exitsig);	852	ev_signal_start (loop, &exitsig);
…		…
841	usually doesn't make much sense to set it to a lower value than C<0.01>,	897	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	898	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	899	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	900	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,	901	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).	902	then you can't do more than 100 transactions per second).
847		903
848	Setting the I<timeout collect interval> can improve the opportunity for	904	Setting the I<timeout collect interval> can improve the opportunity for
849	saving power, as the program will "bundle" timer callback invocations that	905	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	906	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	907	times the process sleeps and wakes up again. Another useful technique to
…		…
859	ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01);	915	ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01);
860		916
861	=item ev_invoke_pending (loop)	917	=item ev_invoke_pending (loop)
862		918
863	This call will simply invoke all pending watchers while resetting their	919	This call will simply invoke all pending watchers while resetting their
864	pending state. Normally, C<ev_loop> does this automatically when required,	920	pending state. Normally, C<ev_run> does this automatically when required,
865	but when overriding the invoke callback this call comes handy.	921	but when overriding the invoke callback this call comes handy. This
		922	function can be invoked from a watcher - this can be useful for example
		923	when you want to do some lengthy calculation and want to pass further
		924	event handling to another thread (you still have to make sure only one
		925	thread executes within C<ev_invoke_pending> or C<ev_run> of course).
866		926
867	=item int ev_pending_count (loop)	927	=item int ev_pending_count (loop)
868		928
869	Returns the number of pending watchers - zero indicates that no watchers	929	Returns the number of pending watchers - zero indicates that no watchers
870	are pending.	930	are pending.
871		931
872	=item ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P))	932	=item ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P))
873		933
874	This overrides the invoke pending functionality of the loop: Instead of	934	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	935	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	936	this callback instead. This is useful, for example, when you want to
877	invoke the actual watchers inside another context (another thread etc.).	937	invoke the actual watchers inside another context (another thread etc.).
878		938
879	If you want to reset the callback, use C<ev_invoke_pending> as new	939	If you want to reset the callback, use C<ev_invoke_pending> as new
880	callback.	940	callback.
…		…
883		943
884	Sometimes you want to share the same loop between multiple threads. This	944	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	945	can be done relatively simply by putting mutex_lock/unlock calls around
886	each call to a libev function.	946	each call to a libev function.
887		947
888	However, C<ev_loop> can run an indefinite time, so it is not feasible to	948	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	949	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>	950	loop via C<ev_break> and C<av_async_send>, another way is to set these
891	and I<acquire> callbacks on the loop.	951	I<release> and I<acquire> callbacks on the loop.
892		952
893	When set, then C<release> will be called just before the thread is	953	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	954	suspended waiting for new events, and C<acquire> is called just
895	afterwards.	955	afterwards.
896		956
…		…
899		959
900	While event loop modifications are allowed between invocations of	960	While event loop modifications are allowed between invocations of
901	C<release> and C<acquire> (that's their only purpose after all), no	961	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	962	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	963	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	964	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.	965	to take note of any changes you made.
906		966
907	In theory, threads executing C<ev_loop> will be async-cancel safe between	967	In theory, threads executing C<ev_run> will be async-cancel safe between
908	invocations of C<release> and C<acquire>.	968	invocations of C<release> and C<acquire>.
909		969
910	See also the locking example in the C<THREADS> section later in this	970	See also the locking example in the C<THREADS> section later in this
911	document.	971	document.
912		972
…		…
921	These two functions can be used to associate arbitrary data with a loop,	981	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	982	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	983	C<acquire> callbacks described above, but of course can be (ab-)used for
924	any other purpose as well.	984	any other purpose as well.
925		985
926	=item ev_loop_verify (loop)	986	=item ev_verify (loop)
927		987
928	This function only does something when C<EV_VERIFY> support has been	988	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	989	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	990	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	991	is found to be inconsistent, it will print an error message to standard
…		…
942		1002
943	In the following description, uppercase C<TYPE> in names stands for the	1003	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	1004	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.	1005	watchers and C<ev_io_start> for I/O watchers.
946		1006
947	A watcher is a structure that you create and register to record your	1007	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	1008	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:	1009	to wait for STDIN to become readable, you would create an C<ev_io> watcher
		1010	for that:
950		1011
951	static void my_cb (struct ev_loop *loop, ev_io *w, int revents)	1012	static void my_cb (struct ev_loop *loop, ev_io *w, int revents)
952	{	1013	{
953	ev_io_stop (w);	1014	ev_io_stop (w);
954	ev_unloop (loop, EVUNLOOP_ALL);	1015	ev_break (loop, EVBREAK_ALL);
955	}	1016	}
956		1017
957	struct ev_loop *loop = ev_default_loop (0);	1018	struct ev_loop *loop = ev_default_loop (0);
958		1019
959	ev_io stdin_watcher;	1020	ev_io stdin_watcher;
960		1021
961	ev_init (&stdin_watcher, my_cb);	1022	ev_init (&stdin_watcher, my_cb);
962	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);	1023	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);
963	ev_io_start (loop, &stdin_watcher);	1024	ev_io_start (loop, &stdin_watcher);
964		1025
965	ev_loop (loop, 0);	1026	ev_run (loop, 0);
966		1027
967	As you can see, you are responsible for allocating the memory for your	1028	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	1029	watcher structures (and it is I<usually> a bad idea to do this on the
969	stack).	1030	stack).
970		1031
971	Each watcher has an associated watcher structure (called C<struct ev_TYPE>	1032	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).	1033	or simply C<ev_TYPE>, as typedefs are provided for all watcher structs).
973		1034
974	Each watcher structure must be initialised by a call to C<ev_init	1035	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	1036	*, 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	1037	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	1038	time the event loop detects that the file descriptor given is readable
978	is readable and/or writable).	1039	and/or writable).
979		1040
980	Each watcher type further has its own C<< ev_TYPE_set (watcher *, ...) >>	1041	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	1042	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<<	1043	is also a macro to combine initialisation and setting in one call: C<<
983	ev_TYPE_init (watcher *, callback, ...) >>.	1044	ev_TYPE_init (watcher *, callback, ...) >>.
…		…
1006	=item C<EV_WRITE>	1067	=item C<EV_WRITE>
1007		1068
1008	The file descriptor in the C<ev_io> watcher has become readable and/or	1069	The file descriptor in the C<ev_io> watcher has become readable and/or
1009	writable.	1070	writable.
1010		1071
1011	=item C<EV_TIMEOUT>	1072	=item C<EV_TIMER>
1012		1073
1013	The C<ev_timer> watcher has timed out.	1074	The C<ev_timer> watcher has timed out.
1014		1075
1015	=item C<EV_PERIODIC>	1076	=item C<EV_PERIODIC>
1016		1077
…		…
1034		1095
1035	=item C<EV_PREPARE>	1096	=item C<EV_PREPARE>
1036		1097
1037	=item C<EV_CHECK>	1098	=item C<EV_CHECK>
1038		1099
1039	All C<ev_prepare> watchers are invoked just I<before> C<ev_loop> starts	1100	All C<ev_prepare> watchers are invoked just I<before> C<ev_run> starts
1040	to gather new events, and all C<ev_check> watchers are invoked just after	1101	to gather new events, and all C<ev_check> watchers are invoked just after
1041	C<ev_loop> has gathered them, but before it invokes any callbacks for any	1102	C<ev_run> has gathered them, but before it invokes any callbacks for any
1042	received events. Callbacks of both watcher types can start and stop as	1103	received events. Callbacks of both watcher types can start and stop as
1043	many watchers as they want, and all of them will be taken into account	1104	many watchers as they want, and all of them will be taken into account
1044	(for example, a C<ev_prepare> watcher might start an idle watcher to keep	1105	(for example, a C<ev_prepare> watcher might start an idle watcher to keep
1045	C<ev_loop> from blocking).	1106	C<ev_run> from blocking).
1046		1107
1047	=item C<EV_EMBED>	1108	=item C<EV_EMBED>
1048		1109
1049	The embedded event loop specified in the C<ev_embed> watcher needs attention.	1110	The embedded event loop specified in the C<ev_embed> watcher needs attention.
1050		1111
1051	=item C<EV_FORK>	1112	=item C<EV_FORK>
1052		1113
1053	The event loop has been resumed in the child process after fork (see	1114	The event loop has been resumed in the child process after fork (see
1054	C<ev_fork>).	1115	C<ev_fork>).
		1116
		1117	=item C<EV_CLEANUP>
		1118
		1119	The event loop is abotu to be destroyed (see C<ev_cleanup>).
1055		1120
1056	=item C<EV_ASYNC>	1121	=item C<EV_ASYNC>
1057		1122
1058	The given async watcher has been asynchronously notified (see C<ev_async>).	1123	The given async watcher has been asynchronously notified (see C<ev_async>).
1059		1124
…		…
1081	programs, though, as the fd could already be closed and reused for another	1146	programs, though, as the fd could already be closed and reused for another
1082	thing, so beware.	1147	thing, so beware.
1083		1148
1084	=back	1149	=back
1085		1150
		1151	=head2 WATCHER STATES
		1152
		1153	There are various watcher states mentioned throughout this manual -
		1154	active, pending and so on. In this section these states and the rules to
		1155	transition between them will be described in more detail - and while these
		1156	rules might look complicated, they usually do "the right thing".
		1157
		1158	=over 4
		1159
		1160	=item initialiased
		1161
		1162	Before a watcher can be registered with the event looop it has to be
		1163	initialised. This can be done with a call to C<ev_TYPE_init>, or calls to
		1164	C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function.
		1165
		1166	In this state it is simply some block of memory that is suitable for use
		1167	in an event loop. It can be moved around, freed, reused etc. at will.
		1168
		1169	=item started/running/active
		1170
		1171	Once a watcher has been started with a call to C<ev_TYPE_start> it becomes
		1172	property of the event loop, and is actively waiting for events. While in
		1173	this state it cannot be accessed (except in a few documented ways), moved,
		1174	freed or anything else - the only legal thing is to keep a pointer to it,
		1175	and call libev functions on it that are documented to work on active watchers.
		1176
		1177	=item pending
		1178
		1179	If a watcher is active and libev determines that an event it is interested
		1180	in has occurred (such as a timer expiring), it will become pending. It will
		1181	stay in this pending state until either it is stopped or its callback is
		1182	about to be invoked, so it is not normally pending inside the watcher
		1183	callback.
		1184
		1185	The watcher might or might not be active while it is pending (for example,
		1186	an expired non-repeating timer can be pending but no longer active). If it
		1187	is stopped, it can be freely accessed (e.g. by calling C<ev_TYPE_set>),
		1188	but it is still property of the event loop at this time, so cannot be
		1189	moved, freed or reused. And if it is active the rules described in the
		1190	previous item still apply.
		1191
		1192	It is also possible to feed an event on a watcher that is not active (e.g.
		1193	via C<ev_feed_event>), in which case it becomes pending without being
		1194	active.
		1195
		1196	=item stopped
		1197
		1198	A watcher can be stopped implicitly by libev (in which case it might still
		1199	be pending), or explicitly by calling its C<ev_TYPE_stop> function. The
		1200	latter will clear any pending state the watcher might be in, regardless
		1201	of whether it was active or not, so stopping a watcher explicitly before
		1202	freeing it is often a good idea.
		1203
		1204	While stopped (and not pending) the watcher is essentially in the
		1205	initialised state, that is it can be reused, moved, modified in any way
		1206	you wish.
		1207
		1208	=back
		1209
1086	=head2 GENERIC WATCHER FUNCTIONS	1210	=head2 GENERIC WATCHER FUNCTIONS
1087		1211
1088	=over 4	1212	=over 4
1089		1213
1090	=item C<ev_init> (ev_TYPE *watcher, callback)	1214	=item C<ev_init> (ev_TYPE *watcher, callback)
…		…
1106		1230
1107	ev_io w;	1231	ev_io w;
1108	ev_init (&w, my_cb);	1232	ev_init (&w, my_cb);
1109	ev_io_set (&w, STDIN_FILENO, EV_READ);	1233	ev_io_set (&w, STDIN_FILENO, EV_READ);
1110		1234
1111	=item C<ev_TYPE_set> (ev_TYPE *, [args])	1235	=item C<ev_TYPE_set> (ev_TYPE *watcher, [args])
1112		1236
1113	This macro initialises the type-specific parts of a watcher. You need to	1237	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	1238	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	1239	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	1240	macro on a watcher that is active (it can be pending, however, which is a
…		…
1129		1253
1130	Example: Initialise and set an C<ev_io> watcher in one step.	1254	Example: Initialise and set an C<ev_io> watcher in one step.
1131		1255
1132	ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ);	1256	ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ);
1133		1257
1134	=item C<ev_TYPE_start> (loop *, ev_TYPE *watcher)	1258	=item C<ev_TYPE_start> (loop, ev_TYPE *watcher)
1135		1259
1136	Starts (activates) the given watcher. Only active watchers will receive	1260	Starts (activates) the given watcher. Only active watchers will receive
1137	events. If the watcher is already active nothing will happen.	1261	events. If the watcher is already active nothing will happen.
1138		1262
1139	Example: Start the C<ev_io> watcher that is being abused as example in this	1263	Example: Start the C<ev_io> watcher that is being abused as example in this
1140	whole section.	1264	whole section.
1141		1265
1142	ev_io_start (EV_DEFAULT_UC, &w);	1266	ev_io_start (EV_DEFAULT_UC, &w);
1143		1267
1144	=item C<ev_TYPE_stop> (loop *, ev_TYPE *watcher)	1268	=item C<ev_TYPE_stop> (loop, ev_TYPE *watcher)
1145		1269
1146	Stops the given watcher if active, and clears the pending status (whether	1270	Stops the given watcher if active, and clears the pending status (whether
1147	the watcher was active or not).	1271	the watcher was active or not).
1148		1272
1149	It is possible that stopped watchers are pending - for example,	1273	It is possible that stopped watchers are pending - for example,
…		…
1174	=item ev_cb_set (ev_TYPE *watcher, callback)	1298	=item ev_cb_set (ev_TYPE *watcher, callback)
1175		1299
1176	Change the callback. You can change the callback at virtually any time	1300	Change the callback. You can change the callback at virtually any time
1177	(modulo threads).	1301	(modulo threads).
1178		1302
1179	=item ev_set_priority (ev_TYPE *watcher, priority)	1303	=item ev_set_priority (ev_TYPE *watcher, int priority)
1180		1304
1181	=item int ev_priority (ev_TYPE *watcher)	1305	=item int ev_priority (ev_TYPE *watcher)
1182		1306
1183	Set and query the priority of the watcher. The priority is a small	1307	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>	1308	integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>
…		…
1215	returns its C<revents> bitset (as if its callback was invoked). If the	1339	returns its C<revents> bitset (as if its callback was invoked). If the
1216	watcher isn't pending it does nothing and returns C<0>.	1340	watcher isn't pending it does nothing and returns C<0>.
1217		1341
1218	Sometimes it can be useful to "poll" a watcher instead of waiting for its	1342	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.	1343	callback to be invoked, which can be accomplished with this function.
		1344
		1345	=item ev_feed_event (loop, ev_TYPE *watcher, int revents)
		1346
		1347	Feeds the given event set into the event loop, as if the specified event
		1348	had happened for the specified watcher (which must be a pointer to an
		1349	initialised but not necessarily started event watcher). Obviously you must
		1350	not free the watcher as long as it has pending events.
		1351
		1352	Stopping the watcher, letting libev invoke it, or calling
		1353	C<ev_clear_pending> will clear the pending event, even if the watcher was
		1354	not started in the first place.
		1355
		1356	See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related
		1357	functions that do not need a watcher.
1220		1358
1221	=back	1359	=back
1222		1360
1223		1361
1224	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER	1362	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
…		…
1335		1473
1336	For example, to emulate how many other event libraries handle priorities,	1474	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	1475	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	1476	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	1477	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	1478	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	1479	the lock-out case is known to be rare (which in turn is rare :), this is
1342	workable.	1480	workable.
1343		1481
1344	Usually, however, the lock-out model implemented that way will perform	1482	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,	1483	miserably under the type of load it was designed to handle. In that case,
…		…
1359	{	1497	{
1360	// stop the I/O watcher, we received the event, but	1498	// stop the I/O watcher, we received the event, but
1361	// are not yet ready to handle it.	1499	// are not yet ready to handle it.
1362	ev_io_stop (EV_A_ w);	1500	ev_io_stop (EV_A_ w);
1363		1501
1364	// start the idle watcher to ahndle the actual event.	1502	// start the idle watcher to handle the actual event.
1365	// it will not be executed as long as other watchers	1503	// it will not be executed as long as other watchers
1366	// with the default priority are receiving events.	1504	// with the default priority are receiving events.
1367	ev_idle_start (EV_A_ &idle);	1505	ev_idle_start (EV_A_ &idle);
1368	}	1506	}
1369		1507
…		…
1423		1561
1424	If you cannot use non-blocking mode, then force the use of a	1562	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	1563	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	1564	C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>). The same applies to file
1427	descriptors for which non-blocking operation makes no sense (such as	1565	descriptors for which non-blocking operation makes no sense (such as
1428	files) - libev doesn't guarentee any specific behaviour in that case.	1566	files) - libev doesn't guarantee any specific behaviour in that case.
1429		1567
1430	Another thing you have to watch out for is that it is quite easy to	1568	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	1569	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	1570	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	1571	because there is no data. Not only are some backends known to create a
…		…
1498		1636
1499	So when you encounter spurious, unexplained daemon exits, make sure you	1637	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	1638	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).	1639	somewhere, as that would have given you a big clue).
1502		1640
		1641	=head3 The special problem of accept()ing when you can't
		1642
		1643	Many implementations of the POSIX C<accept> function (for example,
		1644	found in post-2004 Linux) have the peculiar behaviour of not removing a
		1645	connection from the pending queue in all error cases.
		1646
		1647	For example, larger servers often run out of file descriptors (because
		1648	of resource limits), causing C<accept> to fail with C<ENFILE> but not
		1649	rejecting the connection, leading to libev signalling readiness on
		1650	the next iteration again (the connection still exists after all), and
		1651	typically causing the program to loop at 100% CPU usage.
		1652
		1653	Unfortunately, the set of errors that cause this issue differs between
		1654	operating systems, there is usually little the app can do to remedy the
		1655	situation, and no known thread-safe method of removing the connection to
		1656	cope with overload is known (to me).
		1657
		1658	One of the easiest ways to handle this situation is to just ignore it
		1659	- when the program encounters an overload, it will just loop until the
		1660	situation is over. While this is a form of busy waiting, no OS offers an
		1661	event-based way to handle this situation, so it's the best one can do.
		1662
		1663	A better way to handle the situation is to log any errors other than
		1664	C<EAGAIN> and C<EWOULDBLOCK>, making sure not to flood the log with such
		1665	messages, and continue as usual, which at least gives the user an idea of
		1666	what could be wrong ("raise the ulimit!"). For extra points one could stop
		1667	the C<ev_io> watcher on the listening fd "for a while", which reduces CPU
		1668	usage.
		1669
		1670	If your program is single-threaded, then you could also keep a dummy file
		1671	descriptor for overload situations (e.g. by opening F</dev/null>), and
		1672	when you run into C<ENFILE> or C<EMFILE>, close it, run C<accept>,
		1673	close that fd, and create a new dummy fd. This will gracefully refuse
		1674	clients under typical overload conditions.
		1675
		1676	The last way to handle it is to simply log the error and C<exit>, as
		1677	is often done with C<malloc> failures, but this results in an easy
		1678	opportunity for a DoS attack.
1503		1679
1504	=head3 Watcher-Specific Functions	1680	=head3 Watcher-Specific Functions
1505		1681
1506	=over 4	1682	=over 4
1507		1683
…		…
1539	...	1715	...
1540	struct ev_loop *loop = ev_default_init (0);	1716	struct ev_loop *loop = ev_default_init (0);
1541	ev_io stdin_readable;	1717	ev_io stdin_readable;
1542	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);	1718	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);
1543	ev_io_start (loop, &stdin_readable);	1719	ev_io_start (loop, &stdin_readable);
1544	ev_loop (loop, 0);	1720	ev_run (loop, 0);
1545		1721
1546		1722
1547	=head2 C<ev_timer> - relative and optionally repeating timeouts	1723	=head2 C<ev_timer> - relative and optionally repeating timeouts
1548		1724
1549	Timer watchers are simple relative timers that generate an event after a	1725	Timer watchers are simple relative timers that generate an event after a
…		…
1558	The callback is guaranteed to be invoked only I<after> its timeout has	1734	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	1735	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	1736	might introduce a small delay). If multiple timers become ready during the
1561	same loop iteration then the ones with earlier time-out values are invoked	1737	same loop iteration then the ones with earlier time-out values are invoked
1562	before ones of the same priority with later time-out values (but this is	1738	before ones of the same priority with later time-out values (but this is
1563	no longer true when a callback calls C<ev_loop> recursively).	1739	no longer true when a callback calls C<ev_run> recursively).
1564		1740
1565	=head3 Be smart about timeouts	1741	=head3 Be smart about timeouts
1566		1742
1567	Many real-world problems involve some kind of timeout, usually for error	1743	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,	1744	recovery. A typical example is an HTTP request - if the other side hangs,
…		…
1654	ev_tstamp timeout = last_activity + 60.;	1830	ev_tstamp timeout = last_activity + 60.;
1655		1831
1656	// if last_activity + 60. is older than now, we did time out	1832	// if last_activity + 60. is older than now, we did time out
1657	if (timeout < now)	1833	if (timeout < now)
1658	{	1834	{
1659	// timeout occured, take action	1835	// timeout occurred, take action
1660	}	1836	}
1661	else	1837	else
1662	{	1838	{
1663	// callback was invoked, but there was some activity, re-arm	1839	// callback was invoked, but there was some activity, re-arm
1664	// the watcher to fire in last_activity + 60, which is	1840	// the watcher to fire in last_activity + 60, which is
…		…
1686	to the current time (meaning we just have some activity :), then call the	1862	to the current time (meaning we just have some activity :), then call the
1687	callback, which will "do the right thing" and start the timer:	1863	callback, which will "do the right thing" and start the timer:
1688		1864
1689	ev_init (timer, callback);	1865	ev_init (timer, callback);
1690	last_activity = ev_now (loop);	1866	last_activity = ev_now (loop);
1691	callback (loop, timer, EV_TIMEOUT);	1867	callback (loop, timer, EV_TIMER);
1692		1868
1693	And when there is some activity, simply store the current time in	1869	And when there is some activity, simply store the current time in
1694	C<last_activity>, no libev calls at all:	1870	C<last_activity>, no libev calls at all:
1695		1871
1696	last_actiivty = ev_now (loop);	1872	last_activity = ev_now (loop);
1697		1873
1698	This technique is slightly more complex, but in most cases where the	1874	This technique is slightly more complex, but in most cases where the
1699	time-out is unlikely to be triggered, much more efficient.	1875	time-out is unlikely to be triggered, much more efficient.
1700		1876
1701	Changing the timeout is trivial as well (if it isn't hard-coded in the	1877	Changing the timeout is trivial as well (if it isn't hard-coded in the
…		…
1739		1915
1740	=head3 The special problem of time updates	1916	=head3 The special problem of time updates
1741		1917
1742	Establishing the current time is a costly operation (it usually takes at	1918	Establishing the current time is a costly operation (it usually takes at
1743	least two system calls): EV therefore updates its idea of the current	1919	least two system calls): EV therefore updates its idea of the current
1744	time only before and after C<ev_loop> collects new events, which causes a	1920	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	1921	growing difference between C<ev_now ()> and C<ev_time ()> when handling
1746	lots of events in one iteration.	1922	lots of events in one iteration.
1747		1923
1748	The relative timeouts are calculated relative to the C<ev_now ()>	1924	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	1925	time. This is usually the right thing as this timestamp refers to the time
…		…
1820	C<repeat> value), or reset the running timer to the C<repeat> value.	1996	C<repeat> value), or reset the running timer to the C<repeat> value.
1821		1997
1822	This sounds a bit complicated, see L<Be smart about timeouts>, above, for a	1998	This sounds a bit complicated, see L<Be smart about timeouts>, above, for a
1823	usage example.	1999	usage example.
1824		2000
1825	=item ev_timer_remaining (loop, ev_timer *)	2001	=item ev_tstamp ev_timer_remaining (loop, ev_timer *)
1826		2002
1827	Returns the remaining time until a timer fires. If the timer is active,	2003	Returns the remaining time until a timer fires. If the timer is active,
1828	then this time is relative to the current event loop time, otherwise it's	2004	then this time is relative to the current event loop time, otherwise it's
1829	the timeout value currently configured.	2005	the timeout value currently configured.
1830		2006
1831	That is, after an C<ev_timer_set (w, 5, 7)>, C<ev_timer_remaining> returns	2007	That is, after an C<ev_timer_set (w, 5, 7)>, C<ev_timer_remaining> returns
1832	C<5>. When the timer is started and one second passes, C<ev_timer_remain>	2008	C<5>. When the timer is started and one second passes, C<ev_timer_remaining>
1833	will return C<4>. When the timer expires and is restarted, it will return	2009	will return C<4>. When the timer expires and is restarted, it will return
1834	roughly C<7> (likely slightly less as callback invocation takes some time,	2010	roughly C<7> (likely slightly less as callback invocation takes some time,
1835	too), and so on.	2011	too), and so on.
1836		2012
1837	=item ev_tstamp repeat [read-write]	2013	=item ev_tstamp repeat [read-write]
…		…
1866	}	2042	}
1867		2043
1868	ev_timer mytimer;	2044	ev_timer mytimer;
1869	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */	2045	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */
1870	ev_timer_again (&mytimer); /* start timer */	2046	ev_timer_again (&mytimer); /* start timer */
1871	ev_loop (loop, 0);	2047	ev_run (loop, 0);
1872		2048
1873	// and in some piece of code that gets executed on any "activity":	2049	// and in some piece of code that gets executed on any "activity":
1874	// reset the timeout to start ticking again at 10 seconds	2050	// reset the timeout to start ticking again at 10 seconds
1875	ev_timer_again (&mytimer);	2051	ev_timer_again (&mytimer);
1876		2052
…		…
1902		2078
1903	As with timers, the callback is guaranteed to be invoked only when the	2079	As with timers, the callback is guaranteed to be invoked only when the
1904	point in time where it is supposed to trigger has passed. If multiple	2080	point in time where it is supposed to trigger has passed. If multiple
1905	timers become ready during the same loop iteration then the ones with	2081	timers become ready during the same loop iteration then the ones with
1906	earlier time-out values are invoked before ones with later time-out values	2082	earlier time-out values are invoked before ones with later time-out values
1907	(but this is no longer true when a callback calls C<ev_loop> recursively).	2083	(but this is no longer true when a callback calls C<ev_run> recursively).
1908		2084
1909	=head3 Watcher-Specific Functions and Data Members	2085	=head3 Watcher-Specific Functions and Data Members
1910		2086
1911	=over 4	2087	=over 4
1912		2088
…		…
2040	Example: Call a callback every hour, or, more precisely, whenever the	2216	Example: Call a callback every hour, or, more precisely, whenever the
2041	system time is divisible by 3600. The callback invocation times have	2217	system time is divisible by 3600. The callback invocation times have
2042	potentially a lot of jitter, but good long-term stability.	2218	potentially a lot of jitter, but good long-term stability.
2043		2219
2044	static void	2220	static void
2045	clock_cb (struct ev_loop *loop, ev_io *w, int revents)	2221	clock_cb (struct ev_loop *loop, ev_periodic *w, int revents)
2046	{	2222	{
2047	... its now a full hour (UTC, or TAI or whatever your clock follows)	2223	... its now a full hour (UTC, or TAI or whatever your clock follows)
2048	}	2224	}
2049		2225
2050	ev_periodic hourly_tick;	2226	ev_periodic hourly_tick;
…		…
2076	Signal watchers will trigger an event when the process receives a specific	2252	Signal watchers will trigger an event when the process receives a specific
2077	signal one or more times. Even though signals are very asynchronous, libev	2253	signal one or more times. Even though signals are very asynchronous, libev
2078	will try it's best to deliver signals synchronously, i.e. as part of the	2254	will try it's best to deliver signals synchronously, i.e. as part of the
2079	normal event processing, like any other event.	2255	normal event processing, like any other event.
2080		2256
2081	Note that only the default loop supports registering signal watchers	2257	If you want signals to be delivered truly asynchronously, just use
2082	currently.	2258	C<sigaction> as you would do without libev and forget about sharing
		2259	the signal. You can even use C<ev_async> from a signal handler to
		2260	synchronously wake up an event loop.
2083		2261
2084	If you want signals asynchronously, just use C<sigaction> as you would
2085	do without libev and forget about sharing the signal. You can even use
2086	C<ev_async> from a signal handler to synchronously wake up an event loop.
2087
2088	You can configure as many watchers as you like per signal. Only when the	2262	You can configure as many watchers as you like for the same signal, but
		2263	only within the same loop, i.e. you can watch for C<SIGINT> in your
		2264	default loop and for C<SIGIO> in another loop, but you cannot watch for
		2265	C<SIGINT> in both the default loop and another loop at the same time. At
		2266	the moment, C<SIGCHLD> is permanently tied to the default loop.
		2267
2089	first watcher gets started will libev actually register something with	2268	When the first watcher gets started will libev actually register something
2090	the kernel (thus it coexists with your own signal handlers as long as you	2269	with the kernel (thus it coexists with your own signal handlers as long as
2091	don't register any with libev for the same signal).	2270	you don't register any with libev for the same signal).
2092
2093	Both the signal mask state (C<sigprocmask>) and the signal handler state
2094	(C<sigaction>) are unspecified after starting a signal watcher (and after
2095	sotpping it again), that is, libev might or might not block the signal,
2096	and might or might not set or restore the installed signal handler.
2097		2271
2098	If possible and supported, libev will install its handlers with	2272	If possible and supported, libev will install its handlers with
2099	C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should	2273	C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should
2100	not be unduly interrupted. If you have a problem with system calls getting	2274	not be unduly interrupted. If you have a problem with system calls getting
2101	interrupted by signals you can block all signals in an C<ev_check> watcher	2275	interrupted by signals you can block all signals in an C<ev_check> watcher
2102	and unblock them in an C<ev_prepare> watcher.	2276	and unblock them in an C<ev_prepare> watcher.
2103		2277
		2278	=head3 The special problem of inheritance over fork/execve/pthread_create
		2279
		2280	Both the signal mask (C<sigprocmask>) and the signal disposition
		2281	(C<sigaction>) are unspecified after starting a signal watcher (and after
		2282	stopping it again), that is, libev might or might not block the signal,
		2283	and might or might not set or restore the installed signal handler.
		2284
		2285	While this does not matter for the signal disposition (libev never
		2286	sets signals to C<SIG_IGN>, so handlers will be reset to C<SIG_DFL> on
		2287	C<execve>), this matters for the signal mask: many programs do not expect
		2288	certain signals to be blocked.
		2289
		2290	This means that before calling C<exec> (from the child) you should reset
		2291	the signal mask to whatever "default" you expect (all clear is a good
		2292	choice usually).
		2293
		2294	The simplest way to ensure that the signal mask is reset in the child is
		2295	to install a fork handler with C<pthread_atfork> that resets it. That will
		2296	catch fork calls done by libraries (such as the libc) as well.
		2297
		2298	In current versions of libev, the signal will not be blocked indefinitely
		2299	unless you use the C<signalfd> API (C<EV_SIGNALFD>). While this reduces
		2300	the window of opportunity for problems, it will not go away, as libev
		2301	I<has> to modify the signal mask, at least temporarily.
		2302
		2303	So I can't stress this enough: I<If you do not reset your signal mask when
		2304	you expect it to be empty, you have a race condition in your code>. This
		2305	is not a libev-specific thing, this is true for most event libraries.
		2306
2104	=head3 Watcher-Specific Functions and Data Members	2307	=head3 Watcher-Specific Functions and Data Members
2105		2308
2106	=over 4	2309	=over 4
2107		2310
2108	=item ev_signal_init (ev_signal *, callback, int signum)	2311	=item ev_signal_init (ev_signal *, callback, int signum)
…		…
2123	Example: Try to exit cleanly on SIGINT.	2326	Example: Try to exit cleanly on SIGINT.
2124		2327
2125	static void	2328	static void
2126	sigint_cb (struct ev_loop *loop, ev_signal *w, int revents)	2329	sigint_cb (struct ev_loop *loop, ev_signal *w, int revents)
2127	{	2330	{
2128	ev_unloop (loop, EVUNLOOP_ALL);	2331	ev_break (loop, EVBREAK_ALL);
2129	}	2332	}
2130		2333
2131	ev_signal signal_watcher;	2334	ev_signal signal_watcher;
2132	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);	2335	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
2133	ev_signal_start (loop, &signal_watcher);	2336	ev_signal_start (loop, &signal_watcher);
…		…
2519		2722
2520	Prepare and check watchers are usually (but not always) used in pairs:	2723	Prepare and check watchers are usually (but not always) used in pairs:
2521	prepare watchers get invoked before the process blocks and check watchers	2724	prepare watchers get invoked before the process blocks and check watchers
2522	afterwards.	2725	afterwards.
2523		2726
2524	You I<must not> call C<ev_loop> or similar functions that enter	2727	You I<must not> call C<ev_run> or similar functions that enter
2525	the current event loop from either C<ev_prepare> or C<ev_check>	2728	the current event loop from either C<ev_prepare> or C<ev_check>
2526	watchers. Other loops than the current one are fine, however. The	2729	watchers. Other loops than the current one are fine, however. The
2527	rationale behind this is that you do not need to check for recursion in	2730	rationale behind this is that you do not need to check for recursion in
2528	those watchers, i.e. the sequence will always be C<ev_prepare>, blocking,	2731	those watchers, i.e. the sequence will always be C<ev_prepare>, blocking,
2529	C<ev_check> so if you have one watcher of each kind they will always be	2732	C<ev_check> so if you have one watcher of each kind they will always be
…		…
2697		2900
2698	if (timeout >= 0)	2901	if (timeout >= 0)
2699	// create/start timer	2902	// create/start timer
2700		2903
2701	// poll	2904	// poll
2702	ev_loop (EV_A_ 0);	2905	ev_run (EV_A_ 0);
2703		2906
2704	// stop timer again	2907	// stop timer again
2705	if (timeout >= 0)	2908	if (timeout >= 0)
2706	ev_timer_stop (EV_A_ &to);	2909	ev_timer_stop (EV_A_ &to);
2707		2910
…		…
2785	if you do not want that, you need to temporarily stop the embed watcher).	2988	if you do not want that, you need to temporarily stop the embed watcher).
2786		2989
2787	=item ev_embed_sweep (loop, ev_embed *)	2990	=item ev_embed_sweep (loop, ev_embed *)
2788		2991
2789	Make a single, non-blocking sweep over the embedded loop. This works	2992	Make a single, non-blocking sweep over the embedded loop. This works
2790	similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most	2993	similarly to C<ev_run (embedded_loop, EVRUN_NOWAIT)>, but in the most
2791	appropriate way for embedded loops.	2994	appropriate way for embedded loops.
2792		2995
2793	=item struct ev_loop *other [read-only]	2996	=item struct ev_loop *other [read-only]
2794		2997
2795	The embedded event loop.	2998	The embedded event loop.
…		…
2855	C<ev_default_fork> cheats and calls it in the wrong process, the fork	3058	C<ev_default_fork> cheats and calls it in the wrong process, the fork
2856	handlers will be invoked, too, of course.	3059	handlers will be invoked, too, of course.
2857		3060
2858	=head3 The special problem of life after fork - how is it possible?	3061	=head3 The special problem of life after fork - how is it possible?
2859		3062
2860	Most uses of C<fork()> consist of forking, then some simple calls to ste	3063	Most uses of C<fork()> consist of forking, then some simple calls to set
2861	up/change the process environment, followed by a call to C<exec()>. This	3064	up/change the process environment, followed by a call to C<exec()>. This
2862	sequence should be handled by libev without any problems.	3065	sequence should be handled by libev without any problems.
2863		3066
2864	This changes when the application actually wants to do event handling	3067	This changes when the application actually wants to do event handling
2865	in the child, or both parent in child, in effect "continuing" after the	3068	in the child, or both parent in child, in effect "continuing" after the
…		…
2881	disadvantage of having to use multiple event loops (which do not support	3084	disadvantage of having to use multiple event loops (which do not support
2882	signal watchers).	3085	signal watchers).
2883		3086
2884	When this is not possible, or you want to use the default loop for	3087	When this is not possible, or you want to use the default loop for
2885	other reasons, then in the process that wants to start "fresh", call	3088	other reasons, then in the process that wants to start "fresh", call
2886	C<ev_default_destroy ()> followed by C<ev_default_loop (...)>. Destroying	3089	C<ev_loop_destroy (EV_DEFAULT)> followed by C<ev_default_loop (...)>.
2887	the default loop will "orphan" (not stop) all registered watchers, so you	3090	Destroying the default loop will "orphan" (not stop) all registered
2888	have to be careful not to execute code that modifies those watchers. Note	3091	watchers, so you have to be careful not to execute code that modifies
2889	also that in that case, you have to re-register any signal watchers.	3092	those watchers. Note also that in that case, you have to re-register any
		3093	signal watchers.
2890		3094
2891	=head3 Watcher-Specific Functions and Data Members	3095	=head3 Watcher-Specific Functions and Data Members
2892		3096
2893	=over 4	3097	=over 4
2894		3098
2895	=item ev_fork_init (ev_signal *, callback)	3099	=item ev_fork_init (ev_fork *, callback)
2896		3100
2897	Initialises and configures the fork watcher - it has no parameters of any	3101	Initialises and configures the fork watcher - it has no parameters of any
2898	kind. There is a C<ev_fork_set> macro, but using it is utterly pointless,	3102	kind. There is a C<ev_fork_set> macro, but using it is utterly pointless,
2899	believe me.	3103	believe me.
2900		3104
2901	=back	3105	=back
2902		3106
2903		3107
		3108	=head2 C<ev_cleanup> - even the best things end
		3109
		3110	Cleanup watchers are called just before the event loop they are registered
		3111	with is being destroyed.
		3112
		3113	While there is no guarantee that the event loop gets destroyed, cleanup
		3114	watchers provide a convenient method to install cleanup hooks for your
		3115	program, worker threads and so on - you just to make sure to destroy the
		3116	loop when you want them to be invoked.
		3117
		3118	Cleanup watchers are invoked in the same way as any other watcher. Unlike
		3119	all other watchers, they do not keep a reference to the event loop (which
		3120	makes a lot of sense if you think about it). Like all other watchers, you
		3121	can call libev functions in the callback, except C<ev_cleanup_start>.
		3122
		3123	=head3 Watcher-Specific Functions and Data Members
		3124
		3125	=over 4
		3126
		3127	=item ev_cleanup_init (ev_cleanup *, callback)
		3128
		3129	Initialises and configures the cleanup watcher - it has no parameters of
		3130	any kind. There is a C<ev_cleanup_set> macro, but using it is utterly
		3131	pointless, believe me.
		3132
		3133	=back
		3134
		3135	Example: Register an atexit handler to destroy the default loop, so any
		3136	cleanup functions are called.
		3137
		3138	static void
		3139	program_exits (void)
		3140	{
		3141	ev_loop_destroy (EV_DEFAULT_UC);
		3142	}
		3143
		3144	...
		3145	atexit (program_exits);
		3146
		3147
2904	=head2 C<ev_async> - how to wake up another event loop	3148	=head2 C<ev_async> - how to wake up an event loop
2905		3149
2906	In general, you cannot use an C<ev_loop> from multiple threads or other	3150	In general, you cannot use an C<ev_run> from multiple threads or other
2907	asynchronous sources such as signal handlers (as opposed to multiple event	3151	asynchronous sources such as signal handlers (as opposed to multiple event
2908	loops - those are of course safe to use in different threads).	3152	loops - those are of course safe to use in different threads).
2909		3153
2910	Sometimes, however, you need to wake up another event loop you do not	3154	Sometimes, however, you need to wake up an event loop you do not control,
2911	control, for example because it belongs to another thread. This is what	3155	for example because it belongs to another thread. This is what C<ev_async>
2912	C<ev_async> watchers do: as long as the C<ev_async> watcher is active, you	3156	watchers do: as long as the C<ev_async> watcher is active, you can signal
2913	can signal it by calling C<ev_async_send>, which is thread- and signal	3157	it by calling C<ev_async_send>, which is thread- and signal safe.
2914	safe.
2915		3158
2916	This functionality is very similar to C<ev_signal> watchers, as signals,	3159	This functionality is very similar to C<ev_signal> watchers, as signals,
2917	too, are asynchronous in nature, and signals, too, will be compressed	3160	too, are asynchronous in nature, and signals, too, will be compressed
2918	(i.e. the number of callback invocations may be less than the number of	3161	(i.e. the number of callback invocations may be less than the number of
2919	C<ev_async_sent> calls).	3162	C<ev_async_sent> calls).
…		…
2924	=head3 Queueing	3167	=head3 Queueing
2925		3168
2926	C<ev_async> does not support queueing of data in any way. The reason	3169	C<ev_async> does not support queueing of data in any way. The reason
2927	is that the author does not know of a simple (or any) algorithm for a	3170	is that the author does not know of a simple (or any) algorithm for a
2928	multiple-writer-single-reader queue that works in all cases and doesn't	3171	multiple-writer-single-reader queue that works in all cases and doesn't
2929	need elaborate support such as pthreads.	3172	need elaborate support such as pthreads or unportable memory access
		3173	semantics.
2930		3174
2931	That means that if you want to queue data, you have to provide your own	3175	That means that if you want to queue data, you have to provide your own
2932	queue. But at least I can tell you how to implement locking around your	3176	queue. But at least I can tell you how to implement locking around your
2933	queue:	3177	queue:
2934		3178
…		…
3073		3317
3074	If C<timeout> is less than 0, then no timeout watcher will be	3318	If C<timeout> is less than 0, then no timeout watcher will be
3075	started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and	3319	started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and
3076	repeat = 0) will be started. C<0> is a valid timeout.	3320	repeat = 0) will be started. C<0> is a valid timeout.
3077		3321
3078	The callback has the type C<void (*cb)(int revents, void *arg)> and gets	3322	The callback has the type C<void (*cb)(int revents, void *arg)> and is
3079	passed an C<revents> set like normal event callbacks (a combination of	3323	passed an C<revents> set like normal event callbacks (a combination of
3080	C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg>	3324	C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMER>) and the C<arg>
3081	value passed to C<ev_once>. Note that it is possible to receive I<both>	3325	value passed to C<ev_once>. Note that it is possible to receive I<both>
3082	a timeout and an io event at the same time - you probably should give io	3326	a timeout and an io event at the same time - you probably should give io
3083	events precedence.	3327	events precedence.
3084		3328
3085	Example: wait up to ten seconds for data to appear on STDIN_FILENO.	3329	Example: wait up to ten seconds for data to appear on STDIN_FILENO.
3086		3330
3087	static void stdin_ready (int revents, void *arg)	3331	static void stdin_ready (int revents, void *arg)
3088	{	3332	{
3089	if (revents & EV_READ)	3333	if (revents & EV_READ)
3090	/* stdin might have data for us, joy! */;	3334	/* stdin might have data for us, joy! */;
3091	else if (revents & EV_TIMEOUT)	3335	else if (revents & EV_TIMER)
3092	/* doh, nothing entered */;	3336	/* doh, nothing entered */;
3093	}	3337	}
3094		3338
3095	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);	3339	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
3096		3340
3097	=item ev_feed_event (struct ev_loop *, watcher *, int revents)
3098
3099	Feeds the given event set into the event loop, as if the specified event
3100	had happened for the specified watcher (which must be a pointer to an
3101	initialised but not necessarily started event watcher).
3102
3103	=item ev_feed_fd_event (struct ev_loop *, int fd, int revents)	3341	=item ev_feed_fd_event (loop, int fd, int revents)
3104		3342
3105	Feed an event on the given fd, as if a file descriptor backend detected	3343	Feed an event on the given fd, as if a file descriptor backend detected
3106	the given events it.	3344	the given events it.
3107		3345
3108	=item ev_feed_signal_event (struct ev_loop *loop, int signum)	3346	=item ev_feed_signal_event (loop, int signum)
3109		3347
3110	Feed an event as if the given signal occurred (C<loop> must be the default	3348	Feed an event as if the given signal occurred (C<loop> must be the default
3111	loop!).	3349	loop!).
3112		3350
3113	=back	3351	=back
…		…
3193		3431
3194	=over 4	3432	=over 4
3195		3433
3196	=item ev::TYPE::TYPE ()	3434	=item ev::TYPE::TYPE ()
3197		3435
3198	=item ev::TYPE::TYPE (struct ev_loop *)	3436	=item ev::TYPE::TYPE (loop)
3199		3437
3200	=item ev::TYPE::~TYPE	3438	=item ev::TYPE::~TYPE
3201		3439
3202	The constructor (optionally) takes an event loop to associate the watcher	3440	The constructor (optionally) takes an event loop to associate the watcher
3203	with. If it is omitted, it will use C<EV_DEFAULT>.	3441	with. If it is omitted, it will use C<EV_DEFAULT>.
…		…
3236	myclass obj;	3474	myclass obj;
3237	ev::io iow;	3475	ev::io iow;
3238	iow.set <myclass, &myclass::io_cb> (&obj);	3476	iow.set <myclass, &myclass::io_cb> (&obj);
3239		3477
3240	=item w->set (object *)	3478	=item w->set (object *)
3241
3242	This is an B<experimental> feature that might go away in a future version.
3243		3479
3244	This is a variation of a method callback - leaving out the method to call	3480	This is a variation of a method callback - leaving out the method to call
3245	will default the method to C<operator ()>, which makes it possible to use	3481	will default the method to C<operator ()>, which makes it possible to use
3246	functor objects without having to manually specify the C<operator ()> all	3482	functor objects without having to manually specify the C<operator ()> all
3247	the time. Incidentally, you can then also leave out the template argument	3483	the time. Incidentally, you can then also leave out the template argument
…		…
3280	Example: Use a plain function as callback.	3516	Example: Use a plain function as callback.
3281		3517
3282	static void io_cb (ev::io &w, int revents) { }	3518	static void io_cb (ev::io &w, int revents) { }
3283	iow.set <io_cb> ();	3519	iow.set <io_cb> ();
3284		3520
3285	=item w->set (struct ev_loop *)	3521	=item w->set (loop)
3286		3522
3287	Associates a different C<struct ev_loop> with this watcher. You can only	3523	Associates a different C<struct ev_loop> with this watcher. You can only
3288	do this when the watcher is inactive (and not pending either).	3524	do this when the watcher is inactive (and not pending either).
3289		3525
3290	=item w->set ([arguments])	3526	=item w->set ([arguments])
3291		3527
3292	Basically the same as C<ev_TYPE_set>, with the same arguments. Must be	3528	Basically the same as C<ev_TYPE_set>, with the same arguments. Either this
3293	called at least once. Unlike the C counterpart, an active watcher gets	3529	method or a suitable start method must be called at least once. Unlike the
3294	automatically stopped and restarted when reconfiguring it with this	3530	C counterpart, an active watcher gets automatically stopped and restarted
3295	method.	3531	when reconfiguring it with this method.
3296		3532
3297	=item w->start ()	3533	=item w->start ()
3298		3534
3299	Starts the watcher. Note that there is no C<loop> argument, as the	3535	Starts the watcher. Note that there is no C<loop> argument, as the
3300	constructor already stores the event loop.	3536	constructor already stores the event loop.
3301		3537
		3538	=item w->start ([arguments])
		3539
		3540	Instead of calling C<set> and C<start> methods separately, it is often
		3541	convenient to wrap them in one call. Uses the same type of arguments as
		3542	the configure C<set> method of the watcher.
		3543
3302	=item w->stop ()	3544	=item w->stop ()
3303		3545
3304	Stops the watcher if it is active. Again, no C<loop> argument.	3546	Stops the watcher if it is active. Again, no C<loop> argument.
3305		3547
3306	=item w->again () (C<ev::timer>, C<ev::periodic> only)	3548	=item w->again () (C<ev::timer>, C<ev::periodic> only)
…		…
3318		3560
3319	=back	3561	=back
3320		3562
3321	=back	3563	=back
3322		3564
3323	Example: Define a class with an IO and idle watcher, start one of them in	3565	Example: Define a class with two I/O and idle watchers, start the I/O
3324	the constructor.	3566	watchers in the constructor.
3325		3567
3326	class myclass	3568	class myclass
3327	{	3569	{
3328	ev::io io ; void io_cb (ev::io &w, int revents);	3570	ev::io io ; void io_cb (ev::io &w, int revents);
		3571	ev::io2 io2 ; void io2_cb (ev::io &w, int revents);
3329	ev::idle idle; void idle_cb (ev::idle &w, int revents);	3572	ev::idle idle; void idle_cb (ev::idle &w, int revents);
3330		3573
3331	myclass (int fd)	3574	myclass (int fd)
3332	{	3575	{
3333	io .set <myclass, &myclass::io_cb > (this);	3576	io .set <myclass, &myclass::io_cb > (this);
		3577	io2 .set <myclass, &myclass::io2_cb > (this);
3334	idle.set <myclass, &myclass::idle_cb> (this);	3578	idle.set <myclass, &myclass::idle_cb> (this);
3335		3579
3336	io.start (fd, ev::READ);	3580	io.set (fd, ev::WRITE); // configure the watcher
		3581	io.start (); // start it whenever convenient
		3582
		3583	io2.start (fd, ev::READ); // set + start in one call
3337	}	3584	}
3338	};	3585	};
3339		3586
3340		3587
3341	=head1 OTHER LANGUAGE BINDINGS	3588	=head1 OTHER LANGUAGE BINDINGS
…		…
3387	=item Ocaml	3634	=item Ocaml
3388		3635
3389	Erkki Seppala has written Ocaml bindings for libev, to be found at	3636	Erkki Seppala has written Ocaml bindings for libev, to be found at
3390	L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.	3637	L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.
3391		3638
		3639	=item Lua
		3640
		3641	Brian Maher has written a partial interface to libev for lua (at the
		3642	time of this writing, only C<ev_io> and C<ev_timer>), to be found at
		3643	L<http://github.com/brimworks/lua-ev>.
		3644
3392	=back	3645	=back
3393		3646
3394		3647
3395	=head1 MACRO MAGIC	3648	=head1 MACRO MAGIC
3396		3649
…		…
3409	loop argument"). The C<EV_A> form is used when this is the sole argument,	3662	loop argument"). The C<EV_A> form is used when this is the sole argument,
3410	C<EV_A_> is used when other arguments are following. Example:	3663	C<EV_A_> is used when other arguments are following. Example:
3411		3664
3412	ev_unref (EV_A);	3665	ev_unref (EV_A);
3413	ev_timer_add (EV_A_ watcher);	3666	ev_timer_add (EV_A_ watcher);
3414	ev_loop (EV_A_ 0);	3667	ev_run (EV_A_ 0);
3415		3668
3416	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,	3669	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,
3417	which is often provided by the following macro.	3670	which is often provided by the following macro.
3418		3671
3419	=item C<EV_P>, C<EV_P_>	3672	=item C<EV_P>, C<EV_P_>
…		…
3459	}	3712	}
3460		3713
3461	ev_check check;	3714	ev_check check;
3462	ev_check_init (&check, check_cb);	3715	ev_check_init (&check, check_cb);
3463	ev_check_start (EV_DEFAULT_ &check);	3716	ev_check_start (EV_DEFAULT_ &check);
3464	ev_loop (EV_DEFAULT_ 0);	3717	ev_run (EV_DEFAULT_ 0);
3465		3718
3466	=head1 EMBEDDING	3719	=head1 EMBEDDING
3467		3720
3468	Libev can (and often is) directly embedded into host	3721	Libev can (and often is) directly embedded into host
3469	applications. Examples of applications that embed it include the Deliantra	3722	applications. Examples of applications that embed it include the Deliantra
…		…
3549	libev.m4	3802	libev.m4
3550		3803
3551	=head2 PREPROCESSOR SYMBOLS/MACROS	3804	=head2 PREPROCESSOR SYMBOLS/MACROS
3552		3805
3553	Libev can be configured via a variety of preprocessor symbols you have to	3806	Libev can be configured via a variety of preprocessor symbols you have to
3554	define before including any of its files. The default in the absence of	3807	define before including (or compiling) any of its files. The default in
3555	autoconf is documented for every option.	3808	the absence of autoconf is documented for every option.
		3809
		3810	Symbols marked with "(h)" do not change the ABI, and can have different
		3811	values when compiling libev vs. including F<ev.h>, so it is permissible
		3812	to redefine them before including F<ev.h> without breaking compatibility
		3813	to a compiled library. All other symbols change the ABI, which means all
		3814	users of libev and the libev code itself must be compiled with compatible
		3815	settings.
3556		3816
3557	=over 4	3817	=over 4
3558		3818
		3819	=item EV_COMPAT3 (h)
		3820
		3821	Backwards compatibility is a major concern for libev. This is why this
		3822	release of libev comes with wrappers for the functions and symbols that
		3823	have been renamed between libev version 3 and 4.
		3824
		3825	You can disable these wrappers (to test compatibility with future
		3826	versions) by defining C<EV_COMPAT3> to C<0> when compiling your
		3827	sources. This has the additional advantage that you can drop the C<struct>
		3828	from C<struct ev_loop> declarations, as libev will provide an C<ev_loop>
		3829	typedef in that case.
		3830
		3831	In some future version, the default for C<EV_COMPAT3> will become C<0>,
		3832	and in some even more future version the compatibility code will be
		3833	removed completely.
		3834
3559	=item EV_STANDALONE	3835	=item EV_STANDALONE (h)
3560		3836
3561	Must always be C<1> if you do not use autoconf configuration, which	3837	Must always be C<1> if you do not use autoconf configuration, which
3562	keeps libev from including F<config.h>, and it also defines dummy	3838	keeps libev from including F<config.h>, and it also defines dummy
3563	implementations for some libevent functions (such as logging, which is not	3839	implementations for some libevent functions (such as logging, which is not
3564	supported). It will also not define any of the structs usually found in	3840	supported). It will also not define any of the structs usually found in
3565	F<event.h> that are not directly supported by the libev core alone.	3841	F<event.h> that are not directly supported by the libev core alone.
3566		3842
3567	In stanbdalone mode, libev will still try to automatically deduce the	3843	In standalone mode, libev will still try to automatically deduce the
3568	configuration, but has to be more conservative.	3844	configuration, but has to be more conservative.
3569		3845
3570	=item EV_USE_MONOTONIC	3846	=item EV_USE_MONOTONIC
3571		3847
3572	If defined to be C<1>, libev will try to detect the availability of the	3848	If defined to be C<1>, libev will try to detect the availability of the
…		…
3637	be used is the winsock select). This means that it will call	3913	be used is the winsock select). This means that it will call
3638	C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise,	3914	C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise,
3639	it is assumed that all these functions actually work on fds, even	3915	it is assumed that all these functions actually work on fds, even
3640	on win32. Should not be defined on non-win32 platforms.	3916	on win32. Should not be defined on non-win32 platforms.
3641		3917
3642	=item EV_FD_TO_WIN32_HANDLE	3918	=item EV_FD_TO_WIN32_HANDLE(fd)
3643		3919
3644	If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map	3920	If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map
3645	file descriptors to socket handles. When not defining this symbol (the	3921	file descriptors to socket handles. When not defining this symbol (the
3646	default), then libev will call C<_get_osfhandle>, which is usually	3922	default), then libev will call C<_get_osfhandle>, which is usually
3647	correct. In some cases, programs use their own file descriptor management,	3923	correct. In some cases, programs use their own file descriptor management,
3648	in which case they can provide this function to map fds to socket handles.	3924	in which case they can provide this function to map fds to socket handles.
		3925
		3926	=item EV_WIN32_HANDLE_TO_FD(handle)
		3927
		3928	If C<EV_SELECT_IS_WINSOCKET> then libev maps handles to file descriptors
		3929	using the standard C<_open_osfhandle> function. For programs implementing
		3930	their own fd to handle mapping, overwriting this function makes it easier
		3931	to do so. This can be done by defining this macro to an appropriate value.
		3932
		3933	=item EV_WIN32_CLOSE_FD(fd)
		3934
		3935	If programs implement their own fd to handle mapping on win32, then this
		3936	macro can be used to override the C<close> function, useful to unregister
		3937	file descriptors again. Note that the replacement function has to close
		3938	the underlying OS handle.
3649		3939
3650	=item EV_USE_POLL	3940	=item EV_USE_POLL
3651		3941
3652	If defined to be C<1>, libev will compile in support for the C<poll>(2)	3942	If defined to be C<1>, libev will compile in support for the C<poll>(2)
3653	backend. Otherwise it will be enabled on non-win32 platforms. It	3943	backend. Otherwise it will be enabled on non-win32 platforms. It
…		…
3700	as well as for signal and thread safety in C<ev_async> watchers.	3990	as well as for signal and thread safety in C<ev_async> watchers.
3701		3991
3702	In the absence of this define, libev will use C<sig_atomic_t volatile>	3992	In the absence of this define, libev will use C<sig_atomic_t volatile>
3703	(from F<signal.h>), which is usually good enough on most platforms.	3993	(from F<signal.h>), which is usually good enough on most platforms.
3704		3994
3705	=item EV_H	3995	=item EV_H (h)
3706		3996
3707	The name of the F<ev.h> header file used to include it. The default if	3997	The name of the F<ev.h> header file used to include it. The default if
3708	undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be	3998	undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be
3709	used to virtually rename the F<ev.h> header file in case of conflicts.	3999	used to virtually rename the F<ev.h> header file in case of conflicts.
3710		4000
3711	=item EV_CONFIG_H	4001	=item EV_CONFIG_H (h)
3712		4002
3713	If C<EV_STANDALONE> isn't C<1>, this variable can be used to override	4003	If C<EV_STANDALONE> isn't C<1>, this variable can be used to override
3714	F<ev.c>'s idea of where to find the F<config.h> file, similarly to	4004	F<ev.c>'s idea of where to find the F<config.h> file, similarly to
3715	C<EV_H>, above.	4005	C<EV_H>, above.
3716		4006
3717	=item EV_EVENT_H	4007	=item EV_EVENT_H (h)
3718		4008
3719	Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea	4009	Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea
3720	of how the F<event.h> header can be found, the default is C<"event.h">.	4010	of how the F<event.h> header can be found, the default is C<"event.h">.
3721		4011
3722	=item EV_PROTOTYPES	4012	=item EV_PROTOTYPES (h)
3723		4013
3724	If defined to be C<0>, then F<ev.h> will not define any function	4014	If defined to be C<0>, then F<ev.h> will not define any function
3725	prototypes, but still define all the structs and other symbols. This is	4015	prototypes, but still define all the structs and other symbols. This is
3726	occasionally useful if you want to provide your own wrapper functions	4016	occasionally useful if you want to provide your own wrapper functions
3727	around libev functions.	4017	around libev functions.
…		…
3749	fine.	4039	fine.
3750		4040
3751	If your embedding application does not need any priorities, defining these	4041	If your embedding application does not need any priorities, defining these
3752	both to C<0> will save some memory and CPU.	4042	both to C<0> will save some memory and CPU.
3753		4043
3754	=item EV_PERIODIC_ENABLE	4044	=item EV_PERIODIC_ENABLE, EV_IDLE_ENABLE, EV_EMBED_ENABLE, EV_STAT_ENABLE,
		4045	EV_PREPARE_ENABLE, EV_CHECK_ENABLE, EV_FORK_ENABLE, EV_SIGNAL_ENABLE,
		4046	EV_ASYNC_ENABLE, EV_CHILD_ENABLE.
3755		4047
3756	If undefined or defined to be C<1>, then periodic timers are supported. If	4048	If undefined or defined to be C<1> (and the platform supports it), then
3757	defined to be C<0>, then they are not. Disabling them saves a few kB of	4049	the respective watcher type is supported. If defined to be C<0>, then it
3758	code.	4050	is not. Disabling watcher types mainly saves code size.
3759		4051
3760	=item EV_IDLE_ENABLE	4052	=item EV_FEATURES
3761
3762	If undefined or defined to be C<1>, then idle watchers are supported. If
3763	defined to be C<0>, then they are not. Disabling them saves a few kB of
3764	code.
3765
3766	=item EV_EMBED_ENABLE
3767
3768	If undefined or defined to be C<1>, then embed watchers are supported. If
3769	defined to be C<0>, then they are not. Embed watchers rely on most other
3770	watcher types, which therefore must not be disabled.
3771
3772	=item EV_STAT_ENABLE
3773
3774	If undefined or defined to be C<1>, then stat watchers are supported. If
3775	defined to be C<0>, then they are not.
3776
3777	=item EV_FORK_ENABLE
3778
3779	If undefined or defined to be C<1>, then fork watchers are supported. If
3780	defined to be C<0>, then they are not.
3781
3782	=item EV_ASYNC_ENABLE
3783
3784	If undefined or defined to be C<1>, then async watchers are supported. If
3785	defined to be C<0>, then they are not.
3786
3787	=item EV_MINIMAL
3788		4053
3789	If you need to shave off some kilobytes of code at the expense of some	4054	If you need to shave off some kilobytes of code at the expense of some
3790	speed (but with the full API), define this symbol to C<1>. Currently this	4055	speed (but with the full API), you can define this symbol to request
3791	is used to override some inlining decisions, saves roughly 30% code size	4056	certain subsets of functionality. The default is to enable all features
3792	on amd64. It also selects a much smaller 2-heap for timer management over	4057	that can be enabled on the platform.
3793	the default 4-heap.
3794		4058
3795	You can save even more by disabling watcher types you do not need	4059	A typical way to use this symbol is to define it to C<0> (or to a bitset
3796	and setting C<EV_MAXPRI> == C<EV_MINPRI>. Also, disabling C<assert>	4060	with some broad features you want) and then selectively re-enable
3797	(C<-DNDEBUG>) will usually reduce code size a lot.	4061	additional parts you want, for example if you want everything minimal,
		4062	but multiple event loop support, async and child watchers and the poll
		4063	backend, use this:
3798		4064
3799	Defining C<EV_MINIMAL> to C<2> will additionally reduce the core API to	4065	#define EV_FEATURES 0
3800	provide a bare-bones event library. See C<ev.h> for details on what parts	4066	#define EV_MULTIPLICITY 1
3801	of the API are still available, and do not complain if this subset changes	4067	#define EV_USE_POLL 1
3802	over time.	4068	#define EV_CHILD_ENABLE 1
		4069	#define EV_ASYNC_ENABLE 1
		4070
		4071	The actual value is a bitset, it can be a combination of the following
		4072	values:
		4073
		4074	=over 4
		4075
		4076	=item C<1> - faster/larger code
		4077
		4078	Use larger code to speed up some operations.
		4079
		4080	Currently this is used to override some inlining decisions (enlarging the
		4081	code size by roughly 30% on amd64).
		4082
		4083	When optimising for size, use of compiler flags such as C<-Os> with
		4084	gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of
		4085	assertions.
		4086
		4087	=item C<2> - faster/larger data structures
		4088
		4089	Replaces the small 2-heap for timer management by a faster 4-heap, larger
		4090	hash table sizes and so on. This will usually further increase code size
		4091	and can additionally have an effect on the size of data structures at
		4092	runtime.
		4093
		4094	=item C<4> - full API configuration
		4095
		4096	This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and
		4097	enables multiplicity (C<EV_MULTIPLICITY>=1).
		4098
		4099	=item C<8> - full API
		4100
		4101	This enables a lot of the "lesser used" API functions. See C<ev.h> for
		4102	details on which parts of the API are still available without this
		4103	feature, and do not complain if this subset changes over time.
		4104
		4105	=item C<16> - enable all optional watcher types
		4106
		4107	Enables all optional watcher types. If you want to selectively enable
		4108	only some watcher types other than I/O and timers (e.g. prepare,
		4109	embed, async, child...) you can enable them manually by defining
		4110	C<EV_watchertype_ENABLE> to C<1> instead.
		4111
		4112	=item C<32> - enable all backends
		4113
		4114	This enables all backends - without this feature, you need to enable at
		4115	least one backend manually (C<EV_USE_SELECT> is a good choice).
		4116
		4117	=item C<64> - enable OS-specific "helper" APIs
		4118
		4119	Enable inotify, eventfd, signalfd and similar OS-specific helper APIs by
		4120	default.
		4121
		4122	=back
		4123
		4124	Compiling with C<gcc -Os -DEV_STANDALONE -DEV_USE_EPOLL=1 -DEV_FEATURES=0>
		4125	reduces the compiled size of libev from 24.7Kb code/2.8Kb data to 6.5Kb
		4126	code/0.3Kb data on my GNU/Linux amd64 system, while still giving you I/O
		4127	watchers, timers and monotonic clock support.
		4128
		4129	With an intelligent-enough linker (gcc+binutils are intelligent enough
		4130	when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by
		4131	your program might be left out as well - a binary starting a timer and an
		4132	I/O watcher then might come out at only 5Kb.
		4133
		4134	=item EV_AVOID_STDIO
		4135
		4136	If this is set to C<1> at compiletime, then libev will avoid using stdio
		4137	functions (printf, scanf, perror etc.). This will increase the code size
		4138	somewhat, but if your program doesn't otherwise depend on stdio and your
		4139	libc allows it, this avoids linking in the stdio library which is quite
		4140	big.
		4141
		4142	Note that error messages might become less precise when this option is
		4143	enabled.
		4144
		4145	=item EV_NSIG
		4146
		4147	The highest supported signal number, +1 (or, the number of
		4148	signals): Normally, libev tries to deduce the maximum number of signals
		4149	automatically, but sometimes this fails, in which case it can be
		4150	specified. Also, using a lower number than detected (C<32> should be
		4151	good for about any system in existence) can save some memory, as libev
		4152	statically allocates some 12-24 bytes per signal number.
3803		4153
3804	=item EV_PID_HASHSIZE	4154	=item EV_PID_HASHSIZE
3805		4155
3806	C<ev_child> watchers use a small hash table to distribute workload by	4156	C<ev_child> watchers use a small hash table to distribute workload by
3807	pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more	4157	pid. The default size is C<16> (or C<1> with C<EV_FEATURES> disabled),
3808	than enough. If you need to manage thousands of children you might want to	4158	usually more than enough. If you need to manage thousands of children you
3809	increase this value (I<must> be a power of two).	4159	might want to increase this value (I<must> be a power of two).
3810		4160
3811	=item EV_INOTIFY_HASHSIZE	4161	=item EV_INOTIFY_HASHSIZE
3812		4162
3813	C<ev_stat> watchers use a small hash table to distribute workload by	4163	C<ev_stat> watchers use a small hash table to distribute workload by
3814	inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>),	4164	inotify watch id. The default size is C<16> (or C<1> with C<EV_FEATURES>
3815	usually more than enough. If you need to manage thousands of C<ev_stat>	4165	disabled), usually more than enough. If you need to manage thousands of
3816	watchers you might want to increase this value (I<must> be a power of	4166	C<ev_stat> watchers you might want to increase this value (I<must> be a
3817	two).	4167	power of two).
3818		4168
3819	=item EV_USE_4HEAP	4169	=item EV_USE_4HEAP
3820		4170
3821	Heaps are not very cache-efficient. To improve the cache-efficiency of the	4171	Heaps are not very cache-efficient. To improve the cache-efficiency of the
3822	timer and periodics heaps, libev uses a 4-heap when this symbol is defined	4172	timer and periodics heaps, libev uses a 4-heap when this symbol is defined
3823	to C<1>. The 4-heap uses more complicated (longer) code but has noticeably	4173	to C<1>. The 4-heap uses more complicated (longer) code but has noticeably
3824	faster performance with many (thousands) of watchers.	4174	faster performance with many (thousands) of watchers.
3825		4175
3826	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>	4176	The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
3827	(disabled).	4177	will be C<0>.
3828		4178
3829	=item EV_HEAP_CACHE_AT	4179	=item EV_HEAP_CACHE_AT
3830		4180
3831	Heaps are not very cache-efficient. To improve the cache-efficiency of the	4181	Heaps are not very cache-efficient. To improve the cache-efficiency of the
3832	timer and periodics heaps, libev can cache the timestamp (I<at>) within	4182	timer and periodics heaps, libev can cache the timestamp (I<at>) within
3833	the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>),	4183	the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>),
3834	which uses 8-12 bytes more per watcher and a few hundred bytes more code,	4184	which uses 8-12 bytes more per watcher and a few hundred bytes more code,
3835	but avoids random read accesses on heap changes. This improves performance	4185	but avoids random read accesses on heap changes. This improves performance
3836	noticeably with many (hundreds) of watchers.	4186	noticeably with many (hundreds) of watchers.
3837		4187
3838	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>	4188	The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
3839	(disabled).	4189	will be C<0>.
3840		4190
3841	=item EV_VERIFY	4191	=item EV_VERIFY
3842		4192
3843	Controls how much internal verification (see C<ev_loop_verify ()>) will	4193	Controls how much internal verification (see C<ev_verify ()>) will
3844	be done: If set to C<0>, no internal verification code will be compiled	4194	be done: If set to C<0>, no internal verification code will be compiled
3845	in. If set to C<1>, then verification code will be compiled in, but not	4195	in. If set to C<1>, then verification code will be compiled in, but not
3846	called. If set to C<2>, then the internal verification code will be	4196	called. If set to C<2>, then the internal verification code will be
3847	called once per loop, which can slow down libev. If set to C<3>, then the	4197	called once per loop, which can slow down libev. If set to C<3>, then the
3848	verification code will be called very frequently, which will slow down	4198	verification code will be called very frequently, which will slow down
3849	libev considerably.	4199	libev considerably.
3850		4200
3851	The default is C<1>, unless C<EV_MINIMAL> is set, in which case it will be	4201	The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
3852	C<0>.	4202	will be C<0>.
3853		4203
3854	=item EV_COMMON	4204	=item EV_COMMON
3855		4205
3856	By default, all watchers have a C<void *data> member. By redefining	4206	By default, all watchers have a C<void *data> member. By redefining
3857	this macro to a something else you can include more and other types of	4207	this macro to something else you can include more and other types of
3858	members. You have to define it each time you include one of the files,	4208	members. You have to define it each time you include one of the files,
3859	though, and it must be identical each time.	4209	though, and it must be identical each time.
3860		4210
3861	For example, the perl EV module uses something like this:	4211	For example, the perl EV module uses something like this:
3862		4212
…		…
3915	file.	4265	file.
3916		4266
3917	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file	4267	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file
3918	that everybody includes and which overrides some configure choices:	4268	that everybody includes and which overrides some configure choices:
3919		4269
3920	#define EV_MINIMAL 1	4270	#define EV_FEATURES 8
3921	#define EV_USE_POLL 0	4271	#define EV_USE_SELECT 1
3922	#define EV_MULTIPLICITY 0
3923	#define EV_PERIODIC_ENABLE 0	4272	#define EV_PREPARE_ENABLE 1
		4273	#define EV_IDLE_ENABLE 1
3924	#define EV_STAT_ENABLE 0	4274	#define EV_SIGNAL_ENABLE 1
3925	#define EV_FORK_ENABLE 0	4275	#define EV_CHILD_ENABLE 1
		4276	#define EV_USE_STDEXCEPT 0
3926	#define EV_CONFIG_H <config.h>	4277	#define EV_CONFIG_H <config.h>
3927	#define EV_MINPRI 0
3928	#define EV_MAXPRI 0
3929		4278
3930	#include "ev++.h"	4279	#include "ev++.h"
3931		4280
3932	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:	4281	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
3933		4282
…		…
4064	userdata *u = ev_userdata (EV_A);	4413	userdata *u = ev_userdata (EV_A);
4065	pthread_mutex_lock (&u->lock);	4414	pthread_mutex_lock (&u->lock);
4066	}	4415	}
4067		4416
4068	The event loop thread first acquires the mutex, and then jumps straight	4417	The event loop thread first acquires the mutex, and then jumps straight
4069	into C<ev_loop>:	4418	into C<ev_run>:
4070		4419
4071	void *	4420	void *
4072	l_run (void *thr_arg)	4421	l_run (void *thr_arg)
4073	{	4422	{
4074	struct ev_loop *loop = (struct ev_loop *)thr_arg;	4423	struct ev_loop *loop = (struct ev_loop *)thr_arg;
4075		4424
4076	l_acquire (EV_A);	4425	l_acquire (EV_A);
4077	pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);	4426	pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
4078	ev_loop (EV_A_ 0);	4427	ev_run (EV_A_ 0);
4079	l_release (EV_A);	4428	l_release (EV_A);
4080		4429
4081	return 0;	4430	return 0;
4082	}	4431	}
4083		4432
…		…
4135		4484
4136	=head3 COROUTINES	4485	=head3 COROUTINES
4137		4486
4138	Libev is very accommodating to coroutines ("cooperative threads"):	4487	Libev is very accommodating to coroutines ("cooperative threads"):
4139	libev fully supports nesting calls to its functions from different	4488	libev fully supports nesting calls to its functions from different
4140	coroutines (e.g. you can call C<ev_loop> on the same loop from two	4489	coroutines (e.g. you can call C<ev_run> on the same loop from two
4141	different coroutines, and switch freely between both coroutines running	4490	different coroutines, and switch freely between both coroutines running
4142	the loop, as long as you don't confuse yourself). The only exception is	4491	the loop, as long as you don't confuse yourself). The only exception is
4143	that you must not do this from C<ev_periodic> reschedule callbacks.	4492	that you must not do this from C<ev_periodic> reschedule callbacks.
4144		4493
4145	Care has been taken to ensure that libev does not keep local state inside	4494	Care has been taken to ensure that libev does not keep local state inside
4146	C<ev_loop>, and other calls do not usually allow for coroutine switches as	4495	C<ev_run>, and other calls do not usually allow for coroutine switches as
4147	they do not call any callbacks.	4496	they do not call any callbacks.
4148		4497
4149	=head2 COMPILER WARNINGS	4498	=head2 COMPILER WARNINGS
4150		4499
4151	Depending on your compiler and compiler settings, you might get no or a	4500	Depending on your compiler and compiler settings, you might get no or a
…		…
4162	maintainable.	4511	maintainable.
4163		4512
4164	And of course, some compiler warnings are just plain stupid, or simply	4513	And of course, some compiler warnings are just plain stupid, or simply
4165	wrong (because they don't actually warn about the condition their message	4514	wrong (because they don't actually warn about the condition their message
4166	seems to warn about). For example, certain older gcc versions had some	4515	seems to warn about). For example, certain older gcc versions had some
4167	warnings that resulted an extreme number of false positives. These have	4516	warnings that resulted in an extreme number of false positives. These have
4168	been fixed, but some people still insist on making code warn-free with	4517	been fixed, but some people still insist on making code warn-free with
4169	such buggy versions.	4518	such buggy versions.
4170		4519
4171	While libev is written to generate as few warnings as possible,	4520	While libev is written to generate as few warnings as possible,
4172	"warn-free" code is not a goal, and it is recommended not to build libev	4521	"warn-free" code is not a goal, and it is recommended not to build libev
…		…
4208	I suggest using suppression lists.	4557	I suggest using suppression lists.
4209		4558
4210		4559
4211	=head1 PORTABILITY NOTES	4560	=head1 PORTABILITY NOTES
4212		4561
		4562	=head2 GNU/LINUX 32 BIT LIMITATIONS
		4563
		4564	GNU/Linux is the only common platform that supports 64 bit file/large file
		4565	interfaces but I<disables> them by default.
		4566
		4567	That means that libev compiled in the default environment doesn't support
		4568	files larger than 2GiB or so, which mainly affects C<ev_stat> watchers.
		4569
		4570	Unfortunately, many programs try to work around this GNU/Linux issue
		4571	by enabling the large file API, which makes them incompatible with the
		4572	standard libev compiled for their system.
		4573
		4574	Likewise, libev cannot enable the large file API itself as this would
		4575	suddenly make it incompatible to the default compile time environment,
		4576	i.e. all programs not using special compile switches.
		4577
		4578	=head2 OS/X AND DARWIN BUGS
		4579
		4580	The whole thing is a bug if you ask me - basically any system interface
		4581	you touch is broken, whether it is locales, poll, kqueue or even the
		4582	OpenGL drivers.
		4583
		4584	=head3 C<kqueue> is buggy
		4585
		4586	The kqueue syscall is broken in all known versions - most versions support
		4587	only sockets, many support pipes.
		4588
		4589	Libev tries to work around this by not using C<kqueue> by default on this
		4590	rotten platform, but of course you can still ask for it when creating a
		4591	loop - embedding a socket-only kqueue loop into a select-based one is
		4592	probably going to work well.
		4593
		4594	=head3 C<poll> is buggy
		4595
		4596	Instead of fixing C<kqueue>, Apple replaced their (working) C<poll>
		4597	implementation by something calling C<kqueue> internally around the 10.5.6
		4598	release, so now C<kqueue> I<and> C<poll> are broken.
		4599
		4600	Libev tries to work around this by not using C<poll> by default on
		4601	this rotten platform, but of course you can still ask for it when creating
		4602	a loop.
		4603
		4604	=head3 C<select> is buggy
		4605
		4606	All that's left is C<select>, and of course Apple found a way to fuck this
		4607	one up as well: On OS/X, C<select> actively limits the number of file
		4608	descriptors you can pass in to 1024 - your program suddenly crashes when
		4609	you use more.
		4610
		4611	There is an undocumented "workaround" for this - defining
		4612	C<_DARWIN_UNLIMITED_SELECT>, which libev tries to use, so select I<should>
		4613	work on OS/X.
		4614
		4615	=head2 SOLARIS PROBLEMS AND WORKAROUNDS
		4616
		4617	=head3 C<errno> reentrancy
		4618
		4619	The default compile environment on Solaris is unfortunately so
		4620	thread-unsafe that you can't even use components/libraries compiled
		4621	without C<-D_REENTRANT> in a threaded program, which, of course, isn't
		4622	defined by default. A valid, if stupid, implementation choice.
		4623
		4624	If you want to use libev in threaded environments you have to make sure
		4625	it's compiled with C<_REENTRANT> defined.
		4626
		4627	=head3 Event port backend
		4628
		4629	The scalable event interface for Solaris is called "event
		4630	ports". Unfortunately, this mechanism is very buggy in all major
		4631	releases. If you run into high CPU usage, your program freezes or you get
		4632	a large number of spurious wakeups, make sure you have all the relevant
		4633	and latest kernel patches applied. No, I don't know which ones, but there
		4634	are multiple ones to apply, and afterwards, event ports actually work
		4635	great.
		4636
		4637	If you can't get it to work, you can try running the program by setting
		4638	the environment variable C<LIBEV_FLAGS=3> to only allow C<poll> and
		4639	C<select> backends.
		4640
		4641	=head2 AIX POLL BUG
		4642
		4643	AIX unfortunately has a broken C<poll.h> header. Libev works around
		4644	this by trying to avoid the poll backend altogether (i.e. it's not even
		4645	compiled in), which normally isn't a big problem as C<select> works fine
		4646	with large bitsets on AIX, and AIX is dead anyway.
		4647
4213	=head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS	4648	=head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS
		4649
		4650	=head3 General issues
4214		4651
4215	Win32 doesn't support any of the standards (e.g. POSIX) that libev	4652	Win32 doesn't support any of the standards (e.g. POSIX) that libev
4216	requires, and its I/O model is fundamentally incompatible with the POSIX	4653	requires, and its I/O model is fundamentally incompatible with the POSIX
4217	model. Libev still offers limited functionality on this platform in	4654	model. Libev still offers limited functionality on this platform in
4218	the form of the C<EVBACKEND_SELECT> backend, and only supports socket	4655	the form of the C<EVBACKEND_SELECT> backend, and only supports socket
4219	descriptors. This only applies when using Win32 natively, not when using	4656	descriptors. This only applies when using Win32 natively, not when using
4220	e.g. cygwin.	4657	e.g. cygwin. Actually, it only applies to the microsofts own compilers,
		4658	as every compielr comes with a slightly differently broken/incompatible
		4659	environment.
4221		4660
4222	Lifting these limitations would basically require the full	4661	Lifting these limitations would basically require the full
4223	re-implementation of the I/O system. If you are into these kinds of	4662	re-implementation of the I/O system. If you are into this kind of thing,
4224	things, then note that glib does exactly that for you in a very portable	4663	then note that glib does exactly that for you in a very portable way (note
4225	way (note also that glib is the slowest event library known to man).	4664	also that glib is the slowest event library known to man).
4226		4665
4227	There is no supported compilation method available on windows except	4666	There is no supported compilation method available on windows except
4228	embedding it into other applications.	4667	embedding it into other applications.
4229		4668
4230	Sensible signal handling is officially unsupported by Microsoft - libev	4669	Sensible signal handling is officially unsupported by Microsoft - libev
…		…
4258	you do I<not> compile the F<ev.c> or any other embedded source files!):	4697	you do I<not> compile the F<ev.c> or any other embedded source files!):
4259		4698
4260	#include "evwrap.h"	4699	#include "evwrap.h"
4261	#include "ev.c"	4700	#include "ev.c"
4262		4701
4263	=over 4
4264
4265	=item The winsocket select function	4702	=head3 The winsocket C<select> function
4266		4703
4267	The winsocket C<select> function doesn't follow POSIX in that it	4704	The winsocket C<select> function doesn't follow POSIX in that it
4268	requires socket I<handles> and not socket I<file descriptors> (it is	4705	requires socket I<handles> and not socket I<file descriptors> (it is
4269	also extremely buggy). This makes select very inefficient, and also	4706	also extremely buggy). This makes select very inefficient, and also
4270	requires a mapping from file descriptors to socket handles (the Microsoft	4707	requires a mapping from file descriptors to socket handles (the Microsoft
…		…
4279	#define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */	4716	#define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */
4280		4717
4281	Note that winsockets handling of fd sets is O(n), so you can easily get a	4718	Note that winsockets handling of fd sets is O(n), so you can easily get a
4282	complexity in the O(n²) range when using win32.	4719	complexity in the O(n²) range when using win32.
4283		4720
4284	=item Limited number of file descriptors	4721	=head3 Limited number of file descriptors
4285		4722
4286	Windows has numerous arbitrary (and low) limits on things.	4723	Windows has numerous arbitrary (and low) limits on things.
4287		4724
4288	Early versions of winsocket's select only supported waiting for a maximum	4725	Early versions of winsocket's select only supported waiting for a maximum
4289	of C<64> handles (probably owning to the fact that all windows kernels	4726	of C<64> handles (probably owning to the fact that all windows kernels
…		…
4304	runtime libraries. This might get you to about C<512> or C<2048> sockets	4741	runtime libraries. This might get you to about C<512> or C<2048> sockets
4305	(depending on windows version and/or the phase of the moon). To get more,	4742	(depending on windows version and/or the phase of the moon). To get more,
4306	you need to wrap all I/O functions and provide your own fd management, but	4743	you need to wrap all I/O functions and provide your own fd management, but
4307	the cost of calling select (O(n²)) will likely make this unworkable.	4744	the cost of calling select (O(n²)) will likely make this unworkable.
4308		4745
4309	=back
4310
4311	=head2 PORTABILITY REQUIREMENTS	4746	=head2 PORTABILITY REQUIREMENTS
4312		4747
4313	In addition to a working ISO-C implementation and of course the	4748	In addition to a working ISO-C implementation and of course the
4314	backend-specific APIs, libev relies on a few additional extensions:	4749	backend-specific APIs, libev relies on a few additional extensions:
4315		4750
…		…
4353	watchers.	4788	watchers.
4354		4789
4355	=item C<double> must hold a time value in seconds with enough accuracy	4790	=item C<double> must hold a time value in seconds with enough accuracy
4356		4791
4357	The type C<double> is used to represent timestamps. It is required to	4792	The type C<double> is used to represent timestamps. It is required to
4358	have at least 51 bits of mantissa (and 9 bits of exponent), which is good	4793	have at least 51 bits of mantissa (and 9 bits of exponent), which is
4359	enough for at least into the year 4000. This requirement is fulfilled by	4794	good enough for at least into the year 4000 with millisecond accuracy
		4795	(the design goal for libev). This requirement is overfulfilled by
4360	implementations implementing IEEE 754, which is basically all existing	4796	implementations using IEEE 754, which is basically all existing ones. With
4361	ones. With IEEE 754 doubles, you get microsecond accuracy until at least	4797	IEEE 754 doubles, you get microsecond accuracy until at least 2200.
4362	2200.
4363		4798
4364	=back	4799	=back
4365		4800
4366	If you know of other additional requirements drop me a note.	4801	If you know of other additional requirements drop me a note.
4367		4802
…		…
4435	involves iterating over all running async watchers or all signal numbers.	4870	involves iterating over all running async watchers or all signal numbers.
4436		4871
4437	=back	4872	=back
4438		4873
4439		4874
		4875	=head1 PORTING FROM LIBEV 3.X TO 4.X
		4876
		4877	The major version 4 introduced some minor incompatible changes to the API.
		4878
		4879	At the moment, the C<ev.h> header file tries to implement superficial
		4880	compatibility, so most programs should still compile. Those might be
		4881	removed in later versions of libev, so better update early than late.
		4882
		4883	=over 4
		4884
		4885	=item C<ev_default_destroy> and C<ev_default_fork> have been removed
		4886
		4887	These calls can be replaced easily by their C<ev_loop_xxx> counterparts:
		4888
		4889	ev_loop_destroy (EV_DEFAULT_UC);
		4890	ev_loop_fork (EV_DEFAULT);
		4891
		4892	=item function/symbol renames
		4893
		4894	A number of functions and symbols have been renamed:
		4895
		4896	ev_loop => ev_run
		4897	EVLOOP_NONBLOCK => EVRUN_NOWAIT
		4898	EVLOOP_ONESHOT => EVRUN_ONCE
		4899
		4900	ev_unloop => ev_break
		4901	EVUNLOOP_CANCEL => EVBREAK_CANCEL
		4902	EVUNLOOP_ONE => EVBREAK_ONE
		4903	EVUNLOOP_ALL => EVBREAK_ALL
		4904
		4905	EV_TIMEOUT => EV_TIMER
		4906
		4907	ev_loop_count => ev_iteration
		4908	ev_loop_depth => ev_depth
		4909	ev_loop_verify => ev_verify
		4910
		4911	Most functions working on C<struct ev_loop> objects don't have an
		4912	C<ev_loop_> prefix, so it was removed; C<ev_loop>, C<ev_unloop> and
		4913	associated constants have been renamed to not collide with the C<struct
		4914	ev_loop> anymore and C<EV_TIMER> now follows the same naming scheme
		4915	as all other watcher types. Note that C<ev_loop_fork> is still called
		4916	C<ev_loop_fork> because it would otherwise clash with the C<ev_fork>
		4917	typedef.
		4918
		4919	=item C<EV_COMPAT3> backwards compatibility mechanism
		4920
		4921	The backward compatibility mechanism can be controlled by
		4922	C<EV_COMPAT3>. See L<PREPROCESSOR SYMBOLS/MACROS> in the L<EMBEDDING>
		4923	section.
		4924
		4925	=item C<EV_MINIMAL> mechanism replaced by C<EV_FEATURES>
		4926
		4927	The preprocessor symbol C<EV_MINIMAL> has been replaced by a different
		4928	mechanism, C<EV_FEATURES>. Programs using C<EV_MINIMAL> usually compile
		4929	and work, but the library code will of course be larger.
		4930
		4931	=back
		4932
		4933
4440	=head1 GLOSSARY	4934	=head1 GLOSSARY
4441		4935
4442	=over 4	4936	=over 4
4443		4937
4444	=item active	4938	=item active
4445		4939
4446	A watcher is active as long as it has been started (has been attached to	4940	A watcher is active as long as it has been started and not yet stopped.
4447	an event loop) but not yet stopped (disassociated from the event loop).	4941	See L<WATCHER STATES> for details.
4448		4942
4449	=item application	4943	=item application
4450		4944
4451	In this document, an application is whatever is using libev.	4945	In this document, an application is whatever is using libev.
		4946
		4947	=item backend
		4948
		4949	The part of the code dealing with the operating system interfaces.
4452		4950
4453	=item callback	4951	=item callback
4454		4952
4455	The address of a function that is called when some event has been	4953	The address of a function that is called when some event has been
4456	detected. Callbacks are being passed the event loop, the watcher that	4954	detected. Callbacks are being passed the event loop, the watcher that
4457	received the event, and the actual event bitset.	4955	received the event, and the actual event bitset.
4458		4956
4459	=item callback invocation	4957	=item callback/watcher invocation
4460		4958
4461	The act of calling the callback associated with a watcher.	4959	The act of calling the callback associated with a watcher.
4462		4960
4463	=item event	4961	=item event
4464		4962
4465	A change of state of some external event, such as data now being available	4963	A change of state of some external event, such as data now being available
4466	for reading on a file descriptor, time having passed or simply not having	4964	for reading on a file descriptor, time having passed or simply not having
4467	any other events happening anymore.	4965	any other events happening anymore.
4468		4966
4469	In libev, events are represented as single bits (such as C<EV_READ> or	4967	In libev, events are represented as single bits (such as C<EV_READ> or
4470	C<EV_TIMEOUT>).	4968	C<EV_TIMER>).
4471		4969
4472	=item event library	4970	=item event library
4473		4971
4474	A software package implementing an event model and loop.	4972	A software package implementing an event model and loop.
4475		4973
…		…
4483	The model used to describe how an event loop handles and processes	4981	The model used to describe how an event loop handles and processes
4484	watchers and events.	4982	watchers and events.
4485		4983
4486	=item pending	4984	=item pending
4487		4985
4488	A watcher is pending as soon as the corresponding event has been detected,	4986	A watcher is pending as soon as the corresponding event has been
4489	and stops being pending as soon as the watcher will be invoked or its	4987	detected. See L<WATCHER STATES> for details.
4490	pending status is explicitly cleared by the application.
4491
4492	A watcher can be pending, but not active. Stopping a watcher also clears
4493	its pending status.
4494		4988
4495	=item real time	4989	=item real time
4496		4990
4497	The physical time that is observed. It is apparently strictly monotonic :)	4991	The physical time that is observed. It is apparently strictly monotonic :)
4498		4992
…		…
4505	=item watcher	4999	=item watcher
4506		5000
4507	A data structure that describes interest in certain events. Watchers need	5001	A data structure that describes interest in certain events. Watchers need
4508	to be started (attached to an event loop) before they can receive events.	5002	to be started (attached to an event loop) before they can receive events.
4509		5003
4510	=item watcher invocation
4511
4512	The act of calling the callback associated with a watcher.
4513
4514	=back	5004	=back
4515		5005
4516	=head1 AUTHOR	5006	=head1 AUTHOR
4517		5007
4518	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson.	5008	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson.

Diff Legend

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