ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.292 by sf-exg, Mon Mar 22 09:57:01 2010 UTC vs.
Revision 1.463 by root, Wed Jan 22 14:09:07 2020 UTC

		1	=encoding utf-8
		2
1	=head1 NAME	3	=head1 NAME
2		4
3	libev - a high performance full-featured event loop written in C	5	libev - a high performance full-featured event loop written in C
4		6
5	=head1 SYNOPSIS	7	=head1 SYNOPSIS
…		…
26	puts ("stdin ready");	28	puts ("stdin ready");
27	// for one-shot events, one must manually stop the watcher	29	// for one-shot events, one must manually stop the watcher
28	// with its corresponding stop function.	30	// with its corresponding stop function.
29	ev_io_stop (EV_A_ w);	31	ev_io_stop (EV_A_ w);
30		32
31	// this causes all nested ev_loop's to stop iterating	33	// this causes all nested ev_run's to stop iterating
32	ev_unloop (EV_A_ EVUNLOOP_ALL);	34	ev_break (EV_A_ EVBREAK_ALL);
33	}	35	}
34		36
35	// another callback, this time for a time-out	37	// another callback, this time for a time-out
36	static void	38	static void
37	timeout_cb (EV_P_ ev_timer *w, int revents)	39	timeout_cb (EV_P_ ev_timer *w, int revents)
38	{	40	{
39	puts ("timeout");	41	puts ("timeout");
40	// this causes the innermost ev_loop to stop iterating	42	// this causes the innermost ev_run to stop iterating
41	ev_unloop (EV_A_ EVUNLOOP_ONE);	43	ev_break (EV_A_ EVBREAK_ONE);
42	}	44	}
43		45
44	int	46	int
45	main (void)	47	main (void)
46	{	48	{
47	// use the default event loop unless you have special needs	49	// use the default event loop unless you have special needs
48	struct ev_loop *loop = ev_default_loop (0);	50	struct ev_loop *loop = EV_DEFAULT;
49		51
50	// initialise an io watcher, then start it	52	// initialise an io watcher, then start it
51	// this one will watch for stdin to become readable	53	// this one will watch for stdin to become readable
52	ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);	54	ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);
53	ev_io_start (loop, &stdin_watcher);	55	ev_io_start (loop, &stdin_watcher);
…		…
56	// simple non-repeating 5.5 second timeout	58	// simple non-repeating 5.5 second timeout
57	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);	59	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
58	ev_timer_start (loop, &timeout_watcher);	60	ev_timer_start (loop, &timeout_watcher);
59		61
60	// now wait for events to arrive	62	// now wait for events to arrive
61	ev_loop (loop, 0);	63	ev_run (loop, 0);
62		64
63	// unloop was called, so exit	65	// break was called, so exit
64	return 0;	66	return 0;
65	}	67	}
66		68
67	=head1 ABOUT THIS DOCUMENT	69	=head1 ABOUT THIS DOCUMENT
68		70
…		…
75	While this document tries to be as complete as possible in documenting	77	While this document tries to be as complete as possible in documenting
76	libev, its usage and the rationale behind its design, it is not a tutorial	78	libev, its usage and the rationale behind its design, it is not a tutorial
77	on event-based programming, nor will it introduce event-based programming	79	on event-based programming, nor will it introduce event-based programming
78	with libev.	80	with libev.
79		81
80	Familarity with event based programming techniques in general is assumed	82	Familiarity with event based programming techniques in general is assumed
81	throughout this document.	83	throughout this document.
		84
		85	=head1 WHAT TO READ WHEN IN A HURRY
		86
		87	This manual tries to be very detailed, but unfortunately, this also makes
		88	it very long. If you just want to know the basics of libev, I suggest
		89	reading L</ANATOMY OF A WATCHER>, then the L</EXAMPLE PROGRAM> above and
		90	look up the missing functions in L</GLOBAL FUNCTIONS> and the C<ev_io> and
		91	C<ev_timer> sections in L</WATCHER TYPES>.
82		92
83	=head1 ABOUT LIBEV	93	=head1 ABOUT LIBEV
84		94
85	Libev is an event loop: you register interest in certain events (such as a	95	Libev is an event loop: you register interest in certain events (such as a
86	file descriptor being readable or a timeout occurring), and it will manage	96	file descriptor being readable or a timeout occurring), and it will manage
…		…
95	details of the event, and then hand it over to libev by I<starting> the	105	details of the event, and then hand it over to libev by I<starting> the
96	watcher.	106	watcher.
97		107
98	=head2 FEATURES	108	=head2 FEATURES
99		109
100	Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the	110	Libev supports C<select>, C<poll>, the Linux-specific aio and C<epoll>
101	BSD-specific C<kqueue> and the Solaris-specific event port mechanisms	111	interfaces, the BSD-specific C<kqueue> and the Solaris-specific event port
102	for file descriptor events (C<ev_io>), the Linux C<inotify> interface	112	mechanisms for file descriptor events (C<ev_io>), the Linux C<inotify>
103	(for C<ev_stat>), Linux eventfd/signalfd (for faster and cleaner	113	interface (for C<ev_stat>), Linux eventfd/signalfd (for faster and cleaner
104	inter-thread wakeup (C<ev_async>)/signal handling (C<ev_signal>)) relative	114	inter-thread wakeup (C<ev_async>)/signal handling (C<ev_signal>)) relative
105	timers (C<ev_timer>), absolute timers with customised rescheduling	115	timers (C<ev_timer>), absolute timers with customised rescheduling
106	(C<ev_periodic>), synchronous signals (C<ev_signal>), process status	116	(C<ev_periodic>), synchronous signals (C<ev_signal>), process status
107	change events (C<ev_child>), and event watchers dealing with the event	117	change events (C<ev_child>), and event watchers dealing with the event
108	loop mechanism itself (C<ev_idle>, C<ev_embed>, C<ev_prepare> and	118	loop mechanism itself (C<ev_idle>, C<ev_embed>, C<ev_prepare> and
…		…
124	this argument.	134	this argument.
125		135
126	=head2 TIME REPRESENTATION	136	=head2 TIME REPRESENTATION
127		137
128	Libev represents time as a single floating point number, representing	138	Libev represents time as a single floating point number, representing
129	the (fractional) number of seconds since the (POSIX) epoch (somewhere	139	the (fractional) number of seconds since the (POSIX) epoch (in practice
130	near the beginning of 1970, details are complicated, don't ask). This	140	somewhere near the beginning of 1970, details are complicated, don't
131	type is called C<ev_tstamp>, which is what you should use too. It usually	141	ask). This type is called C<ev_tstamp>, which is what you should use
132	aliases to the C<double> type in C. When you need to do any calculations	142	too. It usually aliases to the C<double> type in C. When you need to do
133	on it, you should treat it as some floating point value. Unlike the name	143	any calculations on it, you should treat it as some floating point value.
		144
134	component C<stamp> might indicate, it is also used for time differences	145	Unlike the name component C<stamp> might indicate, it is also used for
135	throughout libev.	146	time differences (e.g. delays) throughout libev.
136		147
137	=head1 ERROR HANDLING	148	=head1 ERROR HANDLING
138		149
139	Libev knows three classes of errors: operating system errors, usage errors	150	Libev knows three classes of errors: operating system errors, usage errors
140	and internal errors (bugs).	151	and internal errors (bugs).
…		…
148	When libev detects a usage error such as a negative timer interval, then	159	When libev detects a usage error such as a negative timer interval, then
149	it will print a diagnostic message and abort (via the C<assert> mechanism,	160	it will print a diagnostic message and abort (via the C<assert> mechanism,
150	so C<NDEBUG> will disable this checking): these are programming errors in	161	so C<NDEBUG> will disable this checking): these are programming errors in
151	the libev caller and need to be fixed there.	162	the libev caller and need to be fixed there.
152		163
		164	Via the C<EV_FREQUENT> macro you can compile in and/or enable extensive
		165	consistency checking code inside libev that can be used to check for
		166	internal inconsistencies, suually caused by application bugs.
		167
153	Libev also has a few internal error-checking C<assert>ions, and also has	168	Libev also has a few internal error-checking C<assert>ions. These do not
154	extensive consistency checking code. These do not trigger under normal
155	circumstances, as they indicate either a bug in libev or worse.	169	trigger under normal circumstances, as they indicate either a bug in libev
		170	or worse.
156		171
157		172
158	=head1 GLOBAL FUNCTIONS	173	=head1 GLOBAL FUNCTIONS
159		174
160	These functions can be called anytime, even before initialising the	175	These functions can be called anytime, even before initialising the
…		…
164		179
165	=item ev_tstamp ev_time ()	180	=item ev_tstamp ev_time ()
166		181
167	Returns the current time as libev would use it. Please note that the	182	Returns the current time as libev would use it. Please note that the
168	C<ev_now> function is usually faster and also often returns the timestamp	183	C<ev_now> function is usually faster and also often returns the timestamp
169	you actually want to know.	184	you actually want to know. Also interesting is the combination of
		185	C<ev_now_update> and C<ev_now>.
170		186
171	=item ev_sleep (ev_tstamp interval)	187	=item ev_sleep (ev_tstamp interval)
172		188
173	Sleep for the given interval: The current thread will be blocked until	189	Sleep for the given interval: The current thread will be blocked
174	either it is interrupted or the given time interval has passed. Basically	190	until either it is interrupted or the given time interval has
		191	passed (approximately - it might return a bit earlier even if not
		192	interrupted). Returns immediately if C<< interval <= 0 >>.
		193
175	this is a sub-second-resolution C<sleep ()>.	194	Basically this is a sub-second-resolution C<sleep ()>.
		195
		196	The range of the C<interval> is limited - libev only guarantees to work
		197	with sleep times of up to one day (C<< interval <= 86400 >>).
176		198
177	=item int ev_version_major ()	199	=item int ev_version_major ()
178		200
179	=item int ev_version_minor ()	201	=item int ev_version_minor ()
180		202
…		…
191	as this indicates an incompatible change. Minor versions are usually	213	as this indicates an incompatible change. Minor versions are usually
192	compatible to older versions, so a larger minor version alone is usually	214	compatible to older versions, so a larger minor version alone is usually
193	not a problem.	215	not a problem.
194		216
195	Example: Make sure we haven't accidentally been linked against the wrong	217	Example: Make sure we haven't accidentally been linked against the wrong
196	version.	218	version (note, however, that this will not detect other ABI mismatches,
		219	such as LFS or reentrancy).
197		220
198	assert (("libev version mismatch",	221	assert (("libev version mismatch",
199	ev_version_major () == EV_VERSION_MAJOR	222	ev_version_major () == EV_VERSION_MAJOR
200	&& ev_version_minor () >= EV_VERSION_MINOR));	223	&& ev_version_minor () >= EV_VERSION_MINOR));
201		224
…		…
212	assert (("sorry, no epoll, no sex",	235	assert (("sorry, no epoll, no sex",
213	ev_supported_backends () & EVBACKEND_EPOLL));	236	ev_supported_backends () & EVBACKEND_EPOLL));
214		237
215	=item unsigned int ev_recommended_backends ()	238	=item unsigned int ev_recommended_backends ()
216		239
217	Return the set of all backends compiled into this binary of libev and also	240	Return the set of all backends compiled into this binary of libev and
218	recommended for this platform. This set is often smaller than the one	241	also recommended for this platform, meaning it will work for most file
		242	descriptor types. This set is often smaller than the one returned by
219	returned by C<ev_supported_backends>, as for example kqueue is broken on	243	C<ev_supported_backends>, as for example kqueue is broken on most BSDs
220	most BSDs and will not be auto-detected unless you explicitly request it	244	and will not be auto-detected unless you explicitly request it (assuming
221	(assuming you know what you are doing). This is the set of backends that	245	you know what you are doing). This is the set of backends that libev will
222	libev will probe for if you specify no backends explicitly.	246	probe for if you specify no backends explicitly.
223		247
224	=item unsigned int ev_embeddable_backends ()	248	=item unsigned int ev_embeddable_backends ()
225		249
226	Returns the set of backends that are embeddable in other event loops. This	250	Returns the set of backends that are embeddable in other event loops. This
227	is the theoretical, all-platform, value. To find which backends	251	value is platform-specific but can include backends not available on the
228	might be supported on the current system, you would need to look at	252	current system. To find which embeddable backends might be supported on
229	C<ev_embeddable_backends () & ev_supported_backends ()>, likewise for	253	the current system, you would need to look at C<ev_embeddable_backends ()
230	recommended ones.	254	& ev_supported_backends ()>, likewise for recommended ones.
231		255
232	See the description of C<ev_embed> watchers for more info.	256	See the description of C<ev_embed> watchers for more info.
233		257
234	=item ev_set_allocator (void *(*cb)(void *ptr, long size)) [NOT REENTRANT]	258	=item ev_set_allocator (void *(*cb)(void *ptr, long size) throw ())
235		259
236	Sets the allocation function to use (the prototype is similar - the	260	Sets the allocation function to use (the prototype is similar - the
237	semantics are identical to the C<realloc> C89/SuS/POSIX function). It is	261	semantics are identical to the C<realloc> C89/SuS/POSIX function). It is
238	used to allocate and free memory (no surprises here). If it returns zero	262	used to allocate and free memory (no surprises here). If it returns zero
239	when memory needs to be allocated (C<size != 0>), the library might abort	263	when memory needs to be allocated (C<size != 0>), the library might abort
…		…
245		269
246	You could override this function in high-availability programs to, say,	270	You could override this function in high-availability programs to, say,
247	free some memory if it cannot allocate memory, to use a special allocator,	271	free some memory if it cannot allocate memory, to use a special allocator,
248	or even to sleep a while and retry until some memory is available.	272	or even to sleep a while and retry until some memory is available.
249		273
		274	Example: The following is the C<realloc> function that libev itself uses
		275	which should work with C<realloc> and C<free> functions of all kinds and
		276	is probably a good basis for your own implementation.
		277
		278	static void *
		279	ev_realloc_emul (void *ptr, long size) EV_NOEXCEPT
		280	{
		281	if (size)
		282	return realloc (ptr, size);
		283
		284	free (ptr);
		285	return 0;
		286	}
		287
250	Example: Replace the libev allocator with one that waits a bit and then	288	Example: Replace the libev allocator with one that waits a bit and then
251	retries (example requires a standards-compliant C<realloc>).	289	retries.
252		290
253	static void *	291	static void *
254	persistent_realloc (void *ptr, size_t size)	292	persistent_realloc (void *ptr, size_t size)
255	{	293	{
		294	if (!size)
		295	{
		296	free (ptr);
		297	return 0;
		298	}
		299
256	for (;;)	300	for (;;)
257	{	301	{
258	void *newptr = realloc (ptr, size);	302	void *newptr = realloc (ptr, size);
259		303
260	if (newptr)	304	if (newptr)
…		…
265	}	309	}
266		310
267	...	311	...
268	ev_set_allocator (persistent_realloc);	312	ev_set_allocator (persistent_realloc);
269		313
270	=item ev_set_syserr_cb (void (*cb)(const char *msg)); [NOT REENTRANT]	314	=item ev_set_syserr_cb (void (*cb)(const char *msg) throw ())
271		315
272	Set the callback function to call on a retryable system call error (such	316	Set the callback function to call on a retryable system call error (such
273	as failed select, poll, epoll_wait). The message is a printable string	317	as failed select, poll, epoll_wait). The message is a printable string
274	indicating the system call or subsystem causing the problem. If this	318	indicating the system call or subsystem causing the problem. If this
275	callback is set, then libev will expect it to remedy the situation, no	319	callback is set, then libev will expect it to remedy the situation, no
…		…
287	}	331	}
288		332
289	...	333	...
290	ev_set_syserr_cb (fatal_error);	334	ev_set_syserr_cb (fatal_error);
291		335
		336	=item ev_feed_signal (int signum)
		337
		338	This function can be used to "simulate" a signal receive. It is completely
		339	safe to call this function at any time, from any context, including signal
		340	handlers or random threads.
		341
		342	Its main use is to customise signal handling in your process, especially
		343	in the presence of threads. For example, you could block signals
		344	by default in all threads (and specifying C<EVFLAG_NOSIGMASK> when
		345	creating any loops), and in one thread, use C<sigwait> or any other
		346	mechanism to wait for signals, then "deliver" them to libev by calling
		347	C<ev_feed_signal>.
		348
292	=back	349	=back
293		350
294	=head1 FUNCTIONS CONTROLLING THE EVENT LOOP	351	=head1 FUNCTIONS CONTROLLING EVENT LOOPS
295		352
296	An event loop is described by a C<struct ev_loop *> (the C<struct>	353	An event loop is described by a C<struct ev_loop *> (the C<struct> is
297	is I<not> optional in this case, as there is also an C<ev_loop>	354	I<not> optional in this case unless libev 3 compatibility is disabled, as
298	I<function>).	355	libev 3 had an C<ev_loop> function colliding with the struct name).
299		356
300	The library knows two types of such loops, the I<default> loop, which	357	The library knows two types of such loops, the I<default> loop, which
301	supports signals and child events, and dynamically created loops which do	358	supports child process events, and dynamically created event loops which
302	not.	359	do not.
303		360
304	=over 4	361	=over 4
305		362
306	=item struct ev_loop *ev_default_loop (unsigned int flags)	363	=item struct ev_loop *ev_default_loop (unsigned int flags)
307		364
308	This will initialise the default event loop if it hasn't been initialised	365	This returns the "default" event loop object, which is what you should
309	yet and return it. If the default loop could not be initialised, returns	366	normally use when you just need "the event loop". Event loop objects and
310	false. If it already was initialised it simply returns it (and ignores the	367	the C<flags> parameter are described in more detail in the entry for
311	flags. If that is troubling you, check C<ev_backend ()> afterwards).	368	C<ev_loop_new>.
		369
		370	If the default loop is already initialised then this function simply
		371	returns it (and ignores the flags. If that is troubling you, check
		372	C<ev_backend ()> afterwards). Otherwise it will create it with the given
		373	flags, which should almost always be C<0>, unless the caller is also the
		374	one calling C<ev_run> or otherwise qualifies as "the main program".
312		375
313	If you don't know what event loop to use, use the one returned from this	376	If you don't know what event loop to use, use the one returned from this
314	function.	377	function (or via the C<EV_DEFAULT> macro).
315		378
316	Note that this function is I<not> thread-safe, so if you want to use it	379	Note that this function is I<not> thread-safe, so if you want to use it
317	from multiple threads, you have to lock (note also that this is unlikely,	380	from multiple threads, you have to employ some kind of mutex (note also
318	as loops cannot be shared easily between threads anyway).	381	that this case is unlikely, as loops cannot be shared easily between
		382	threads anyway).
319		383
320	The default loop is the only loop that can handle C<ev_signal> and	384	The default loop is the only loop that can handle C<ev_child> watchers,
321	C<ev_child> watchers, and to do this, it always registers a handler	385	and to do this, it always registers a handler for C<SIGCHLD>. If this is
322	for C<SIGCHLD>. If this is a problem for your application you can either	386	a problem for your application you can either create a dynamic loop with
323	create a dynamic loop with C<ev_loop_new> that doesn't do that, or you	387	C<ev_loop_new> which doesn't do that, or you can simply overwrite the
324	can simply overwrite the C<SIGCHLD> signal handler I<after> calling	388	C<SIGCHLD> signal handler I<after> calling C<ev_default_init>.
325	C<ev_default_init>.	389
		390	Example: This is the most typical usage.
		391
		392	if (!ev_default_loop (0))
		393	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
		394
		395	Example: Restrict libev to the select and poll backends, and do not allow
		396	environment settings to be taken into account:
		397
		398	ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV);
		399
		400	=item struct ev_loop *ev_loop_new (unsigned int flags)
		401
		402	This will create and initialise a new event loop object. If the loop
		403	could not be initialised, returns false.
		404
		405	This function is thread-safe, and one common way to use libev with
		406	threads is indeed to create one loop per thread, and using the default
		407	loop in the "main" or "initial" thread.
326		408
327	The flags argument can be used to specify special behaviour or specific	409	The flags argument can be used to specify special behaviour or specific
328	backends to use, and is usually specified as C<0> (or C<EVFLAG_AUTO>).	410	backends to use, and is usually specified as C<0> (or C<EVFLAG_AUTO>).
329		411
330	The following flags are supported:	412	The following flags are supported:
…		…
340		422
341	If this flag bit is or'ed into the flag value (or the program runs setuid	423	If this flag bit is or'ed into the flag value (or the program runs setuid
342	or setgid) then libev will I<not> look at the environment variable	424	or setgid) then libev will I<not> look at the environment variable
343	C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will	425	C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will
344	override the flags completely if it is found in the environment. This is	426	override the flags completely if it is found in the environment. This is
345	useful to try out specific backends to test their performance, or to work	427	useful to try out specific backends to test their performance, to work
346	around bugs.	428	around bugs, or to make libev threadsafe (accessing environment variables
		429	cannot be done in a threadsafe way, but usually it works if no other
		430	thread modifies them).
347		431
348	=item C<EVFLAG_FORKCHECK>	432	=item C<EVFLAG_FORKCHECK>
349		433
350	Instead of calling C<ev_loop_fork> manually after a fork, you can also	434	Instead of calling C<ev_loop_fork> manually after a fork, you can also
351	make libev check for a fork in each iteration by enabling this flag.	435	make libev check for a fork in each iteration by enabling this flag.
352		436
353	This works by calling C<getpid ()> on every iteration of the loop,	437	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	438	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	439	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	440	GNU/Linux system for example, C<getpid> is actually a simple 5-insn
357	without a system call and thus I<very> fast, but my GNU/Linux system also has	441	sequence without a system call and thus I<very> fast, but my GNU/Linux
358	C<pthread_atfork> which is even faster).	442	system also has C<pthread_atfork> which is even faster). (Update: glibc
		443	versions 2.25 apparently removed the C<getpid> optimisation again).
359		444
360	The big advantage of this flag is that you can forget about fork (and	445	The big advantage of this flag is that you can forget about fork (and
361	forget about forgetting to tell libev about forking) when you use this	446	forget about forgetting to tell libev about forking, although you still
362	flag.	447	have to ignore C<SIGPIPE>) when you use this flag.
363		448
364	This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS>	449	This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS>
365	environment variable.	450	environment variable.
366		451
367	=item C<EVFLAG_NOINOTIFY>	452	=item C<EVFLAG_NOINOTIFY>
368		453
369	When this flag is specified, then libev will not attempt to use the	454	When this flag is specified, then libev will not attempt to use the
370	I<inotify> API for it's C<ev_stat> watchers. Apart from debugging and	455	I<inotify> API for its C<ev_stat> watchers. Apart from debugging and
371	testing, this flag can be useful to conserve inotify file descriptors, as	456	testing, this flag can be useful to conserve inotify file descriptors, as
372	otherwise each loop using C<ev_stat> watchers consumes one inotify handle.	457	otherwise each loop using C<ev_stat> watchers consumes one inotify handle.
373		458
374	=item C<EVFLAG_SIGNALFD>	459	=item C<EVFLAG_SIGNALFD>
375		460
376	When this flag is specified, then libev will attempt to use the	461	When this flag is specified, then libev will attempt to use the
377	I<signalfd> API for it's C<ev_signal> (and C<ev_child>) watchers. This API	462	I<signalfd> API for its C<ev_signal> (and C<ev_child>) watchers. This API
378	delivers signals synchronously, which makes it both faster and might make	463	delivers signals synchronously, which makes it both faster and might make
379	it possible to get the queued signal data. It can also simplify signal	464	it possible to get the queued signal data. It can also simplify signal
380	handling with threads, as long as you properly block signals in your	465	handling with threads, as long as you properly block signals in your
381	threads that are not interested in handling them.	466	threads that are not interested in handling them.
382		467
383	Signalfd will not be used by default as this changes your signal mask, and	468	Signalfd will not be used by default as this changes your signal mask, and
384	there are a lot of shoddy libraries and programs (glib's threadpool for	469	there are a lot of shoddy libraries and programs (glib's threadpool for
385	example) that can't properly initialise their signal masks.	470	example) that can't properly initialise their signal masks.
		471
		472	=item C<EVFLAG_NOSIGMASK>
		473
		474	When this flag is specified, then libev will avoid to modify the signal
		475	mask. Specifically, this means you have to make sure signals are unblocked
		476	when you want to receive them.
		477
		478	This behaviour is useful when you want to do your own signal handling, or
		479	want to handle signals only in specific threads and want to avoid libev
		480	unblocking the signals.
		481
		482	It's also required by POSIX in a threaded program, as libev calls
		483	C<sigprocmask>, whose behaviour is officially unspecified.
		484
		485	=item C<EVFLAG_NOTIMERFD>
		486
		487	When this flag is specified, the libev will avoid using a C<timerfd> to
		488	detect time jumps. It will still be able to detect time jumps, but takes
		489	longer and has a lower accuracy in doing so, but saves a file descriptor
		490	per loop.
		491
		492	The current implementation only tries to use a C<timerfd> when the first
		493	C<ev_periodic> watcher is started and falls back on other methods if it
		494	cannot be created, but this behaviour might change in the future.
386		495
387	=item C<EVBACKEND_SELECT> (value 1, portable select backend)	496	=item C<EVBACKEND_SELECT> (value 1, portable select backend)
388		497
389	This is your standard select(2) backend. Not I<completely> standard, as	498	This is your standard select(2) backend. Not I<completely> standard, as
390	libev tries to roll its own fd_set with no limits on the number of fds,	499	libev tries to roll its own fd_set with no limits on the number of fds,
…		…
415	This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and	524	This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and
416	C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>.	525	C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>.
417		526
418	=item C<EVBACKEND_EPOLL> (value 4, Linux)	527	=item C<EVBACKEND_EPOLL> (value 4, Linux)
419		528
420	Use the linux-specific epoll(7) interface (for both pre- and post-2.6.9	529	Use the Linux-specific epoll(7) interface (for both pre- and post-2.6.9
421	kernels).	530	kernels).
422		531
423	For few fds, this backend is a bit little slower than poll and select,	532	For few fds, this backend is a bit little slower than poll and select, but
424	but it scales phenomenally better. While poll and select usually scale	533	it scales phenomenally better. While poll and select usually scale like
425	like O(total_fds) where n is the total number of fds (or the highest fd),	534	O(total_fds) where total_fds is the total number of fds (or the highest
426	epoll scales either O(1) or O(active_fds).	535	fd), epoll scales either O(1) or O(active_fds).
427		536
428	The epoll mechanism deserves honorable mention as the most misdesigned	537	The epoll mechanism deserves honorable mention as the most misdesigned
429	of the more advanced event mechanisms: mere annoyances include silently	538	of the more advanced event mechanisms: mere annoyances include silently
430	dropping file descriptors, requiring a system call per change per file	539	dropping file descriptors, requiring a system call per change per file
431	descriptor (and unnecessary guessing of parameters), problems with dup and	540	descriptor (and unnecessary guessing of parameters), problems with dup,
		541	returning before the timeout value, resulting in additional iterations
		542	(and only giving 5ms accuracy while select on the same platform gives
432	so on. The biggest issue is fork races, however - if a program forks then	543	0.1ms) and so on. The biggest issue is fork races, however - if a program
433	I<both> parent and child process have to recreate the epoll set, which can	544	forks then I<both> parent and child process have to recreate the epoll
434	take considerable time (one syscall per file descriptor) and is of course	545	set, which can take considerable time (one syscall per file descriptor)
435	hard to detect.	546	and is of course hard to detect.
436		547
437	Epoll is also notoriously buggy - embedding epoll fds I<should> work, but	548	Epoll is also notoriously buggy - embedding epoll fds I<should> work,
438	of course I<doesn't>, and epoll just loves to report events for totally	549	but of course I<doesn't>, and epoll just loves to report events for
439	I<different> file descriptors (even already closed ones, so one cannot	550	totally I<different> file descriptors (even already closed ones, so
440	even remove them from the set) than registered in the set (especially	551	one cannot even remove them from the set) than registered in the set
441	on SMP systems). Libev tries to counter these spurious notifications by	552	(especially on SMP systems). Libev tries to counter these spurious
442	employing an additional generation counter and comparing that against the	553	notifications by employing an additional generation counter and comparing
443	events to filter out spurious ones, recreating the set when required.	554	that against the events to filter out spurious ones, recreating the set
		555	when required. Epoll also erroneously rounds down timeouts, but gives you
		556	no way to know when and by how much, so sometimes you have to busy-wait
		557	because epoll returns immediately despite a nonzero timeout. And last
		558	not least, it also refuses to work with some file descriptors which work
		559	perfectly fine with C<select> (files, many character devices...).
		560
		561	Epoll is truly the train wreck among event poll mechanisms, a frankenpoll,
		562	cobbled together in a hurry, no thought to design or interaction with
		563	others. Oh, the pain, will it ever stop...
444		564
445	While stopping, setting and starting an I/O watcher in the same iteration	565	While stopping, setting and starting an I/O watcher in the same iteration
446	will result in some caching, there is still a system call per such	566	will result in some caching, there is still a system call per such
447	incident (because the same I<file descriptor> could point to a different	567	incident (because the same I<file descriptor> could point to a different
448	I<file description> now), so its best to avoid that. Also, C<dup ()>'ed	568	I<file description> now), so its best to avoid that. Also, C<dup ()>'ed
…		…
460	All this means that, in practice, C<EVBACKEND_SELECT> can be as fast or	580	All this means that, in practice, C<EVBACKEND_SELECT> can be as fast or
461	faster than epoll for maybe up to a hundred file descriptors, depending on	581	faster than epoll for maybe up to a hundred file descriptors, depending on
462	the usage. So sad.	582	the usage. So sad.
463		583
464	While nominally embeddable in other event loops, this feature is broken in	584	While nominally embeddable in other event loops, this feature is broken in
465	all kernel versions tested so far.	585	a lot of kernel revisions, but probably(!) works in current versions.
466		586
467	This backend maps C<EV_READ> and C<EV_WRITE> in the same way as	587	This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
468	C<EVBACKEND_POLL>.	588	C<EVBACKEND_POLL>.
469		589
		590	=item C<EVBACKEND_LINUXAIO> (value 64, Linux)
		591
		592	Use the Linux-specific Linux AIO (I<not> C<< aio(7) >> but C<<
		593	io_submit(2) >>) event interface available in post-4.18 kernels (but libev
		594	only tries to use it in 4.19+).
		595
		596	This is another Linux train wreck of an event interface.
		597
		598	If this backend works for you (as of this writing, it was very
		599	experimental), it is the best event interface available on Linux and might
		600	be well worth enabling it - if it isn't available in your kernel this will
		601	be detected and this backend will be skipped.
		602
		603	This backend can batch oneshot requests and supports a user-space ring
		604	buffer to receive events. It also doesn't suffer from most of the design
		605	problems of epoll (such as not being able to remove event sources from
		606	the epoll set), and generally sounds too good to be true. Because, this
		607	being the Linux kernel, of course it suffers from a whole new set of
		608	limitations, forcing you to fall back to epoll, inheriting all its design
		609	issues.
		610
		611	For one, it is not easily embeddable (but probably could be done using
		612	an event fd at some extra overhead). It also is subject to a system wide
		613	limit that can be configured in F</proc/sys/fs/aio-max-nr>. If no AIO
		614	requests are left, this backend will be skipped during initialisation, and
		615	will switch to epoll when the loop is active.
		616
		617	Most problematic in practice, however, is that not all file descriptors
		618	work with it. For example, in Linux 5.1, TCP sockets, pipes, event fds,
		619	files, F</dev/null> and many others are supported, but ttys do not work
		620	properly (a known bug that the kernel developers don't care about, see
		621	L<https://lore.kernel.org/patchwork/patch/1047453/>), so this is not
		622	(yet?) a generic event polling interface.
		623
		624	Overall, it seems the Linux developers just don't want it to have a
		625	generic event handling mechanism other than C<select> or C<poll>.
		626
		627	To work around all these problem, the current version of libev uses its
		628	epoll backend as a fallback for file descriptor types that do not work. Or
		629	falls back completely to epoll if the kernel acts up.
		630
		631	This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
		632	C<EVBACKEND_POLL>.
		633
470	=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)	634	=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)
471		635
472	Kqueue deserves special mention, as at the time of this writing, it	636	Kqueue deserves special mention, as at the time this backend was
473	was broken on all BSDs except NetBSD (usually it doesn't work reliably	637	implemented, it was broken on all BSDs except NetBSD (usually it doesn't
474	with anything but sockets and pipes, except on Darwin, where of course	638	work reliably with anything but sockets and pipes, except on Darwin,
475	it's completely useless). Unlike epoll, however, whose brokenness	639	where of course it's completely useless). Unlike epoll, however, whose
476	is by design, these kqueue bugs can (and eventually will) be fixed	640	brokenness is by design, these kqueue bugs can be (and mostly have been)
477	without API changes to existing programs. For this reason it's not being	641	fixed without API changes to existing programs. For this reason it's not
478	"auto-detected" unless you explicitly specify it in the flags (i.e. using	642	being "auto-detected" on all platforms unless you explicitly specify it
479	C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough)	643	in the flags (i.e. using C<EVBACKEND_KQUEUE>) or libev was compiled on a
480	system like NetBSD.	644	known-to-be-good (-enough) system like NetBSD.
481		645
482	You still can embed kqueue into a normal poll or select backend and use it	646	You still can embed kqueue into a normal poll or select backend and use it
483	only for sockets (after having made sure that sockets work with kqueue on	647	only for sockets (after having made sure that sockets work with kqueue on
484	the target platform). See C<ev_embed> watchers for more info.	648	the target platform). See C<ev_embed> watchers for more info.
485		649
486	It scales in the same way as the epoll backend, but the interface to the	650	It scales in the same way as the epoll backend, but the interface to the
487	kernel is more efficient (which says nothing about its actual speed, of	651	kernel is more efficient (which says nothing about its actual speed, of
488	course). While stopping, setting and starting an I/O watcher does never	652	course). While stopping, setting and starting an I/O watcher does never
489	cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to	653	cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to
490	two event changes per incident. Support for C<fork ()> is very bad (but	654	two event changes per incident. Support for C<fork ()> is very bad (you
491	sane, unlike epoll) and it drops fds silently in similarly hard-to-detect	655	might have to leak fds on fork, but it's more sane than epoll) and it
492	cases	656	drops fds silently in similarly hard-to-detect cases.
493		657
494	This backend usually performs well under most conditions.	658	This backend usually performs well under most conditions.
495		659
496	While nominally embeddable in other event loops, this doesn't work	660	While nominally embeddable in other event loops, this doesn't work
497	everywhere, so you might need to test for this. And since it is broken	661	everywhere, so you might need to test for this. And since it is broken
…		…
514	=item C<EVBACKEND_PORT> (value 32, Solaris 10)	678	=item C<EVBACKEND_PORT> (value 32, Solaris 10)
515		679
516	This uses the Solaris 10 event port mechanism. As with everything on Solaris,	680	This uses the Solaris 10 event port mechanism. As with everything on Solaris,
517	it's really slow, but it still scales very well (O(active_fds)).	681	it's really slow, but it still scales very well (O(active_fds)).
518		682
519	Please note that Solaris event ports can deliver a lot of spurious
520	notifications, so you need to use non-blocking I/O or other means to avoid
521	blocking when no data (or space) is available.
522
523	While this backend scales well, it requires one system call per active	683	While this backend scales well, it requires one system call per active
524	file descriptor per loop iteration. For small and medium numbers of file	684	file descriptor per loop iteration. For small and medium numbers of file
525	descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend	685	descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend
526	might perform better.	686	might perform better.
527		687
528	On the positive side, with the exception of the spurious readiness	688	On the positive side, this backend actually performed fully to
529	notifications, this backend actually performed fully to specification
530	in all tests and is fully embeddable, which is a rare feat among the	689	specification in all tests and is fully embeddable, which is a rare feat
531	OS-specific backends (I vastly prefer correctness over speed hacks).	690	among the OS-specific backends (I vastly prefer correctness over speed
		691	hacks).
		692
		693	On the negative side, the interface is I<bizarre> - so bizarre that
		694	even sun itself gets it wrong in their code examples: The event polling
		695	function sometimes returns events to the caller even though an error
		696	occurred, but with no indication whether it has done so or not (yes, it's
		697	even documented that way) - deadly for edge-triggered interfaces where you
		698	absolutely have to know whether an event occurred or not because you have
		699	to re-arm the watcher.
		700
		701	Fortunately libev seems to be able to work around these idiocies.
532		702
533	This backend maps C<EV_READ> and C<EV_WRITE> in the same way as	703	This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
534	C<EVBACKEND_POLL>.	704	C<EVBACKEND_POLL>.
535		705
536	=item C<EVBACKEND_ALL>	706	=item C<EVBACKEND_ALL>
537		707
538	Try all backends (even potentially broken ones that wouldn't be tried	708	Try all backends (even potentially broken ones that wouldn't be tried
539	with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as	709	with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as
540	C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>.	710	C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>.
541		711
542	It is definitely not recommended to use this flag.	712	It is definitely not recommended to use this flag, use whatever
		713	C<ev_recommended_backends ()> returns, or simply do not specify a backend
		714	at all.
		715
		716	=item C<EVBACKEND_MASK>
		717
		718	Not a backend at all, but a mask to select all backend bits from a
		719	C<flags> value, in case you want to mask out any backends from a flags
		720	value (e.g. when modifying the C<LIBEV_FLAGS> environment variable).
543		721
544	=back	722	=back
545		723
546	If one or more of the backend flags are or'ed into the flags value,	724	If one or more of the backend flags are or'ed into the flags value,
547	then only these backends will be tried (in the reverse order as listed	725	then only these backends will be tried (in the reverse order as listed
548	here). If none are specified, all backends in C<ev_recommended_backends	726	here). If none are specified, all backends in C<ev_recommended_backends
549	()> will be tried.	727	()> will be tried.
550		728
551	Example: This is the most typical usage.
552
553	if (!ev_default_loop (0))
554	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
555
556	Example: Restrict libev to the select and poll backends, and do not allow
557	environment settings to be taken into account:
558
559	ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV);
560
561	Example: Use whatever libev has to offer, but make sure that kqueue is
562	used if available (warning, breaks stuff, best use only with your own
563	private event loop and only if you know the OS supports your types of
564	fds):
565
566	ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE);
567
568	=item struct ev_loop *ev_loop_new (unsigned int flags)
569
570	Similar to C<ev_default_loop>, but always creates a new event loop that is
571	always distinct from the default loop.
572
573	Note that this function I<is> thread-safe, and one common way to use
574	libev with threads is indeed to create one loop per thread, and using the
575	default loop in the "main" or "initial" thread.
576
577	Example: Try to create a event loop that uses epoll and nothing else.	729	Example: Try to create a event loop that uses epoll and nothing else.
578		730
579	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);	731	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
580	if (!epoller)	732	if (!epoller)
581	fatal ("no epoll found here, maybe it hides under your chair");	733	fatal ("no epoll found here, maybe it hides under your chair");
582		734
		735	Example: Use whatever libev has to offer, but make sure that kqueue is
		736	used if available.
		737
		738	struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE);
		739
		740	Example: Similarly, on linux, you mgiht want to take advantage of the
		741	linux aio backend if possible, but fall back to something else if that
		742	isn't available.
		743
		744	struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_LINUXAIO);
		745
583	=item ev_default_destroy ()	746	=item ev_loop_destroy (loop)
584		747
585	Destroys the default loop (frees all memory and kernel state etc.). None	748	Destroys an event loop object (frees all memory and kernel state
586	of the active event watchers will be stopped in the normal sense, so	749	etc.). None of the active event watchers will be stopped in the normal
587	e.g. C<ev_is_active> might still return true. It is your responsibility to	750	sense, so e.g. C<ev_is_active> might still return true. It is your
588	either stop all watchers cleanly yourself I<before> calling this function,	751	responsibility to either stop all watchers cleanly yourself I<before>
589	or cope with the fact afterwards (which is usually the easiest thing, you	752	calling this function, or cope with the fact afterwards (which is usually
590	can just ignore the watchers and/or C<free ()> them for example).	753	the easiest thing, you can just ignore the watchers and/or C<free ()> them
		754	for example).
591		755
592	Note that certain global state, such as signal state (and installed signal	756	Note that certain global state, such as signal state (and installed signal
593	handlers), will not be freed by this function, and related watchers (such	757	handlers), will not be freed by this function, and related watchers (such
594	as signal and child watchers) would need to be stopped manually.	758	as signal and child watchers) would need to be stopped manually.
595		759
596	In general it is not advisable to call this function except in the	760	This function is normally used on loop objects allocated by
597	rare occasion where you really need to free e.g. the signal handling	761	C<ev_loop_new>, but it can also be used on the default loop returned by
		762	C<ev_default_loop>, in which case it is not thread-safe.
		763
		764	Note that it is not advisable to call this function on the default loop
		765	except in the rare occasion where you really need to free its resources.
598	pipe fds. If you need dynamically allocated loops it is better to use	766	If you need dynamically allocated loops it is better to use C<ev_loop_new>
599	C<ev_loop_new> and C<ev_loop_destroy>.	767	and C<ev_loop_destroy>.
600		768
601	=item ev_loop_destroy (loop)	769	=item ev_loop_fork (loop)
602		770
603	Like C<ev_default_destroy>, but destroys an event loop created by an
604	earlier call to C<ev_loop_new>.
605
606	=item ev_default_fork ()
607
608	This function sets a flag that causes subsequent C<ev_loop> iterations	771	This function sets a flag that causes subsequent C<ev_run> iterations
609	to reinitialise the kernel state for backends that have one. Despite the	772	to reinitialise the kernel state for backends that have one. Despite
610	name, you can call it anytime, but it makes most sense after forking, in	773	the name, you can call it anytime you are allowed to start or stop
611	the child process (or both child and parent, but that again makes little	774	watchers (except inside an C<ev_prepare> callback), but it makes most
612	sense). You I<must> call it in the child before using any of the libev	775	sense after forking, in the child process. You I<must> call it (or use
613	functions, and it will only take effect at the next C<ev_loop> iteration.	776	C<EVFLAG_FORKCHECK>) in the child before resuming or calling C<ev_run>.
614		777
		778	In addition, if you want to reuse a loop (via this function or
		779	C<EVFLAG_FORKCHECK>), you I<also> have to ignore C<SIGPIPE>.
		780
615	Again, you I<have> to call it on I<any> loop that you want to re-use after	781	Again, you I<have> to call it on I<any> loop that you want to re-use after
616	a fork, I<even if you do not plan to use the loop in the parent>. This is	782	a fork, I<even if you do not plan to use the loop in the parent>. This is
617	because some kernel interfaces *cough* I<kqueue> *cough* do funny things	783	because some kernel interfaces *cough* I<kqueue> *cough* do funny things
618	during fork.	784	during fork.
619		785
620	On the other hand, you only need to call this function in the child	786	On the other hand, you only need to call this function in the child
621	process if and only if you want to use the event loop in the child. If you	787	process if and only if you want to use the event loop in the child. If
622	just fork+exec or create a new loop in the child, you don't have to call	788	you just fork+exec or create a new loop in the child, you don't have to
623	it at all.	789	call it at all (in fact, C<epoll> is so badly broken that it makes a
		790	difference, but libev will usually detect this case on its own and do a
		791	costly reset of the backend).
624		792
625	The function itself is quite fast and it's usually not a problem to call	793	The function itself is quite fast and it's usually not a problem to call
626	it just in case after a fork. To make this easy, the function will fit in	794	it just in case after a fork.
627	quite nicely into a call to C<pthread_atfork>:
628		795
		796	Example: Automate calling C<ev_loop_fork> on the default loop when
		797	using pthreads.
		798
		799	static void
		800	post_fork_child (void)
		801	{
		802	ev_loop_fork (EV_DEFAULT);
		803	}
		804
		805	...
629	pthread_atfork (0, 0, ev_default_fork);	806	pthread_atfork (0, 0, post_fork_child);
630
631	=item ev_loop_fork (loop)
632
633	Like C<ev_default_fork>, but acts on an event loop created by
634	C<ev_loop_new>. Yes, you have to call this on every allocated event loop
635	after fork that you want to re-use in the child, and how you keep track of
636	them is entirely your own problem.
637		807
638	=item int ev_is_default_loop (loop)	808	=item int ev_is_default_loop (loop)
639		809
640	Returns true when the given loop is, in fact, the default loop, and false	810	Returns true when the given loop is, in fact, the default loop, and false
641	otherwise.	811	otherwise.
642		812
643	=item unsigned int ev_iteration (loop)	813	=item unsigned int ev_iteration (loop)
644		814
645	Returns the current iteration count for the loop, which is identical to	815	Returns the current iteration count for the event loop, which is identical
646	the number of times libev did poll for new events. It starts at C<0> and	816	to the number of times libev did poll for new events. It starts at C<0>
647	happily wraps around with enough iterations.	817	and happily wraps around with enough iterations.
648		818
649	This value can sometimes be useful as a generation counter of sorts (it	819	This value can sometimes be useful as a generation counter of sorts (it
650	"ticks" the number of loop iterations), as it roughly corresponds with	820	"ticks" the number of loop iterations), as it roughly corresponds with
651	C<ev_prepare> and C<ev_check> calls - and is incremented between the	821	C<ev_prepare> and C<ev_check> calls - and is incremented between the
652	prepare and check phases.	822	prepare and check phases.
653		823
654	=item unsigned int ev_depth (loop)	824	=item unsigned int ev_depth (loop)
655		825
656	Returns the number of times C<ev_loop> was entered minus the number of	826	Returns the number of times C<ev_run> was entered minus the number of
657	times C<ev_loop> was exited, in other words, the recursion depth.	827	times C<ev_run> was exited normally, in other words, the recursion depth.
658		828
659	Outside C<ev_loop>, this number is zero. In a callback, this number is	829	Outside C<ev_run>, this number is zero. In a callback, this number is
660	C<1>, unless C<ev_loop> was invoked recursively (or from another thread),	830	C<1>, unless C<ev_run> was invoked recursively (or from another thread),
661	in which case it is higher.	831	in which case it is higher.
662		832
663	Leaving C<ev_loop> abnormally (setjmp/longjmp, cancelling the thread	833	Leaving C<ev_run> abnormally (setjmp/longjmp, cancelling the thread,
664	etc.), doesn't count as "exit" - consider this as a hint to avoid such	834	throwing an exception etc.), doesn't count as "exit" - consider this
665	ungentleman behaviour unless it's really convenient.	835	as a hint to avoid such ungentleman-like behaviour unless it's really
		836	convenient, in which case it is fully supported.
666		837
667	=item unsigned int ev_backend (loop)	838	=item unsigned int ev_backend (loop)
668		839
669	Returns one of the C<EVBACKEND_*> flags indicating the event backend in	840	Returns one of the C<EVBACKEND_*> flags indicating the event backend in
670	use.	841	use.
…		…
679		850
680	=item ev_now_update (loop)	851	=item ev_now_update (loop)
681		852
682	Establishes the current time by querying the kernel, updating the time	853	Establishes the current time by querying the kernel, updating the time
683	returned by C<ev_now ()> in the progress. This is a costly operation and	854	returned by C<ev_now ()> in the progress. This is a costly operation and
684	is usually done automatically within C<ev_loop ()>.	855	is usually done automatically within C<ev_run ()>.
685		856
686	This function is rarely useful, but when some event callback runs for a	857	This function is rarely useful, but when some event callback runs for a
687	very long time without entering the event loop, updating libev's idea of	858	very long time without entering the event loop, updating libev's idea of
688	the current time is a good idea.	859	the current time is a good idea.
689		860
690	See also L<The special problem of time updates> in the C<ev_timer> section.	861	See also L</The special problem of time updates> in the C<ev_timer> section.
691		862
692	=item ev_suspend (loop)	863	=item ev_suspend (loop)
693		864
694	=item ev_resume (loop)	865	=item ev_resume (loop)
695		866
696	These two functions suspend and resume a loop, for use when the loop is	867	These two functions suspend and resume an event loop, for use when the
697	not used for a while and timeouts should not be processed.	868	loop is not used for a while and timeouts should not be processed.
698		869
699	A typical use case would be an interactive program such as a game: When	870	A typical use case would be an interactive program such as a game: When
700	the user presses C<^Z> to suspend the game and resumes it an hour later it	871	the user presses C<^Z> to suspend the game and resumes it an hour later it
701	would be best to handle timeouts as if no time had actually passed while	872	would be best to handle timeouts as if no time had actually passed while
702	the program was suspended. This can be achieved by calling C<ev_suspend>	873	the program was suspended. This can be achieved by calling C<ev_suspend>
…		…
704	C<ev_resume> directly afterwards to resume timer processing.	875	C<ev_resume> directly afterwards to resume timer processing.
705		876
706	Effectively, all C<ev_timer> watchers will be delayed by the time spend	877	Effectively, all C<ev_timer> watchers will be delayed by the time spend
707	between C<ev_suspend> and C<ev_resume>, and all C<ev_periodic> watchers	878	between C<ev_suspend> and C<ev_resume>, and all C<ev_periodic> watchers
708	will be rescheduled (that is, they will lose any events that would have	879	will be rescheduled (that is, they will lose any events that would have
709	occured while suspended).	880	occurred while suspended).
710		881
711	After calling C<ev_suspend> you B<must not> call I<any> function on the	882	After calling C<ev_suspend> you B<must not> call I<any> function on the
712	given loop other than C<ev_resume>, and you B<must not> call C<ev_resume>	883	given loop other than C<ev_resume>, and you B<must not> call C<ev_resume>
713	without a previous call to C<ev_suspend>.	884	without a previous call to C<ev_suspend>.
714		885
715	Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the	886	Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the
716	event loop time (see C<ev_now_update>).	887	event loop time (see C<ev_now_update>).
717		888
718	=item ev_loop (loop, int flags)	889	=item bool ev_run (loop, int flags)
719		890
720	Finally, this is it, the event handler. This function usually is called	891	Finally, this is it, the event handler. This function usually is called
721	after you have initialised all your watchers and you want to start	892	after you have initialised all your watchers and you want to start
722	handling events.	893	handling events. It will ask the operating system for any new events, call
		894	the watcher callbacks, and then repeat the whole process indefinitely: This
		895	is why event loops are called I<loops>.
723		896
724	If the flags argument is specified as C<0>, it will not return until	897	If the flags argument is specified as C<0>, it will keep handling events
725	either no event watchers are active anymore or C<ev_unloop> was called.	898	until either no event watchers are active anymore or C<ev_break> was
		899	called.
726		900
		901	The return value is false if there are no more active watchers (which
		902	usually means "all jobs done" or "deadlock"), and true in all other cases
		903	(which usually means " you should call C<ev_run> again").
		904
727	Please note that an explicit C<ev_unloop> is usually better than	905	Please note that an explicit C<ev_break> is usually better than
728	relying on all watchers to be stopped when deciding when a program has	906	relying on all watchers to be stopped when deciding when a program has
729	finished (especially in interactive programs), but having a program	907	finished (especially in interactive programs), but having a program
730	that automatically loops as long as it has to and no longer by virtue	908	that automatically loops as long as it has to and no longer by virtue
731	of relying on its watchers stopping correctly, that is truly a thing of	909	of relying on its watchers stopping correctly, that is truly a thing of
732	beauty.	910	beauty.
733		911
		912	This function is I<mostly> exception-safe - you can break out of a
		913	C<ev_run> call by calling C<longjmp> in a callback, throwing a C++
		914	exception and so on. This does not decrement the C<ev_depth> value, nor
		915	will it clear any outstanding C<EVBREAK_ONE> breaks.
		916
734	A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle	917	A flags value of C<EVRUN_NOWAIT> will look for new events, will handle
735	those events and any already outstanding ones, but will not block your	918	those events and any already outstanding ones, but will not wait and
736	process in case there are no events and will return after one iteration of	919	block your process in case there are no events and will return after one
737	the loop.	920	iteration of the loop. This is sometimes useful to poll and handle new
		921	events while doing lengthy calculations, to keep the program responsive.
738		922
739	A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if	923	A flags value of C<EVRUN_ONCE> will look for new events (waiting if
740	necessary) and will handle those and any already outstanding ones. It	924	necessary) and will handle those and any already outstanding ones. It
741	will block your process until at least one new event arrives (which could	925	will block your process until at least one new event arrives (which could
742	be an event internal to libev itself, so there is no guarantee that a	926	be an event internal to libev itself, so there is no guarantee that a
743	user-registered callback will be called), and will return after one	927	user-registered callback will be called), and will return after one
744	iteration of the loop.	928	iteration of the loop.
745		929
746	This is useful if you are waiting for some external event in conjunction	930	This is useful if you are waiting for some external event in conjunction
747	with something not expressible using other libev watchers (i.e. "roll your	931	with something not expressible using other libev watchers (i.e. "roll your
748	own C<ev_loop>"). However, a pair of C<ev_prepare>/C<ev_check> watchers is	932	own C<ev_run>"). However, a pair of C<ev_prepare>/C<ev_check> watchers is
749	usually a better approach for this kind of thing.	933	usually a better approach for this kind of thing.
750		934
751	Here are the gory details of what C<ev_loop> does:	935	Here are the gory details of what C<ev_run> does (this is for your
		936	understanding, not a guarantee that things will work exactly like this in
		937	future versions):
752		938
		939	- Increment loop depth.
		940	- Reset the ev_break status.
753	- Before the first iteration, call any pending watchers.	941	- Before the first iteration, call any pending watchers.
		942	LOOP:
754	* If EVFLAG_FORKCHECK was used, check for a fork.	943	- If EVFLAG_FORKCHECK was used, check for a fork.
755	- If a fork was detected (by any means), queue and call all fork watchers.	944	- If a fork was detected (by any means), queue and call all fork watchers.
756	- Queue and call all prepare watchers.	945	- Queue and call all prepare watchers.
		946	- If ev_break was called, goto FINISH.
757	- If we have been forked, detach and recreate the kernel state	947	- If we have been forked, detach and recreate the kernel state
758	as to not disturb the other process.	948	as to not disturb the other process.
759	- Update the kernel state with all outstanding changes.	949	- Update the kernel state with all outstanding changes.
760	- Update the "event loop time" (ev_now ()).	950	- Update the "event loop time" (ev_now ()).
761	- Calculate for how long to sleep or block, if at all	951	- Calculate for how long to sleep or block, if at all
762	(active idle watchers, EVLOOP_NONBLOCK or not having	952	(active idle watchers, EVRUN_NOWAIT or not having
763	any active watchers at all will result in not sleeping).	953	any active watchers at all will result in not sleeping).
764	- Sleep if the I/O and timer collect interval say so.	954	- Sleep if the I/O and timer collect interval say so.
		955	- Increment loop iteration counter.
765	- Block the process, waiting for any events.	956	- Block the process, waiting for any events.
766	- Queue all outstanding I/O (fd) events.	957	- Queue all outstanding I/O (fd) events.
767	- Update the "event loop time" (ev_now ()), and do time jump adjustments.	958	- Update the "event loop time" (ev_now ()), and do time jump adjustments.
768	- Queue all expired timers.	959	- Queue all expired timers.
769	- Queue all expired periodics.	960	- Queue all expired periodics.
770	- Unless any events are pending now, queue all idle watchers.	961	- Queue all idle watchers with priority higher than that of pending events.
771	- Queue all check watchers.	962	- Queue all check watchers.
772	- Call all queued watchers in reverse order (i.e. check watchers first).	963	- Call all queued watchers in reverse order (i.e. check watchers first).
773	Signals and child watchers are implemented as I/O watchers, and will	964	Signals and child watchers are implemented as I/O watchers, and will
774	be handled here by queueing them when their watcher gets executed.	965	be handled here by queueing them when their watcher gets executed.
775	- If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK	966	- If ev_break has been called, or EVRUN_ONCE or EVRUN_NOWAIT
776	were used, or there are no active watchers, return, otherwise	967	were used, or there are no active watchers, goto FINISH, otherwise
777	continue with step *.	968	continue with step LOOP.
		969	FINISH:
		970	- Reset the ev_break status iff it was EVBREAK_ONE.
		971	- Decrement the loop depth.
		972	- Return.
778		973
779	Example: Queue some jobs and then loop until no events are outstanding	974	Example: Queue some jobs and then loop until no events are outstanding
780	anymore.	975	anymore.
781		976
782	... queue jobs here, make sure they register event watchers as long	977	... queue jobs here, make sure they register event watchers as long
783	... as they still have work to do (even an idle watcher will do..)	978	... as they still have work to do (even an idle watcher will do..)
784	ev_loop (my_loop, 0);	979	ev_run (my_loop, 0);
785	... jobs done or somebody called unloop. yeah!	980	... jobs done or somebody called break. yeah!
786		981
787	=item ev_unloop (loop, how)	982	=item ev_break (loop, how)
788		983
789	Can be used to make a call to C<ev_loop> return early (but only after it	984	Can be used to make a call to C<ev_run> return early (but only after it
790	has processed all outstanding events). The C<how> argument must be either	985	has processed all outstanding events). The C<how> argument must be either
791	C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or	986	C<EVBREAK_ONE>, which will make the innermost C<ev_run> call return, or
792	C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return.	987	C<EVBREAK_ALL>, which will make all nested C<ev_run> calls return.
793		988
794	This "unloop state" will be cleared when entering C<ev_loop> again.	989	This "break state" will be cleared on the next call to C<ev_run>.
795		990
796	It is safe to call C<ev_unloop> from otuside any C<ev_loop> calls.	991	It is safe to call C<ev_break> from outside any C<ev_run> calls, too, in
		992	which case it will have no effect.
797		993
798	=item ev_ref (loop)	994	=item ev_ref (loop)
799		995
800	=item ev_unref (loop)	996	=item ev_unref (loop)
801		997
802	Ref/unref can be used to add or remove a reference count on the event	998	Ref/unref can be used to add or remove a reference count on the event
803	loop: Every watcher keeps one reference, and as long as the reference	999	loop: Every watcher keeps one reference, and as long as the reference
804	count is nonzero, C<ev_loop> will not return on its own.	1000	count is nonzero, C<ev_run> will not return on its own.
805		1001
806	This is useful when you have a watcher that you never intend to	1002	This is useful when you have a watcher that you never intend to
807	unregister, but that nevertheless should not keep C<ev_loop> from	1003	unregister, but that nevertheless should not keep C<ev_run> from
808	returning. In such a case, call C<ev_unref> after starting, and C<ev_ref>	1004	returning. In such a case, call C<ev_unref> after starting, and C<ev_ref>
809	before stopping it.	1005	before stopping it.
810		1006
811	As an example, libev itself uses this for its internal signal pipe: It	1007	As an example, libev itself uses this for its internal signal pipe: It
812	is not visible to the libev user and should not keep C<ev_loop> from	1008	is not visible to the libev user and should not keep C<ev_run> from
813	exiting if no event watchers registered by it are active. It is also an	1009	exiting if no event watchers registered by it are active. It is also an
814	excellent way to do this for generic recurring timers or from within	1010	excellent way to do this for generic recurring timers or from within
815	third-party libraries. Just remember to I<unref after start> and I<ref	1011	third-party libraries. Just remember to I<unref after start> and I<ref
816	before stop> (but only if the watcher wasn't active before, or was active	1012	before stop> (but only if the watcher wasn't active before, or was active
817	before, respectively. Note also that libev might stop watchers itself	1013	before, respectively. Note also that libev might stop watchers itself
818	(e.g. non-repeating timers) in which case you have to C<ev_ref>	1014	(e.g. non-repeating timers) in which case you have to C<ev_ref>
819	in the callback).	1015	in the callback).
820		1016
821	Example: Create a signal watcher, but keep it from keeping C<ev_loop>	1017	Example: Create a signal watcher, but keep it from keeping C<ev_run>
822	running when nothing else is active.	1018	running when nothing else is active.
823		1019
824	ev_signal exitsig;	1020	ev_signal exitsig;
825	ev_signal_init (&exitsig, sig_cb, SIGINT);	1021	ev_signal_init (&exitsig, sig_cb, SIGINT);
826	ev_signal_start (loop, &exitsig);	1022	ev_signal_start (loop, &exitsig);
827	evf_unref (loop);	1023	ev_unref (loop);
828		1024
829	Example: For some weird reason, unregister the above signal handler again.	1025	Example: For some weird reason, unregister the above signal handler again.
830		1026
831	ev_ref (loop);	1027	ev_ref (loop);
832	ev_signal_stop (loop, &exitsig);	1028	ev_signal_stop (loop, &exitsig);
…		…
852	overhead for the actual polling but can deliver many events at once.	1048	overhead for the actual polling but can deliver many events at once.
853		1049
854	By setting a higher I<io collect interval> you allow libev to spend more	1050	By setting a higher I<io collect interval> you allow libev to spend more
855	time collecting I/O events, so you can handle more events per iteration,	1051	time collecting I/O events, so you can handle more events per iteration,
856	at the cost of increasing latency. Timeouts (both C<ev_periodic> and	1052	at the cost of increasing latency. Timeouts (both C<ev_periodic> and
857	C<ev_timer>) will be not affected. Setting this to a non-null value will	1053	C<ev_timer>) will not be affected. Setting this to a non-null value will
858	introduce an additional C<ev_sleep ()> call into most loop iterations. The	1054	introduce an additional C<ev_sleep ()> call into most loop iterations. The
859	sleep time ensures that libev will not poll for I/O events more often then	1055	sleep time ensures that libev will not poll for I/O events more often then
860	once per this interval, on average.	1056	once per this interval, on average (as long as the host time resolution is
		1057	good enough).
861		1058
862	Likewise, by setting a higher I<timeout collect interval> you allow libev	1059	Likewise, by setting a higher I<timeout collect interval> you allow libev
863	to spend more time collecting timeouts, at the expense of increased	1060	to spend more time collecting timeouts, at the expense of increased
864	latency/jitter/inexactness (the watcher callback will be called	1061	latency/jitter/inexactness (the watcher callback will be called
865	later). C<ev_io> watchers will not be affected. Setting this to a non-null	1062	later). C<ev_io> watchers will not be affected. Setting this to a non-null
…		…
871	usually doesn't make much sense to set it to a lower value than C<0.01>,	1068	usually doesn't make much sense to set it to a lower value than C<0.01>,
872	as this approaches the timing granularity of most systems. Note that if	1069	as this approaches the timing granularity of most systems. Note that if
873	you do transactions with the outside world and you can't increase the	1070	you do transactions with the outside world and you can't increase the
874	parallelity, then this setting will limit your transaction rate (if you	1071	parallelity, then this setting will limit your transaction rate (if you
875	need to poll once per transaction and the I/O collect interval is 0.01,	1072	need to poll once per transaction and the I/O collect interval is 0.01,
876	then you can't do more than 100 transations per second).	1073	then you can't do more than 100 transactions per second).
877		1074
878	Setting the I<timeout collect interval> can improve the opportunity for	1075	Setting the I<timeout collect interval> can improve the opportunity for
879	saving power, as the program will "bundle" timer callback invocations that	1076	saving power, as the program will "bundle" timer callback invocations that
880	are "near" in time together, by delaying some, thus reducing the number of	1077	are "near" in time together, by delaying some, thus reducing the number of
881	times the process sleeps and wakes up again. Another useful technique to	1078	times the process sleeps and wakes up again. Another useful technique to
…		…
889	ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01);	1086	ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01);
890		1087
891	=item ev_invoke_pending (loop)	1088	=item ev_invoke_pending (loop)
892		1089
893	This call will simply invoke all pending watchers while resetting their	1090	This call will simply invoke all pending watchers while resetting their
894	pending state. Normally, C<ev_loop> does this automatically when required,	1091	pending state. Normally, C<ev_run> does this automatically when required,
895	but when overriding the invoke callback this call comes handy.	1092	but when overriding the invoke callback this call comes handy. This
		1093	function can be invoked from a watcher - this can be useful for example
		1094	when you want to do some lengthy calculation and want to pass further
		1095	event handling to another thread (you still have to make sure only one
		1096	thread executes within C<ev_invoke_pending> or C<ev_run> of course).
896		1097
897	=item int ev_pending_count (loop)	1098	=item int ev_pending_count (loop)
898		1099
899	Returns the number of pending watchers - zero indicates that no watchers	1100	Returns the number of pending watchers - zero indicates that no watchers
900	are pending.	1101	are pending.
901		1102
902	=item ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P))	1103	=item ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P))
903		1104
904	This overrides the invoke pending functionality of the loop: Instead of	1105	This overrides the invoke pending functionality of the loop: Instead of
905	invoking all pending watchers when there are any, C<ev_loop> will call	1106	invoking all pending watchers when there are any, C<ev_run> will call
906	this callback instead. This is useful, for example, when you want to	1107	this callback instead. This is useful, for example, when you want to
907	invoke the actual watchers inside another context (another thread etc.).	1108	invoke the actual watchers inside another context (another thread etc.).
908		1109
909	If you want to reset the callback, use C<ev_invoke_pending> as new	1110	If you want to reset the callback, use C<ev_invoke_pending> as new
910	callback.	1111	callback.
911		1112
912	=item ev_set_loop_release_cb (loop, void (*release)(EV_P), void (*acquire)(EV_P))	1113	=item ev_set_loop_release_cb (loop, void (*release)(EV_P) throw (), void (*acquire)(EV_P) throw ())
913		1114
914	Sometimes you want to share the same loop between multiple threads. This	1115	Sometimes you want to share the same loop between multiple threads. This
915	can be done relatively simply by putting mutex_lock/unlock calls around	1116	can be done relatively simply by putting mutex_lock/unlock calls around
916	each call to a libev function.	1117	each call to a libev function.
917		1118
918	However, C<ev_loop> can run an indefinite time, so it is not feasible to	1119	However, C<ev_run> can run an indefinite time, so it is not feasible
919	wait for it to return. One way around this is to wake up the loop via	1120	to wait for it to return. One way around this is to wake up the event
920	C<ev_unloop> and C<av_async_send>, another way is to set these I<release>	1121	loop via C<ev_break> and C<ev_async_send>, another way is to set these
921	and I<acquire> callbacks on the loop.	1122	I<release> and I<acquire> callbacks on the loop.
922		1123
923	When set, then C<release> will be called just before the thread is	1124	When set, then C<release> will be called just before the thread is
924	suspended waiting for new events, and C<acquire> is called just	1125	suspended waiting for new events, and C<acquire> is called just
925	afterwards.	1126	afterwards.
926		1127
…		…
929		1130
930	While event loop modifications are allowed between invocations of	1131	While event loop modifications are allowed between invocations of
931	C<release> and C<acquire> (that's their only purpose after all), no	1132	C<release> and C<acquire> (that's their only purpose after all), no
932	modifications done will affect the event loop, i.e. adding watchers will	1133	modifications done will affect the event loop, i.e. adding watchers will
933	have no effect on the set of file descriptors being watched, or the time	1134	have no effect on the set of file descriptors being watched, or the time
934	waited. Use an C<ev_async> watcher to wake up C<ev_loop> when you want it	1135	waited. Use an C<ev_async> watcher to wake up C<ev_run> when you want it
935	to take note of any changes you made.	1136	to take note of any changes you made.
936		1137
937	In theory, threads executing C<ev_loop> will be async-cancel safe between	1138	In theory, threads executing C<ev_run> will be async-cancel safe between
938	invocations of C<release> and C<acquire>.	1139	invocations of C<release> and C<acquire>.
939		1140
940	See also the locking example in the C<THREADS> section later in this	1141	See also the locking example in the C<THREADS> section later in this
941	document.	1142	document.
942		1143
943	=item ev_set_userdata (loop, void *data)	1144	=item ev_set_userdata (loop, void *data)
944		1145
945	=item ev_userdata (loop)	1146	=item void *ev_userdata (loop)
946		1147
947	Set and retrieve a single C<void *> associated with a loop. When	1148	Set and retrieve a single C<void *> associated with a loop. When
948	C<ev_set_userdata> has never been called, then C<ev_userdata> returns	1149	C<ev_set_userdata> has never been called, then C<ev_userdata> returns
949	C<0.>	1150	C<0>.
950		1151
951	These two functions can be used to associate arbitrary data with a loop,	1152	These two functions can be used to associate arbitrary data with a loop,
952	and are intended solely for the C<invoke_pending_cb>, C<release> and	1153	and are intended solely for the C<invoke_pending_cb>, C<release> and
953	C<acquire> callbacks described above, but of course can be (ab-)used for	1154	C<acquire> callbacks described above, but of course can be (ab-)used for
954	any other purpose as well.	1155	any other purpose as well.
955		1156
956	=item ev_loop_verify (loop)	1157	=item ev_verify (loop)
957		1158
958	This function only does something when C<EV_VERIFY> support has been	1159	This function only does something when C<EV_VERIFY> support has been
959	compiled in, which is the default for non-minimal builds. It tries to go	1160	compiled in, which is the default for non-minimal builds. It tries to go
960	through all internal structures and checks them for validity. If anything	1161	through all internal structures and checks them for validity. If anything
961	is found to be inconsistent, it will print an error message to standard	1162	is found to be inconsistent, it will print an error message to standard
…		…
972		1173
973	In the following description, uppercase C<TYPE> in names stands for the	1174	In the following description, uppercase C<TYPE> in names stands for the
974	watcher type, e.g. C<ev_TYPE_start> can mean C<ev_timer_start> for timer	1175	watcher type, e.g. C<ev_TYPE_start> can mean C<ev_timer_start> for timer
975	watchers and C<ev_io_start> for I/O watchers.	1176	watchers and C<ev_io_start> for I/O watchers.
976		1177
977	A watcher is a structure that you create and register to record your	1178	A watcher is an opaque structure that you allocate and register to record
978	interest in some event. For instance, if you want to wait for STDIN to	1179	your interest in some event. To make a concrete example, imagine you want
979	become readable, you would create an C<ev_io> watcher for that:	1180	to wait for STDIN to become readable, you would create an C<ev_io> watcher
		1181	for that:
980		1182
981	static void my_cb (struct ev_loop *loop, ev_io *w, int revents)	1183	static void my_cb (struct ev_loop *loop, ev_io *w, int revents)
982	{	1184	{
983	ev_io_stop (w);	1185	ev_io_stop (w);
984	ev_unloop (loop, EVUNLOOP_ALL);	1186	ev_break (loop, EVBREAK_ALL);
985	}	1187	}
986		1188
987	struct ev_loop *loop = ev_default_loop (0);	1189	struct ev_loop *loop = ev_default_loop (0);
988		1190
989	ev_io stdin_watcher;	1191	ev_io stdin_watcher;
990		1192
991	ev_init (&stdin_watcher, my_cb);	1193	ev_init (&stdin_watcher, my_cb);
992	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);	1194	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);
993	ev_io_start (loop, &stdin_watcher);	1195	ev_io_start (loop, &stdin_watcher);
994		1196
995	ev_loop (loop, 0);	1197	ev_run (loop, 0);
996		1198
997	As you can see, you are responsible for allocating the memory for your	1199	As you can see, you are responsible for allocating the memory for your
998	watcher structures (and it is I<usually> a bad idea to do this on the	1200	watcher structures (and it is I<usually> a bad idea to do this on the
999	stack).	1201	stack).
1000		1202
1001	Each watcher has an associated watcher structure (called C<struct ev_TYPE>	1203	Each watcher has an associated watcher structure (called C<struct ev_TYPE>
1002	or simply C<ev_TYPE>, as typedefs are provided for all watcher structs).	1204	or simply C<ev_TYPE>, as typedefs are provided for all watcher structs).
1003		1205
1004	Each watcher structure must be initialised by a call to C<ev_init	1206	Each watcher structure must be initialised by a call to C<ev_init (watcher
1005	(watcher *, callback)>, which expects a callback to be provided. This	1207	*, callback)>, which expects a callback to be provided. This callback is
1006	callback gets invoked each time the event occurs (or, in the case of I/O	1208	invoked each time the event occurs (or, in the case of I/O watchers, each
1007	watchers, each time the event loop detects that the file descriptor given	1209	time the event loop detects that the file descriptor given is readable
1008	is readable and/or writable).	1210	and/or writable).
1009		1211
1010	Each watcher type further has its own C<< ev_TYPE_set (watcher *, ...) >>	1212	Each watcher type further has its own C<< ev_TYPE_set (watcher *, ...) >>
1011	macro to configure it, with arguments specific to the watcher type. There	1213	macro to configure it, with arguments specific to the watcher type. There
1012	is also a macro to combine initialisation and setting in one call: C<<	1214	is also a macro to combine initialisation and setting in one call: C<<
1013	ev_TYPE_init (watcher *, callback, ...) >>.	1215	ev_TYPE_init (watcher *, callback, ...) >>.
…		…
1016	with a watcher-specific start function (C<< ev_TYPE_start (loop, watcher	1218	with a watcher-specific start function (C<< ev_TYPE_start (loop, watcher
1017	*) >>), and you can stop watching for events at any time by calling the	1219	*) >>), and you can stop watching for events at any time by calling the
1018	corresponding stop function (C<< ev_TYPE_stop (loop, watcher *) >>.	1220	corresponding stop function (C<< ev_TYPE_stop (loop, watcher *) >>.
1019		1221
1020	As long as your watcher is active (has been started but not stopped) you	1222	As long as your watcher is active (has been started but not stopped) you
1021	must not touch the values stored in it. Most specifically you must never	1223	must not touch the values stored in it except when explicitly documented
1022	reinitialise it or call its C<ev_TYPE_set> macro.	1224	otherwise. Most specifically you must never reinitialise it or call its
		1225	C<ev_TYPE_set> macro.
1023		1226
1024	Each and every callback receives the event loop pointer as first, the	1227	Each and every callback receives the event loop pointer as first, the
1025	registered watcher structure as second, and a bitset of received events as	1228	registered watcher structure as second, and a bitset of received events as
1026	third argument.	1229	third argument.
1027		1230
…		…
1064		1267
1065	=item C<EV_PREPARE>	1268	=item C<EV_PREPARE>
1066		1269
1067	=item C<EV_CHECK>	1270	=item C<EV_CHECK>
1068		1271
1069	All C<ev_prepare> watchers are invoked just I<before> C<ev_loop> starts	1272	All C<ev_prepare> watchers are invoked just I<before> C<ev_run> starts to
1070	to gather new events, and all C<ev_check> watchers are invoked just after	1273	gather new events, and all C<ev_check> watchers are queued (not invoked)
1071	C<ev_loop> has gathered them, but before it invokes any callbacks for any	1274	just after C<ev_run> has gathered them, but before it queues any callbacks
		1275	for any received events. That means C<ev_prepare> watchers are the last
		1276	watchers invoked before the event loop sleeps or polls for new events, and
		1277	C<ev_check> watchers will be invoked before any other watchers of the same
		1278	or lower priority within an event loop iteration.
		1279
1072	received events. Callbacks of both watcher types can start and stop as	1280	Callbacks of both watcher types can start and stop as many watchers as
1073	many watchers as they want, and all of them will be taken into account	1281	they want, and all of them will be taken into account (for example, a
1074	(for example, a C<ev_prepare> watcher might start an idle watcher to keep	1282	C<ev_prepare> watcher might start an idle watcher to keep C<ev_run> from
1075	C<ev_loop> from blocking).	1283	blocking).
1076		1284
1077	=item C<EV_EMBED>	1285	=item C<EV_EMBED>
1078		1286
1079	The embedded event loop specified in the C<ev_embed> watcher needs attention.	1287	The embedded event loop specified in the C<ev_embed> watcher needs attention.
1080		1288
1081	=item C<EV_FORK>	1289	=item C<EV_FORK>
1082		1290
1083	The event loop has been resumed in the child process after fork (see	1291	The event loop has been resumed in the child process after fork (see
1084	C<ev_fork>).	1292	C<ev_fork>).
		1293
		1294	=item C<EV_CLEANUP>
		1295
		1296	The event loop is about to be destroyed (see C<ev_cleanup>).
1085		1297
1086	=item C<EV_ASYNC>	1298	=item C<EV_ASYNC>
1087		1299
1088	The given async watcher has been asynchronously notified (see C<ev_async>).	1300	The given async watcher has been asynchronously notified (see C<ev_async>).
1089		1301
…		…
1199		1411
1200	=item callback ev_cb (ev_TYPE *watcher)	1412	=item callback ev_cb (ev_TYPE *watcher)
1201		1413
1202	Returns the callback currently set on the watcher.	1414	Returns the callback currently set on the watcher.
1203		1415
1204	=item ev_cb_set (ev_TYPE *watcher, callback)	1416	=item ev_set_cb (ev_TYPE *watcher, callback)
1205		1417
1206	Change the callback. You can change the callback at virtually any time	1418	Change the callback. You can change the callback at virtually any time
1207	(modulo threads).	1419	(modulo threads).
1208		1420
1209	=item ev_set_priority (ev_TYPE *watcher, int priority)	1421	=item ev_set_priority (ev_TYPE *watcher, int priority)
…		…
1227	or might not have been clamped to the valid range.	1439	or might not have been clamped to the valid range.
1228		1440
1229	The default priority used by watchers when no priority has been set is	1441	The default priority used by watchers when no priority has been set is
1230	always C<0>, which is supposed to not be too high and not be too low :).	1442	always C<0>, which is supposed to not be too high and not be too low :).
1231		1443
1232	See L<WATCHER PRIORITY MODELS>, below, for a more thorough treatment of	1444	See L</WATCHER PRIORITY MODELS>, below, for a more thorough treatment of
1233	priorities.	1445	priorities.
1234		1446
1235	=item ev_invoke (loop, ev_TYPE *watcher, int revents)	1447	=item ev_invoke (loop, ev_TYPE *watcher, int revents)
1236		1448
1237	Invoke the C<watcher> with the given C<loop> and C<revents>. Neither	1449	Invoke the C<watcher> with the given C<loop> and C<revents>. Neither
…		…
1262	See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related	1474	See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related
1263	functions that do not need a watcher.	1475	functions that do not need a watcher.
1264		1476
1265	=back	1477	=back
1266		1478
		1479	See also the L</ASSOCIATING CUSTOM DATA WITH A WATCHER> and L</BUILDING YOUR
		1480	OWN COMPOSITE WATCHERS> idioms.
1267		1481
1268	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER	1482	=head2 WATCHER STATES
1269		1483
1270	Each watcher has, by default, a member C<void *data> that you can change	1484	There are various watcher states mentioned throughout this manual -
1271	and read at any time: libev will completely ignore it. This can be used	1485	active, pending and so on. In this section these states and the rules to
1272	to associate arbitrary data with your watcher. If you need more data and	1486	transition between them will be described in more detail - and while these
1273	don't want to allocate memory and store a pointer to it in that data	1487	rules might look complicated, they usually do "the right thing".
1274	member, you can also "subclass" the watcher type and provide your own
1275	data:
1276		1488
1277	struct my_io	1489	=over 4
1278	{
1279	ev_io io;
1280	int otherfd;
1281	void *somedata;
1282	struct whatever *mostinteresting;
1283	};
1284		1490
1285	...	1491	=item initialised
1286	struct my_io w;
1287	ev_io_init (&w.io, my_cb, fd, EV_READ);
1288		1492
1289	And since your callback will be called with a pointer to the watcher, you	1493	Before a watcher can be registered with the event loop it has to be
1290	can cast it back to your own type:	1494	initialised. This can be done with a call to C<ev_TYPE_init>, or calls to
		1495	C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function.
1291		1496
1292	static void my_cb (struct ev_loop *loop, ev_io *w_, int revents)	1497	In this state it is simply some block of memory that is suitable for
1293	{	1498	use in an event loop. It can be moved around, freed, reused etc. at
1294	struct my_io *w = (struct my_io *)w_;	1499	will - as long as you either keep the memory contents intact, or call
1295	...	1500	C<ev_TYPE_init> again.
1296	}
1297		1501
1298	More interesting and less C-conformant ways of casting your callback type	1502	=item started/running/active
1299	instead have been omitted.
1300		1503
1301	Another common scenario is to use some data structure with multiple	1504	Once a watcher has been started with a call to C<ev_TYPE_start> it becomes
1302	embedded watchers:	1505	property of the event loop, and is actively waiting for events. While in
		1506	this state it cannot be accessed (except in a few documented ways), moved,
		1507	freed or anything else - the only legal thing is to keep a pointer to it,
		1508	and call libev functions on it that are documented to work on active watchers.
1303		1509
1304	struct my_biggy	1510	=item pending
1305	{
1306	int some_data;
1307	ev_timer t1;
1308	ev_timer t2;
1309	}
1310		1511
1311	In this case getting the pointer to C<my_biggy> is a bit more	1512	If a watcher is active and libev determines that an event it is interested
1312	complicated: Either you store the address of your C<my_biggy> struct	1513	in has occurred (such as a timer expiring), it will become pending. It will
1313	in the C<data> member of the watcher (for woozies), or you need to use	1514	stay in this pending state until either it is stopped or its callback is
1314	some pointer arithmetic using C<offsetof> inside your watchers (for real	1515	about to be invoked, so it is not normally pending inside the watcher
1315	programmers):	1516	callback.
1316		1517
1317	#include <stddef.h>	1518	The watcher might or might not be active while it is pending (for example,
		1519	an expired non-repeating timer can be pending but no longer active). If it
		1520	is stopped, it can be freely accessed (e.g. by calling C<ev_TYPE_set>),
		1521	but it is still property of the event loop at this time, so cannot be
		1522	moved, freed or reused. And if it is active the rules described in the
		1523	previous item still apply.
1318		1524
1319	static void	1525	It is also possible to feed an event on a watcher that is not active (e.g.
1320	t1_cb (EV_P_ ev_timer *w, int revents)	1526	via C<ev_feed_event>), in which case it becomes pending without being
1321	{	1527	active.
1322	struct my_biggy big = (struct my_biggy *)
1323	(((char *)w) - offsetof (struct my_biggy, t1));
1324	}
1325		1528
1326	static void	1529	=item stopped
1327	t2_cb (EV_P_ ev_timer *w, int revents)	1530
1328	{	1531	A watcher can be stopped implicitly by libev (in which case it might still
1329	struct my_biggy big = (struct my_biggy *)	1532	be pending), or explicitly by calling its C<ev_TYPE_stop> function. The
1330	(((char *)w) - offsetof (struct my_biggy, t2));	1533	latter will clear any pending state the watcher might be in, regardless
1331	}	1534	of whether it was active or not, so stopping a watcher explicitly before
		1535	freeing it is often a good idea.
		1536
		1537	While stopped (and not pending) the watcher is essentially in the
		1538	initialised state, that is, it can be reused, moved, modified in any way
		1539	you wish (but when you trash the memory block, you need to C<ev_TYPE_init>
		1540	it again).
		1541
		1542	=back
1332		1543
1333	=head2 WATCHER PRIORITY MODELS	1544	=head2 WATCHER PRIORITY MODELS
1334		1545
1335	Many event loops support I<watcher priorities>, which are usually small	1546	Many event loops support I<watcher priorities>, which are usually small
1336	integers that influence the ordering of event callback invocation	1547	integers that influence the ordering of event callback invocation
1337	between watchers in some way, all else being equal.	1548	between watchers in some way, all else being equal.
1338		1549
1339	In libev, Watcher priorities can be set using C<ev_set_priority>. See its	1550	In libev, watcher priorities can be set using C<ev_set_priority>. See its
1340	description for the more technical details such as the actual priority	1551	description for the more technical details such as the actual priority
1341	range.	1552	range.
1342		1553
1343	There are two common ways how these these priorities are being interpreted	1554	There are two common ways how these these priorities are being interpreted
1344	by event loops:	1555	by event loops:
…		…
1379		1590
1380	For example, to emulate how many other event libraries handle priorities,	1591	For example, to emulate how many other event libraries handle priorities,
1381	you can associate an C<ev_idle> watcher to each such watcher, and in	1592	you can associate an C<ev_idle> watcher to each such watcher, and in
1382	the normal watcher callback, you just start the idle watcher. The real	1593	the normal watcher callback, you just start the idle watcher. The real
1383	processing is done in the idle watcher callback. This causes libev to	1594	processing is done in the idle watcher callback. This causes libev to
1384	continously poll and process kernel event data for the watcher, but when	1595	continuously poll and process kernel event data for the watcher, but when
1385	the lock-out case is known to be rare (which in turn is rare :), this is	1596	the lock-out case is known to be rare (which in turn is rare :), this is
1386	workable.	1597	workable.
1387		1598
1388	Usually, however, the lock-out model implemented that way will perform	1599	Usually, however, the lock-out model implemented that way will perform
1389	miserably under the type of load it was designed to handle. In that case,	1600	miserably under the type of load it was designed to handle. In that case,
…		…
1403	{	1614	{
1404	// stop the I/O watcher, we received the event, but	1615	// stop the I/O watcher, we received the event, but
1405	// are not yet ready to handle it.	1616	// are not yet ready to handle it.
1406	ev_io_stop (EV_A_ w);	1617	ev_io_stop (EV_A_ w);
1407		1618
1408	// start the idle watcher to ahndle the actual event.	1619	// start the idle watcher to handle the actual event.
1409	// it will not be executed as long as other watchers	1620	// it will not be executed as long as other watchers
1410	// with the default priority are receiving events.	1621	// with the default priority are receiving events.
1411	ev_idle_start (EV_A_ &idle);	1622	ev_idle_start (EV_A_ &idle);
1412	}	1623	}
1413		1624
…		…
1438		1649
1439	This section describes each watcher in detail, but will not repeat	1650	This section describes each watcher in detail, but will not repeat
1440	information given in the last section. Any initialisation/set macros,	1651	information given in the last section. Any initialisation/set macros,
1441	functions and members specific to the watcher type are explained.	1652	functions and members specific to the watcher type are explained.
1442		1653
1443	Members are additionally marked with either I<[read-only]>, meaning that,	1654	Most members are additionally marked with either I<[read-only]>, meaning
1444	while the watcher is active, you can look at the member and expect some	1655	that, while the watcher is active, you can look at the member and expect
1445	sensible content, but you must not modify it (you can modify it while the	1656	some sensible content, but you must not modify it (you can modify it while
1446	watcher is stopped to your hearts content), or I<[read-write]>, which	1657	the watcher is stopped to your hearts content), or I<[read-write]>, which
1447	means you can expect it to have some sensible content while the watcher	1658	means you can expect it to have some sensible content while the watcher is
1448	is active, but you can also modify it. Modifying it may not do something	1659	active, but you can also modify it (within the same thread as the event
		1660	loop, i.e. without creating data races). Modifying it may not do something
1449	sensible or take immediate effect (or do anything at all), but libev will	1661	sensible or take immediate effect (or do anything at all), but libev will
1450	not crash or malfunction in any way.	1662	not crash or malfunction in any way.
1451		1663
		1664	In any case, the documentation for each member will explain what the
		1665	effects are, and if there are any additional access restrictions.
1452		1666
1453	=head2 C<ev_io> - is this file descriptor readable or writable?	1667	=head2 C<ev_io> - is this file descriptor readable or writable?
1454		1668
1455	I/O watchers check whether a file descriptor is readable or writable	1669	I/O watchers check whether a file descriptor is readable or writable
1456	in each iteration of the event loop, or, more precisely, when reading	1670	in each iteration of the event loop, or, more precisely, when reading
…		…
1463	In general you can register as many read and/or write event watchers per	1677	In general you can register as many read and/or write event watchers per
1464	fd as you want (as long as you don't confuse yourself). Setting all file	1678	fd as you want (as long as you don't confuse yourself). Setting all file
1465	descriptors to non-blocking mode is also usually a good idea (but not	1679	descriptors to non-blocking mode is also usually a good idea (but not
1466	required if you know what you are doing).	1680	required if you know what you are doing).
1467		1681
1468	If you cannot use non-blocking mode, then force the use of a
1469	known-to-be-good backend (at the time of this writing, this includes only
1470	C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>). The same applies to file
1471	descriptors for which non-blocking operation makes no sense (such as
1472	files) - libev doesn't guarentee any specific behaviour in that case.
1473
1474	Another thing you have to watch out for is that it is quite easy to	1682	Another thing you have to watch out for is that it is quite easy to
1475	receive "spurious" readiness notifications, that is your callback might	1683	receive "spurious" readiness notifications, that is, your callback might
1476	be called with C<EV_READ> but a subsequent C<read>(2) will actually block	1684	be called with C<EV_READ> but a subsequent C<read>(2) will actually block
1477	because there is no data. Not only are some backends known to create a	1685	because there is no data. It is very easy to get into this situation even
1478	lot of those (for example Solaris ports), it is very easy to get into	1686	with a relatively standard program structure. Thus it is best to always
1479	this situation even with a relatively standard program structure. Thus	1687	use non-blocking I/O: An extra C<read>(2) returning C<EAGAIN> is far
1480	it is best to always use non-blocking I/O: An extra C<read>(2) returning
1481	C<EAGAIN> is far preferable to a program hanging until some data arrives.	1688	preferable to a program hanging until some data arrives.
1482		1689
1483	If you cannot run the fd in non-blocking mode (for example you should	1690	If you cannot run the fd in non-blocking mode (for example you should
1484	not play around with an Xlib connection), then you have to separately	1691	not play around with an Xlib connection), then you have to separately
1485	re-test whether a file descriptor is really ready with a known-to-be good	1692	re-test whether a file descriptor is really ready with a known-to-be good
1486	interface such as poll (fortunately in our Xlib example, Xlib already	1693	interface such as poll (fortunately in the case of Xlib, it already does
1487	does this on its own, so its quite safe to use). Some people additionally	1694	this on its own, so its quite safe to use). Some people additionally
1488	use C<SIGALRM> and an interval timer, just to be sure you won't block	1695	use C<SIGALRM> and an interval timer, just to be sure you won't block
1489	indefinitely.	1696	indefinitely.
1490		1697
1491	But really, best use non-blocking mode.	1698	But really, best use non-blocking mode.
1492		1699
1493	=head3 The special problem of disappearing file descriptors	1700	=head3 The special problem of disappearing file descriptors
1494		1701
1495	Some backends (e.g. kqueue, epoll) need to be told about closing a file	1702	Some backends (e.g. kqueue, epoll, linuxaio) need to be told about closing
1496	descriptor (either due to calling C<close> explicitly or any other means,	1703	a file descriptor (either due to calling C<close> explicitly or any other
1497	such as C<dup2>). The reason is that you register interest in some file	1704	means, such as C<dup2>). The reason is that you register interest in some
1498	descriptor, but when it goes away, the operating system will silently drop	1705	file descriptor, but when it goes away, the operating system will silently
1499	this interest. If another file descriptor with the same number then is	1706	drop this interest. If another file descriptor with the same number then
1500	registered with libev, there is no efficient way to see that this is, in	1707	is registered with libev, there is no efficient way to see that this is,
1501	fact, a different file descriptor.	1708	in fact, a different file descriptor.
1502		1709
1503	To avoid having to explicitly tell libev about such cases, libev follows	1710	To avoid having to explicitly tell libev about such cases, libev follows
1504	the following policy: Each time C<ev_io_set> is being called, libev	1711	the following policy: Each time C<ev_io_set> is being called, libev
1505	will assume that this is potentially a new file descriptor, otherwise	1712	will assume that this is potentially a new file descriptor, otherwise
1506	it is assumed that the file descriptor stays the same. That means that	1713	it is assumed that the file descriptor stays the same. That means that
…		…
1520		1727
1521	There is no workaround possible except not registering events	1728	There is no workaround possible except not registering events
1522	for potentially C<dup ()>'ed file descriptors, or to resort to	1729	for potentially C<dup ()>'ed file descriptors, or to resort to
1523	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.	1730	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1524		1731
		1732	=head3 The special problem of files
		1733
		1734	Many people try to use C<select> (or libev) on file descriptors
		1735	representing files, and expect it to become ready when their program
		1736	doesn't block on disk accesses (which can take a long time on their own).
		1737
		1738	However, this cannot ever work in the "expected" way - you get a readiness
		1739	notification as soon as the kernel knows whether and how much data is
		1740	there, and in the case of open files, that's always the case, so you
		1741	always get a readiness notification instantly, and your read (or possibly
		1742	write) will still block on the disk I/O.
		1743
		1744	Another way to view it is that in the case of sockets, pipes, character
		1745	devices and so on, there is another party (the sender) that delivers data
		1746	on its own, but in the case of files, there is no such thing: the disk
		1747	will not send data on its own, simply because it doesn't know what you
		1748	wish to read - you would first have to request some data.
		1749
		1750	Since files are typically not-so-well supported by advanced notification
		1751	mechanism, libev tries hard to emulate POSIX behaviour with respect
		1752	to files, even though you should not use it. The reason for this is
		1753	convenience: sometimes you want to watch STDIN or STDOUT, which is
		1754	usually a tty, often a pipe, but also sometimes files or special devices
		1755	(for example, C<epoll> on Linux works with F</dev/random> but not with
		1756	F</dev/urandom>), and even though the file might better be served with
		1757	asynchronous I/O instead of with non-blocking I/O, it is still useful when
		1758	it "just works" instead of freezing.
		1759
		1760	So avoid file descriptors pointing to files when you know it (e.g. use
		1761	libeio), but use them when it is convenient, e.g. for STDIN/STDOUT, or
		1762	when you rarely read from a file instead of from a socket, and want to
		1763	reuse the same code path.
		1764
1525	=head3 The special problem of fork	1765	=head3 The special problem of fork
1526		1766
1527	Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit	1767	Some backends (epoll, kqueue, linuxaio, iouring) do not support C<fork ()>
1528	useless behaviour. Libev fully supports fork, but needs to be told about	1768	at all or exhibit useless behaviour. Libev fully supports fork, but needs
1529	it in the child.	1769	to be told about it in the child if you want to continue to use it in the
		1770	child.
1530		1771
1531	To support fork in your programs, you either have to call	1772	To support fork in your child processes, you have to call C<ev_loop_fork
1532	C<ev_default_fork ()> or C<ev_loop_fork ()> after a fork in the child,	1773	()> after a fork in the child, enable C<EVFLAG_FORKCHECK>, or resort to
1533	enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or	1774	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1534	C<EVBACKEND_POLL>.
1535		1775
1536	=head3 The special problem of SIGPIPE	1776	=head3 The special problem of SIGPIPE
1537		1777
1538	While not really specific to libev, it is easy to forget about C<SIGPIPE>:	1778	While not really specific to libev, it is easy to forget about C<SIGPIPE>:
1539	when writing to a pipe whose other end has been closed, your program gets	1779	when writing to a pipe whose other end has been closed, your program gets
…		…
1590	=item ev_io_init (ev_io *, callback, int fd, int events)	1830	=item ev_io_init (ev_io *, callback, int fd, int events)
1591		1831
1592	=item ev_io_set (ev_io *, int fd, int events)	1832	=item ev_io_set (ev_io *, int fd, int events)
1593		1833
1594	Configures an C<ev_io> watcher. The C<fd> is the file descriptor to	1834	Configures an C<ev_io> watcher. The C<fd> is the file descriptor to
1595	receive events for and C<events> is either C<EV_READ>, C<EV_WRITE> or	1835	receive events for and C<events> is either C<EV_READ>, C<EV_WRITE>, both
1596	C<EV_READ | EV_WRITE>, to express the desire to receive the given events.	1836	C<EV_READ | EV_WRITE> or C<0>, to express the desire to receive the given
		1837	events.
1597		1838
1598	=item int fd [read-only]	1839	Note that setting the C<events> to C<0> and starting the watcher is
		1840	supported, but not specially optimized - if your program sometimes happens
		1841	to generate this combination this is fine, but if it is easy to avoid
		1842	starting an io watcher watching for no events you should do so.
1599		1843
1600	The file descriptor being watched.	1844	=item ev_io_modify (ev_io *, int events)
1601		1845
		1846	Similar to C<ev_io_set>, but only changes the event mask. Using this might
		1847	be faster with some backends, as libev can assume that the C<fd> still
		1848	refers to the same underlying file description, something it cannot do
		1849	when using C<ev_io_set>.
		1850
		1851	=item int fd [no-modify]
		1852
		1853	The file descriptor being watched. While it can be read at any time, you
		1854	must not modify this member even when the watcher is stopped - always use
		1855	C<ev_io_set> for that.
		1856
1602	=item int events [read-only]	1857	=item int events [no-modify]
1603		1858
1604	The events being watched.	1859	The set of events the fd is being watched for, among other flags. Remember
		1860	that this is a bit set - to test for C<EV_READ>, use C<< w->events &
		1861	EV_READ >>, and similarly for C<EV_WRITE>.
		1862
		1863	As with C<fd>, you must not modify this member even when the watcher is
		1864	stopped, always use C<ev_io_set> or C<ev_io_modify> for that.
1605		1865
1606	=back	1866	=back
1607		1867
1608	=head3 Examples	1868	=head3 Examples
1609		1869
…		…
1621	...	1881	...
1622	struct ev_loop *loop = ev_default_init (0);	1882	struct ev_loop *loop = ev_default_init (0);
1623	ev_io stdin_readable;	1883	ev_io stdin_readable;
1624	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);	1884	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);
1625	ev_io_start (loop, &stdin_readable);	1885	ev_io_start (loop, &stdin_readable);
1626	ev_loop (loop, 0);	1886	ev_run (loop, 0);
1627		1887
1628		1888
1629	=head2 C<ev_timer> - relative and optionally repeating timeouts	1889	=head2 C<ev_timer> - relative and optionally repeating timeouts
1630		1890
1631	Timer watchers are simple relative timers that generate an event after a	1891	Timer watchers are simple relative timers that generate an event after a
…		…
1637	detecting time jumps is hard, and some inaccuracies are unavoidable (the	1897	detecting time jumps is hard, and some inaccuracies are unavoidable (the
1638	monotonic clock option helps a lot here).	1898	monotonic clock option helps a lot here).
1639		1899
1640	The callback is guaranteed to be invoked only I<after> its timeout has	1900	The callback is guaranteed to be invoked only I<after> its timeout has
1641	passed (not I<at>, so on systems with very low-resolution clocks this	1901	passed (not I<at>, so on systems with very low-resolution clocks this
1642	might introduce a small delay). If multiple timers become ready during the	1902	might introduce a small delay, see "the special problem of being too
		1903	early", below). If multiple timers become ready during the same loop
1643	same loop iteration then the ones with earlier time-out values are invoked	1904	iteration then the ones with earlier time-out values are invoked before
1644	before ones of the same priority with later time-out values (but this is	1905	ones of the same priority with later time-out values (but this is no
1645	no longer true when a callback calls C<ev_loop> recursively).	1906	longer true when a callback calls C<ev_run> recursively).
1646		1907
1647	=head3 Be smart about timeouts	1908	=head3 Be smart about timeouts
1648		1909
1649	Many real-world problems involve some kind of timeout, usually for error	1910	Many real-world problems involve some kind of timeout, usually for error
1650	recovery. A typical example is an HTTP request - if the other side hangs,	1911	recovery. A typical example is an HTTP request - if the other side hangs,
…		…
1725		1986
1726	In this case, it would be more efficient to leave the C<ev_timer> alone,	1987	In this case, it would be more efficient to leave the C<ev_timer> alone,
1727	but remember the time of last activity, and check for a real timeout only	1988	but remember the time of last activity, and check for a real timeout only
1728	within the callback:	1989	within the callback:
1729		1990
		1991	ev_tstamp timeout = 60.;
1730	ev_tstamp last_activity; // time of last activity	1992	ev_tstamp last_activity; // time of last activity
		1993	ev_timer timer;
1731		1994
1732	static void	1995	static void
1733	callback (EV_P_ ev_timer *w, int revents)	1996	callback (EV_P_ ev_timer *w, int revents)
1734	{	1997	{
1735	ev_tstamp now = ev_now (EV_A);	1998	// calculate when the timeout would happen
1736	ev_tstamp timeout = last_activity + 60.;	1999	ev_tstamp after = last_activity - ev_now (EV_A) + timeout;
1737		2000
1738	// if last_activity + 60. is older than now, we did time out	2001	// if negative, it means we the timeout already occurred
1739	if (timeout < now)	2002	if (after < 0.)
1740	{	2003	{
1741	// timeout occured, take action	2004	// timeout occurred, take action
1742	}	2005	}
1743	else	2006	else
1744	{	2007	{
1745	// callback was invoked, but there was some activity, re-arm	2008	// callback was invoked, but there was some recent
1746	// the watcher to fire in last_activity + 60, which is	2009	// activity. simply restart the timer to time out
1747	// guaranteed to be in the future, so "again" is positive:	2010	// after "after" seconds, which is the earliest time
1748	w->repeat = timeout - now;	2011	// the timeout can occur.
		2012	ev_timer_set (w, after, 0.);
1749	ev_timer_again (EV_A_ w);	2013	ev_timer_start (EV_A_ w);
1750	}	2014	}
1751	}	2015	}
1752		2016
1753	To summarise the callback: first calculate the real timeout (defined	2017	To summarise the callback: first calculate in how many seconds the
1754	as "60 seconds after the last activity"), then check if that time has	2018	timeout will occur (by calculating the absolute time when it would occur,
1755	been reached, which means something I<did>, in fact, time out. Otherwise	2019	C<last_activity + timeout>, and subtracting the current time, C<ev_now
1756	the callback was invoked too early (C<timeout> is in the future), so	2020	(EV_A)> from that).
1757	re-schedule the timer to fire at that future time, to see if maybe we have
1758	a timeout then.
1759		2021
1760	Note how C<ev_timer_again> is used, taking advantage of the	2022	If this value is negative, then we are already past the timeout, i.e. we
1761	C<ev_timer_again> optimisation when the timer is already running.	2023	timed out, and need to do whatever is needed in this case.
		2024
		2025	Otherwise, we now the earliest time at which the timeout would trigger,
		2026	and simply start the timer with this timeout value.
		2027
		2028	In other words, each time the callback is invoked it will check whether
		2029	the timeout occurred. If not, it will simply reschedule itself to check
		2030	again at the earliest time it could time out. Rinse. Repeat.
1762		2031
1763	This scheme causes more callback invocations (about one every 60 seconds	2032	This scheme causes more callback invocations (about one every 60 seconds
1764	minus half the average time between activity), but virtually no calls to	2033	minus half the average time between activity), but virtually no calls to
1765	libev to change the timeout.	2034	libev to change the timeout.
1766		2035
1767	To start the timer, simply initialise the watcher and set C<last_activity>	2036	To start the machinery, simply initialise the watcher and set
1768	to the current time (meaning we just have some activity :), then call the	2037	C<last_activity> to the current time (meaning there was some activity just
1769	callback, which will "do the right thing" and start the timer:	2038	now), then call the callback, which will "do the right thing" and start
		2039	the timer:
1770		2040
		2041	last_activity = ev_now (EV_A);
1771	ev_init (timer, callback);	2042	ev_init (&timer, callback);
1772	last_activity = ev_now (loop);	2043	callback (EV_A_ &timer, 0);
1773	callback (loop, timer, EV_TIMER);
1774		2044
1775	And when there is some activity, simply store the current time in	2045	When there is some activity, simply store the current time in
1776	C<last_activity>, no libev calls at all:	2046	C<last_activity>, no libev calls at all:
1777		2047
		2048	if (activity detected)
1778	last_actiivty = ev_now (loop);	2049	last_activity = ev_now (EV_A);
		2050
		2051	When your timeout value changes, then the timeout can be changed by simply
		2052	providing a new value, stopping the timer and calling the callback, which
		2053	will again do the right thing (for example, time out immediately :).
		2054
		2055	timeout = new_value;
		2056	ev_timer_stop (EV_A_ &timer);
		2057	callback (EV_A_ &timer, 0);
1779		2058
1780	This technique is slightly more complex, but in most cases where the	2059	This technique is slightly more complex, but in most cases where the
1781	time-out is unlikely to be triggered, much more efficient.	2060	time-out is unlikely to be triggered, much more efficient.
1782
1783	Changing the timeout is trivial as well (if it isn't hard-coded in the
1784	callback :) - just change the timeout and invoke the callback, which will
1785	fix things for you.
1786		2061
1787	=item 4. Wee, just use a double-linked list for your timeouts.	2062	=item 4. Wee, just use a double-linked list for your timeouts.
1788		2063
1789	If there is not one request, but many thousands (millions...), all	2064	If there is not one request, but many thousands (millions...), all
1790	employing some kind of timeout with the same timeout value, then one can	2065	employing some kind of timeout with the same timeout value, then one can
…		…
1817	Method #1 is almost always a bad idea, and buys you nothing. Method #4 is	2092	Method #1 is almost always a bad idea, and buys you nothing. Method #4 is
1818	rather complicated, but extremely efficient, something that really pays	2093	rather complicated, but extremely efficient, something that really pays
1819	off after the first million or so of active timers, i.e. it's usually	2094	off after the first million or so of active timers, i.e. it's usually
1820	overkill :)	2095	overkill :)
1821		2096
		2097	=head3 The special problem of being too early
		2098
		2099	If you ask a timer to call your callback after three seconds, then
		2100	you expect it to be invoked after three seconds - but of course, this
		2101	cannot be guaranteed to infinite precision. Less obviously, it cannot be
		2102	guaranteed to any precision by libev - imagine somebody suspending the
		2103	process with a STOP signal for a few hours for example.
		2104
		2105	So, libev tries to invoke your callback as soon as possible I<after> the
		2106	delay has occurred, but cannot guarantee this.
		2107
		2108	A less obvious failure mode is calling your callback too early: many event
		2109	loops compare timestamps with a "elapsed delay >= requested delay", but
		2110	this can cause your callback to be invoked much earlier than you would
		2111	expect.
		2112
		2113	To see why, imagine a system with a clock that only offers full second
		2114	resolution (think windows if you can't come up with a broken enough OS
		2115	yourself). If you schedule a one-second timer at the time 500.9, then the
		2116	event loop will schedule your timeout to elapse at a system time of 500
		2117	(500.9 truncated to the resolution) + 1, or 501.
		2118
		2119	If an event library looks at the timeout 0.1s later, it will see "501 >=
		2120	501" and invoke the callback 0.1s after it was started, even though a
		2121	one-second delay was requested - this is being "too early", despite best
		2122	intentions.
		2123
		2124	This is the reason why libev will never invoke the callback if the elapsed
		2125	delay equals the requested delay, but only when the elapsed delay is
		2126	larger than the requested delay. In the example above, libev would only invoke
		2127	the callback at system time 502, or 1.1s after the timer was started.
		2128
		2129	So, while libev cannot guarantee that your callback will be invoked
		2130	exactly when requested, it I<can> and I<does> guarantee that the requested
		2131	delay has actually elapsed, or in other words, it always errs on the "too
		2132	late" side of things.
		2133
1822	=head3 The special problem of time updates	2134	=head3 The special problem of time updates
1823		2135
1824	Establishing the current time is a costly operation (it usually takes at	2136	Establishing the current time is a costly operation (it usually takes
1825	least two system calls): EV therefore updates its idea of the current	2137	at least one system call): EV therefore updates its idea of the current
1826	time only before and after C<ev_loop> collects new events, which causes a	2138	time only before and after C<ev_run> collects new events, which causes a
1827	growing difference between C<ev_now ()> and C<ev_time ()> when handling	2139	growing difference between C<ev_now ()> and C<ev_time ()> when handling
1828	lots of events in one iteration.	2140	lots of events in one iteration.
1829		2141
1830	The relative timeouts are calculated relative to the C<ev_now ()>	2142	The relative timeouts are calculated relative to the C<ev_now ()>
1831	time. This is usually the right thing as this timestamp refers to the time	2143	time. This is usually the right thing as this timestamp refers to the time
1832	of the event triggering whatever timeout you are modifying/starting. If	2144	of the event triggering whatever timeout you are modifying/starting. If
1833	you suspect event processing to be delayed and you I<need> to base the	2145	you suspect event processing to be delayed and you I<need> to base the
1834	timeout on the current time, use something like this to adjust for this:	2146	timeout on the current time, use something like the following to adjust
		2147	for it:
1835		2148
1836	ev_timer_set (&timer, after + ev_now () - ev_time (), 0.);	2149	ev_timer_set (&timer, after + (ev_time () - ev_now ()), 0.);
1837		2150
1838	If the event loop is suspended for a long time, you can also force an	2151	If the event loop is suspended for a long time, you can also force an
1839	update of the time returned by C<ev_now ()> by calling C<ev_now_update	2152	update of the time returned by C<ev_now ()> by calling C<ev_now_update
1840	()>.	2153	()>, although that will push the event time of all outstanding events
		2154	further into the future.
		2155
		2156	=head3 The special problem of unsynchronised clocks
		2157
		2158	Modern systems have a variety of clocks - libev itself uses the normal
		2159	"wall clock" clock and, if available, the monotonic clock (to avoid time
		2160	jumps).
		2161
		2162	Neither of these clocks is synchronised with each other or any other clock
		2163	on the system, so C<ev_time ()> might return a considerably different time
		2164	than C<gettimeofday ()> or C<time ()>. On a GNU/Linux system, for example,
		2165	a call to C<gettimeofday> might return a second count that is one higher
		2166	than a directly following call to C<time>.
		2167
		2168	The moral of this is to only compare libev-related timestamps with
		2169	C<ev_time ()> and C<ev_now ()>, at least if you want better precision than
		2170	a second or so.
		2171
		2172	One more problem arises due to this lack of synchronisation: if libev uses
		2173	the system monotonic clock and you compare timestamps from C<ev_time>
		2174	or C<ev_now> from when you started your timer and when your callback is
		2175	invoked, you will find that sometimes the callback is a bit "early".
		2176
		2177	This is because C<ev_timer>s work in real time, not wall clock time, so
		2178	libev makes sure your callback is not invoked before the delay happened,
		2179	I<measured according to the real time>, not the system clock.
		2180
		2181	If your timeouts are based on a physical timescale (e.g. "time out this
		2182	connection after 100 seconds") then this shouldn't bother you as it is
		2183	exactly the right behaviour.
		2184
		2185	If you want to compare wall clock/system timestamps to your timers, then
		2186	you need to use C<ev_periodic>s, as these are based on the wall clock
		2187	time, where your comparisons will always generate correct results.
1841		2188
1842	=head3 The special problems of suspended animation	2189	=head3 The special problems of suspended animation
1843		2190
1844	When you leave the server world it is quite customary to hit machines that	2191	When you leave the server world it is quite customary to hit machines that
1845	can suspend/hibernate - what happens to the clocks during such a suspend?	2192	can suspend/hibernate - what happens to the clocks during such a suspend?
…		…
1875		2222
1876	=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)	2223	=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
1877		2224
1878	=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)	2225	=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)
1879		2226
1880	Configure the timer to trigger after C<after> seconds. If C<repeat>	2227	Configure the timer to trigger after C<after> seconds (fractional and
1881	is C<0.>, then it will automatically be stopped once the timeout is	2228	negative values are supported). If C<repeat> is C<0.>, then it will
1882	reached. If it is positive, then the timer will automatically be	2229	automatically be stopped once the timeout is reached. If it is positive,
1883	configured to trigger again C<repeat> seconds later, again, and again,	2230	then the timer will automatically be configured to trigger again C<repeat>
1884	until stopped manually.	2231	seconds later, again, and again, until stopped manually.
1885		2232
1886	The timer itself will do a best-effort at avoiding drift, that is, if	2233	The timer itself will do a best-effort at avoiding drift, that is, if
1887	you configure a timer to trigger every 10 seconds, then it will normally	2234	you configure a timer to trigger every 10 seconds, then it will normally
1888	trigger at exactly 10 second intervals. If, however, your program cannot	2235	trigger at exactly 10 second intervals. If, however, your program cannot
1889	keep up with the timer (because it takes longer than those 10 seconds to	2236	keep up with the timer (because it takes longer than those 10 seconds to
1890	do stuff) the timer will not fire more than once per event loop iteration.	2237	do stuff) the timer will not fire more than once per event loop iteration.
1891		2238
1892	=item ev_timer_again (loop, ev_timer *)	2239	=item ev_timer_again (loop, ev_timer *)
1893		2240
1894	This will act as if the timer timed out and restart it again if it is	2241	This will act as if the timer timed out, and restarts it again if it is
1895	repeating. The exact semantics are:	2242	repeating. It basically works like calling C<ev_timer_stop>, updating the
		2243	timeout to the C<repeat> value and calling C<ev_timer_start>.
1896		2244
		2245	The exact semantics are as in the following rules, all of which will be
		2246	applied to the watcher:
		2247
		2248	=over 4
		2249
1897	If the timer is pending, its pending status is cleared.	2250	=item If the timer is pending, the pending status is always cleared.
1898		2251
1899	If the timer is started but non-repeating, stop it (as if it timed out).	2252	=item If the timer is started but non-repeating, stop it (as if it timed
		2253	out, without invoking it).
1900		2254
1901	If the timer is repeating, either start it if necessary (with the	2255	=item If the timer is repeating, make the C<repeat> value the new timeout
1902	C<repeat> value), or reset the running timer to the C<repeat> value.	2256	and start the timer, if necessary.
1903		2257
		2258	=back
		2259
1904	This sounds a bit complicated, see L<Be smart about timeouts>, above, for a	2260	This sounds a bit complicated, see L</Be smart about timeouts>, above, for a
1905	usage example.	2261	usage example.
1906		2262
1907	=item ev_tstamp ev_timer_remaining (loop, ev_timer *)	2263	=item ev_tstamp ev_timer_remaining (loop, ev_timer *)
1908		2264
1909	Returns the remaining time until a timer fires. If the timer is active,	2265	Returns the remaining time until a timer fires. If the timer is active,
…		…
1948	}	2304	}
1949		2305
1950	ev_timer mytimer;	2306	ev_timer mytimer;
1951	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */	2307	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */
1952	ev_timer_again (&mytimer); /* start timer */	2308	ev_timer_again (&mytimer); /* start timer */
1953	ev_loop (loop, 0);	2309	ev_run (loop, 0);
1954		2310
1955	// and in some piece of code that gets executed on any "activity":	2311	// and in some piece of code that gets executed on any "activity":
1956	// reset the timeout to start ticking again at 10 seconds	2312	// reset the timeout to start ticking again at 10 seconds
1957	ev_timer_again (&mytimer);	2313	ev_timer_again (&mytimer);
1958		2314
…		…
1962	Periodic watchers are also timers of a kind, but they are very versatile	2318	Periodic watchers are also timers of a kind, but they are very versatile
1963	(and unfortunately a bit complex).	2319	(and unfortunately a bit complex).
1964		2320
1965	Unlike C<ev_timer>, periodic watchers are not based on real time (or	2321	Unlike C<ev_timer>, periodic watchers are not based on real time (or
1966	relative time, the physical time that passes) but on wall clock time	2322	relative time, the physical time that passes) but on wall clock time
1967	(absolute time, the thing you can read on your calender or clock). The	2323	(absolute time, the thing you can read on your calendar or clock). The
1968	difference is that wall clock time can run faster or slower than real	2324	difference is that wall clock time can run faster or slower than real
1969	time, and time jumps are not uncommon (e.g. when you adjust your	2325	time, and time jumps are not uncommon (e.g. when you adjust your
1970	wrist-watch).	2326	wrist-watch).
1971		2327
1972	You can tell a periodic watcher to trigger after some specific point	2328	You can tell a periodic watcher to trigger after some specific point
…		…
1977	C<ev_timer>, which would still trigger roughly 10 seconds after starting	2333	C<ev_timer>, which would still trigger roughly 10 seconds after starting
1978	it, as it uses a relative timeout).	2334	it, as it uses a relative timeout).
1979		2335
1980	C<ev_periodic> watchers can also be used to implement vastly more complex	2336	C<ev_periodic> watchers can also be used to implement vastly more complex
1981	timers, such as triggering an event on each "midnight, local time", or	2337	timers, such as triggering an event on each "midnight, local time", or
1982	other complicated rules. This cannot be done with C<ev_timer> watchers, as	2338	other complicated rules. This cannot easily be done with C<ev_timer>
1983	those cannot react to time jumps.	2339	watchers, as those cannot react to time jumps.
1984		2340
1985	As with timers, the callback is guaranteed to be invoked only when the	2341	As with timers, the callback is guaranteed to be invoked only when the
1986	point in time where it is supposed to trigger has passed. If multiple	2342	point in time where it is supposed to trigger has passed. If multiple
1987	timers become ready during the same loop iteration then the ones with	2343	timers become ready during the same loop iteration then the ones with
1988	earlier time-out values are invoked before ones with later time-out values	2344	earlier time-out values are invoked before ones with later time-out values
1989	(but this is no longer true when a callback calls C<ev_loop> recursively).	2345	(but this is no longer true when a callback calls C<ev_run> recursively).
1990		2346
1991	=head3 Watcher-Specific Functions and Data Members	2347	=head3 Watcher-Specific Functions and Data Members
1992		2348
1993	=over 4	2349	=over 4
1994		2350
…		…
2029		2385
2030	Another way to think about it (for the mathematically inclined) is that	2386	Another way to think about it (for the mathematically inclined) is that
2031	C<ev_periodic> will try to run the callback in this mode at the next possible	2387	C<ev_periodic> will try to run the callback in this mode at the next possible
2032	time where C<time = offset (mod interval)>, regardless of any time jumps.	2388	time where C<time = offset (mod interval)>, regardless of any time jumps.
2033		2389
2034	For numerical stability it is preferable that the C<offset> value is near	2390	The C<interval> I<MUST> be positive, and for numerical stability, the
2035	C<ev_now ()> (the current time), but there is no range requirement for	2391	interval value should be higher than C<1/8192> (which is around 100
2036	this value, and in fact is often specified as zero.	2392	microseconds) and C<offset> should be higher than C<0> and should have
		2393	at most a similar magnitude as the current time (say, within a factor of
		2394	ten). Typical values for offset are, in fact, C<0> or something between
		2395	C<0> and C<interval>, which is also the recommended range.
2037		2396
2038	Note also that there is an upper limit to how often a timer can fire (CPU	2397	Note also that there is an upper limit to how often a timer can fire (CPU
2039	speed for example), so if C<interval> is very small then timing stability	2398	speed for example), so if C<interval> is very small then timing stability
2040	will of course deteriorate. Libev itself tries to be exact to be about one	2399	will of course deteriorate. Libev itself tries to be exact to be about one
2041	millisecond (if the OS supports it and the machine is fast enough).	2400	millisecond (if the OS supports it and the machine is fast enough).
…		…
2071		2430
2072	NOTE: I<< This callback must always return a time that is higher than or	2431	NOTE: I<< This callback must always return a time that is higher than or
2073	equal to the passed C<now> value >>.	2432	equal to the passed C<now> value >>.
2074		2433
2075	This can be used to create very complex timers, such as a timer that	2434	This can be used to create very complex timers, such as a timer that
2076	triggers on "next midnight, local time". To do this, you would calculate the	2435	triggers on "next midnight, local time". To do this, you would calculate
2077	next midnight after C<now> and return the timestamp value for this. How	2436	the next midnight after C<now> and return the timestamp value for
2078	you do this is, again, up to you (but it is not trivial, which is the main	2437	this. Here is a (completely untested, no error checking) example on how to
2079	reason I omitted it as an example).	2438	do this:
		2439
		2440	#include <time.h>
		2441
		2442	static ev_tstamp
		2443	my_rescheduler (ev_periodic *w, ev_tstamp now)
		2444	{
		2445	time_t tnow = (time_t)now;
		2446	struct tm tm;
		2447	localtime_r (&tnow, &tm);
		2448
		2449	tm.tm_sec = tm.tm_min = tm.tm_hour = 0; // midnight current day
		2450	++tm.tm_mday; // midnight next day
		2451
		2452	return mktime (&tm);
		2453	}
		2454
		2455	Note: this code might run into trouble on days that have more then two
		2456	midnights (beginning and end).
2080		2457
2081	=back	2458	=back
2082		2459
2083	=item ev_periodic_again (loop, ev_periodic *)	2460	=item ev_periodic_again (loop, ev_periodic *)
2084		2461
…		…
2122	Example: Call a callback every hour, or, more precisely, whenever the	2499	Example: Call a callback every hour, or, more precisely, whenever the
2123	system time is divisible by 3600. The callback invocation times have	2500	system time is divisible by 3600. The callback invocation times have
2124	potentially a lot of jitter, but good long-term stability.	2501	potentially a lot of jitter, but good long-term stability.
2125		2502
2126	static void	2503	static void
2127	clock_cb (struct ev_loop *loop, ev_io *w, int revents)	2504	clock_cb (struct ev_loop *loop, ev_periodic *w, int revents)
2128	{	2505	{
2129	... its now a full hour (UTC, or TAI or whatever your clock follows)	2506	... its now a full hour (UTC, or TAI or whatever your clock follows)
2130	}	2507	}
2131		2508
2132	ev_periodic hourly_tick;	2509	ev_periodic hourly_tick;
…		…
2149		2526
2150	ev_periodic hourly_tick;	2527	ev_periodic hourly_tick;
2151	ev_periodic_init (&hourly_tick, clock_cb,	2528	ev_periodic_init (&hourly_tick, clock_cb,
2152	fmod (ev_now (loop), 3600.), 3600., 0);	2529	fmod (ev_now (loop), 3600.), 3600., 0);
2153	ev_periodic_start (loop, &hourly_tick);	2530	ev_periodic_start (loop, &hourly_tick);
2154		2531
2155		2532
2156	=head2 C<ev_signal> - signal me when a signal gets signalled!	2533	=head2 C<ev_signal> - signal me when a signal gets signalled!
2157		2534
2158	Signal watchers will trigger an event when the process receives a specific	2535	Signal watchers will trigger an event when the process receives a specific
2159	signal one or more times. Even though signals are very asynchronous, libev	2536	signal one or more times. Even though signals are very asynchronous, libev
2160	will try it's best to deliver signals synchronously, i.e. as part of the	2537	will try its best to deliver signals synchronously, i.e. as part of the
2161	normal event processing, like any other event.	2538	normal event processing, like any other event.
2162		2539
2163	If you want signals to be delivered truly asynchronously, just use	2540	If you want signals to be delivered truly asynchronously, just use
2164	C<sigaction> as you would do without libev and forget about sharing	2541	C<sigaction> as you would do without libev and forget about sharing
2165	the signal. You can even use C<ev_async> from a signal handler to	2542	the signal. You can even use C<ev_async> from a signal handler to
…		…
2169	only within the same loop, i.e. you can watch for C<SIGINT> in your	2546	only within the same loop, i.e. you can watch for C<SIGINT> in your
2170	default loop and for C<SIGIO> in another loop, but you cannot watch for	2547	default loop and for C<SIGIO> in another loop, but you cannot watch for
2171	C<SIGINT> in both the default loop and another loop at the same time. At	2548	C<SIGINT> in both the default loop and another loop at the same time. At
2172	the moment, C<SIGCHLD> is permanently tied to the default loop.	2549	the moment, C<SIGCHLD> is permanently tied to the default loop.
2173		2550
2174	When the first watcher gets started will libev actually register something	2551	Only after the first watcher for a signal is started will libev actually
2175	with the kernel (thus it coexists with your own signal handlers as long as	2552	register something with the kernel. It thus coexists with your own signal
2176	you don't register any with libev for the same signal).	2553	handlers as long as you don't register any with libev for the same signal.
2177		2554
2178	If possible and supported, libev will install its handlers with	2555	If possible and supported, libev will install its handlers with
2179	C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should	2556	C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should
2180	not be unduly interrupted. If you have a problem with system calls getting	2557	not be unduly interrupted. If you have a problem with system calls getting
2181	interrupted by signals you can block all signals in an C<ev_check> watcher	2558	interrupted by signals you can block all signals in an C<ev_check> watcher
…		…
2184	=head3 The special problem of inheritance over fork/execve/pthread_create	2561	=head3 The special problem of inheritance over fork/execve/pthread_create
2185		2562
2186	Both the signal mask (C<sigprocmask>) and the signal disposition	2563	Both the signal mask (C<sigprocmask>) and the signal disposition
2187	(C<sigaction>) are unspecified after starting a signal watcher (and after	2564	(C<sigaction>) are unspecified after starting a signal watcher (and after
2188	stopping it again), that is, libev might or might not block the signal,	2565	stopping it again), that is, libev might or might not block the signal,
2189	and might or might not set or restore the installed signal handler.	2566	and might or might not set or restore the installed signal handler (but
		2567	see C<EVFLAG_NOSIGMASK>).
2190		2568
2191	While this does not matter for the signal disposition (libev never	2569	While this does not matter for the signal disposition (libev never
2192	sets signals to C<SIG_IGN>, so handlers will be reset to C<SIG_DFL> on	2570	sets signals to C<SIG_IGN>, so handlers will be reset to C<SIG_DFL> on
2193	C<execve>), this matters for the signal mask: many programs do not expect	2571	C<execve>), this matters for the signal mask: many programs do not expect
2194	certain signals to be blocked.	2572	certain signals to be blocked.
…		…
2208		2586
2209	So I can't stress this enough: I<If you do not reset your signal mask when	2587	So I can't stress this enough: I<If you do not reset your signal mask when
2210	you expect it to be empty, you have a race condition in your code>. This	2588	you expect it to be empty, you have a race condition in your code>. This
2211	is not a libev-specific thing, this is true for most event libraries.	2589	is not a libev-specific thing, this is true for most event libraries.
2212		2590
		2591	=head3 The special problem of threads signal handling
		2592
		2593	POSIX threads has problematic signal handling semantics, specifically,
		2594	a lot of functionality (sigfd, sigwait etc.) only really works if all
		2595	threads in a process block signals, which is hard to achieve.
		2596
		2597	When you want to use sigwait (or mix libev signal handling with your own
		2598	for the same signals), you can tackle this problem by globally blocking
		2599	all signals before creating any threads (or creating them with a fully set
		2600	sigprocmask) and also specifying the C<EVFLAG_NOSIGMASK> when creating
		2601	loops. Then designate one thread as "signal receiver thread" which handles
		2602	these signals. You can pass on any signals that libev might be interested
		2603	in by calling C<ev_feed_signal>.
		2604
2213	=head3 Watcher-Specific Functions and Data Members	2605	=head3 Watcher-Specific Functions and Data Members
2214		2606
2215	=over 4	2607	=over 4
2216		2608
2217	=item ev_signal_init (ev_signal *, callback, int signum)	2609	=item ev_signal_init (ev_signal *, callback, int signum)
…		…
2232	Example: Try to exit cleanly on SIGINT.	2624	Example: Try to exit cleanly on SIGINT.
2233		2625
2234	static void	2626	static void
2235	sigint_cb (struct ev_loop *loop, ev_signal *w, int revents)	2627	sigint_cb (struct ev_loop *loop, ev_signal *w, int revents)
2236	{	2628	{
2237	ev_unloop (loop, EVUNLOOP_ALL);	2629	ev_break (loop, EVBREAK_ALL);
2238	}	2630	}
2239		2631
2240	ev_signal signal_watcher;	2632	ev_signal signal_watcher;
2241	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);	2633	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
2242	ev_signal_start (loop, &signal_watcher);	2634	ev_signal_start (loop, &signal_watcher);
…		…
2351		2743
2352	=head2 C<ev_stat> - did the file attributes just change?	2744	=head2 C<ev_stat> - did the file attributes just change?
2353		2745
2354	This watches a file system path for attribute changes. That is, it calls	2746	This watches a file system path for attribute changes. That is, it calls
2355	C<stat> on that path in regular intervals (or when the OS says it changed)	2747	C<stat> on that path in regular intervals (or when the OS says it changed)
2356	and sees if it changed compared to the last time, invoking the callback if	2748	and sees if it changed compared to the last time, invoking the callback
2357	it did.	2749	if it did. Starting the watcher C<stat>'s the file, so only changes that
		2750	happen after the watcher has been started will be reported.
2358		2751
2359	The path does not need to exist: changing from "path exists" to "path does	2752	The path does not need to exist: changing from "path exists" to "path does
2360	not exist" is a status change like any other. The condition "path does not	2753	not exist" is a status change like any other. The condition "path does not
2361	exist" (or more correctly "path cannot be stat'ed") is signified by the	2754	exist" (or more correctly "path cannot be stat'ed") is signified by the
2362	C<st_nlink> field being zero (which is otherwise always forced to be at	2755	C<st_nlink> field being zero (which is otherwise always forced to be at
…		…
2592	Apart from keeping your process non-blocking (which is a useful	2985	Apart from keeping your process non-blocking (which is a useful
2593	effect on its own sometimes), idle watchers are a good place to do	2986	effect on its own sometimes), idle watchers are a good place to do
2594	"pseudo-background processing", or delay processing stuff to after the	2987	"pseudo-background processing", or delay processing stuff to after the
2595	event loop has handled all outstanding events.	2988	event loop has handled all outstanding events.
2596		2989
		2990	=head3 Abusing an C<ev_idle> watcher for its side-effect
		2991
		2992	As long as there is at least one active idle watcher, libev will never
		2993	sleep unnecessarily. Or in other words, it will loop as fast as possible.
		2994	For this to work, the idle watcher doesn't need to be invoked at all - the
		2995	lowest priority will do.
		2996
		2997	This mode of operation can be useful together with an C<ev_check> watcher,
		2998	to do something on each event loop iteration - for example to balance load
		2999	between different connections.
		3000
		3001	See L</Abusing an ev_check watcher for its side-effect> for a longer
		3002	example.
		3003
2597	=head3 Watcher-Specific Functions and Data Members	3004	=head3 Watcher-Specific Functions and Data Members
2598		3005
2599	=over 4	3006	=over 4
2600		3007
2601	=item ev_idle_init (ev_idle *, callback)	3008	=item ev_idle_init (ev_idle *, callback)
…		…
2612	callback, free it. Also, use no error checking, as usual.	3019	callback, free it. Also, use no error checking, as usual.
2613		3020
2614	static void	3021	static void
2615	idle_cb (struct ev_loop *loop, ev_idle *w, int revents)	3022	idle_cb (struct ev_loop *loop, ev_idle *w, int revents)
2616	{	3023	{
		3024	// stop the watcher
		3025	ev_idle_stop (loop, w);
		3026
		3027	// now we can free it
2617	free (w);	3028	free (w);
		3029
2618	// now do something you wanted to do when the program has	3030	// now do something you wanted to do when the program has
2619	// no longer anything immediate to do.	3031	// no longer anything immediate to do.
2620	}	3032	}
2621		3033
2622	ev_idle *idle_watcher = malloc (sizeof (ev_idle));	3034	ev_idle *idle_watcher = malloc (sizeof (ev_idle));
…		…
2624	ev_idle_start (loop, idle_watcher);	3036	ev_idle_start (loop, idle_watcher);
2625		3037
2626		3038
2627	=head2 C<ev_prepare> and C<ev_check> - customise your event loop!	3039	=head2 C<ev_prepare> and C<ev_check> - customise your event loop!
2628		3040
2629	Prepare and check watchers are usually (but not always) used in pairs:	3041	Prepare and check watchers are often (but not always) used in pairs:
2630	prepare watchers get invoked before the process blocks and check watchers	3042	prepare watchers get invoked before the process blocks and check watchers
2631	afterwards.	3043	afterwards.
2632		3044
2633	You I<must not> call C<ev_loop> or similar functions that enter	3045	You I<must not> call C<ev_run> (or similar functions that enter the
2634	the current event loop from either C<ev_prepare> or C<ev_check>	3046	current event loop) or C<ev_loop_fork> from either C<ev_prepare> or
2635	watchers. Other loops than the current one are fine, however. The	3047	C<ev_check> watchers. Other loops than the current one are fine,
2636	rationale behind this is that you do not need to check for recursion in	3048	however. The rationale behind this is that you do not need to check
2637	those watchers, i.e. the sequence will always be C<ev_prepare>, blocking,	3049	for recursion in those watchers, i.e. the sequence will always be
2638	C<ev_check> so if you have one watcher of each kind they will always be	3050	C<ev_prepare>, blocking, C<ev_check> so if you have one watcher of each
2639	called in pairs bracketing the blocking call.	3051	kind they will always be called in pairs bracketing the blocking call.
2640		3052
2641	Their main purpose is to integrate other event mechanisms into libev and	3053	Their main purpose is to integrate other event mechanisms into libev and
2642	their use is somewhat advanced. They could be used, for example, to track	3054	their use is somewhat advanced. They could be used, for example, to track
2643	variable changes, implement your own watchers, integrate net-snmp or a	3055	variable changes, implement your own watchers, integrate net-snmp or a
2644	coroutine library and lots more. They are also occasionally useful if	3056	coroutine library and lots more. They are also occasionally useful if
…		…
2662	with priority higher than or equal to the event loop and one coroutine	3074	with priority higher than or equal to the event loop and one coroutine
2663	of lower priority, but only once, using idle watchers to keep the event	3075	of lower priority, but only once, using idle watchers to keep the event
2664	loop from blocking if lower-priority coroutines are active, thus mapping	3076	loop from blocking if lower-priority coroutines are active, thus mapping
2665	low-priority coroutines to idle/background tasks).	3077	low-priority coroutines to idle/background tasks).
2666		3078
2667	It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>)	3079	When used for this purpose, it is recommended to give C<ev_check> watchers
2668	priority, to ensure that they are being run before any other watchers	3080	highest (C<EV_MAXPRI>) priority, to ensure that they are being run before
2669	after the poll (this doesn't matter for C<ev_prepare> watchers).	3081	any other watchers after the poll (this doesn't matter for C<ev_prepare>
		3082	watchers).
2670		3083
2671	Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not	3084	Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not
2672	activate ("feed") events into libev. While libev fully supports this, they	3085	activate ("feed") events into libev. While libev fully supports this, they
2673	might get executed before other C<ev_check> watchers did their job. As	3086	might get executed before other C<ev_check> watchers did their job. As
2674	C<ev_check> watchers are often used to embed other (non-libev) event	3087	C<ev_check> watchers are often used to embed other (non-libev) event
2675	loops those other event loops might be in an unusable state until their	3088	loops those other event loops might be in an unusable state until their
2676	C<ev_check> watcher ran (always remind yourself to coexist peacefully with	3089	C<ev_check> watcher ran (always remind yourself to coexist peacefully with
2677	others).	3090	others).
		3091
		3092	=head3 Abusing an C<ev_check> watcher for its side-effect
		3093
		3094	C<ev_check> (and less often also C<ev_prepare>) watchers can also be
		3095	useful because they are called once per event loop iteration. For
		3096	example, if you want to handle a large number of connections fairly, you
		3097	normally only do a bit of work for each active connection, and if there
		3098	is more work to do, you wait for the next event loop iteration, so other
		3099	connections have a chance of making progress.
		3100
		3101	Using an C<ev_check> watcher is almost enough: it will be called on the
		3102	next event loop iteration. However, that isn't as soon as possible -
		3103	without external events, your C<ev_check> watcher will not be invoked.
		3104
		3105	This is where C<ev_idle> watchers come in handy - all you need is a
		3106	single global idle watcher that is active as long as you have one active
		3107	C<ev_check> watcher. The C<ev_idle> watcher makes sure the event loop
		3108	will not sleep, and the C<ev_check> watcher makes sure a callback gets
		3109	invoked. Neither watcher alone can do that.
2678		3110
2679	=head3 Watcher-Specific Functions and Data Members	3111	=head3 Watcher-Specific Functions and Data Members
2680		3112
2681	=over 4	3113	=over 4
2682		3114
…		…
2806		3238
2807	if (timeout >= 0)	3239	if (timeout >= 0)
2808	// create/start timer	3240	// create/start timer
2809		3241
2810	// poll	3242	// poll
2811	ev_loop (EV_A_ 0);	3243	ev_run (EV_A_ 0);
2812		3244
2813	// stop timer again	3245	// stop timer again
2814	if (timeout >= 0)	3246	if (timeout >= 0)
2815	ev_timer_stop (EV_A_ &to);	3247	ev_timer_stop (EV_A_ &to);
2816		3248
…		…
2883		3315
2884	=over 4	3316	=over 4
2885		3317
2886	=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)	3318	=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)
2887		3319
2888	=item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)	3320	=item ev_embed_set (ev_embed *, struct ev_loop *embedded_loop)
2889		3321
2890	Configures the watcher to embed the given loop, which must be	3322	Configures the watcher to embed the given loop, which must be
2891	embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be	3323	embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be
2892	invoked automatically, otherwise it is the responsibility of the callback	3324	invoked automatically, otherwise it is the responsibility of the callback
2893	to invoke it (it will continue to be called until the sweep has been done,	3325	to invoke it (it will continue to be called until the sweep has been done,
2894	if you do not want that, you need to temporarily stop the embed watcher).	3326	if you do not want that, you need to temporarily stop the embed watcher).
2895		3327
2896	=item ev_embed_sweep (loop, ev_embed *)	3328	=item ev_embed_sweep (loop, ev_embed *)
2897		3329
2898	Make a single, non-blocking sweep over the embedded loop. This works	3330	Make a single, non-blocking sweep over the embedded loop. This works
2899	similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most	3331	similarly to C<ev_run (embedded_loop, EVRUN_NOWAIT)>, but in the most
2900	appropriate way for embedded loops.	3332	appropriate way for embedded loops.
2901		3333
2902	=item struct ev_loop *other [read-only]	3334	=item struct ev_loop *other [read-only]
2903		3335
2904	The embedded event loop.	3336	The embedded event loop.
…		…
2914	used).	3346	used).
2915		3347
2916	struct ev_loop *loop_hi = ev_default_init (0);	3348	struct ev_loop *loop_hi = ev_default_init (0);
2917	struct ev_loop *loop_lo = 0;	3349	struct ev_loop *loop_lo = 0;
2918	ev_embed embed;	3350	ev_embed embed;
2919		3351
2920	// see if there is a chance of getting one that works	3352	// see if there is a chance of getting one that works
2921	// (remember that a flags value of 0 means autodetection)	3353	// (remember that a flags value of 0 means autodetection)
2922	loop_lo = ev_embeddable_backends () & ev_recommended_backends ()	3354	loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
2923	? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())	3355	? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
2924	: 0;	3356	: 0;
…		…
2938	C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).	3370	C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).
2939		3371
2940	struct ev_loop *loop = ev_default_init (0);	3372	struct ev_loop *loop = ev_default_init (0);
2941	struct ev_loop *loop_socket = 0;	3373	struct ev_loop *loop_socket = 0;
2942	ev_embed embed;	3374	ev_embed embed;
2943		3375
2944	if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)	3376	if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
2945	if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))	3377	if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
2946	{	3378	{
2947	ev_embed_init (&embed, 0, loop_socket);	3379	ev_embed_init (&embed, 0, loop_socket);
2948	ev_embed_start (loop, &embed);	3380	ev_embed_start (loop, &embed);
…		…
2956		3388
2957	=head2 C<ev_fork> - the audacity to resume the event loop after a fork	3389	=head2 C<ev_fork> - the audacity to resume the event loop after a fork
2958		3390
2959	Fork watchers are called when a C<fork ()> was detected (usually because	3391	Fork watchers are called when a C<fork ()> was detected (usually because
2960	whoever is a good citizen cared to tell libev about it by calling	3392	whoever is a good citizen cared to tell libev about it by calling
2961	C<ev_default_fork> or C<ev_loop_fork>). The invocation is done before the	3393	C<ev_loop_fork>). The invocation is done before the event loop blocks next
2962	event loop blocks next and before C<ev_check> watchers are being called,	3394	and before C<ev_check> watchers are being called, and only in the child
2963	and only in the child after the fork. If whoever good citizen calling	3395	after the fork. If whoever good citizen calling C<ev_default_fork> cheats
2964	C<ev_default_fork> cheats and calls it in the wrong process, the fork	3396	and calls it in the wrong process, the fork handlers will be invoked, too,
2965	handlers will be invoked, too, of course.	3397	of course.
2966		3398
2967	=head3 The special problem of life after fork - how is it possible?	3399	=head3 The special problem of life after fork - how is it possible?
2968		3400
2969	Most uses of C<fork()> consist of forking, then some simple calls to ste	3401	Most uses of C<fork ()> consist of forking, then some simple calls to set
2970	up/change the process environment, followed by a call to C<exec()>. This	3402	up/change the process environment, followed by a call to C<exec()>. This
2971	sequence should be handled by libev without any problems.	3403	sequence should be handled by libev without any problems.
2972		3404
2973	This changes when the application actually wants to do event handling	3405	This changes when the application actually wants to do event handling
2974	in the child, or both parent in child, in effect "continuing" after the	3406	in the child, or both parent in child, in effect "continuing" after the
…		…
2990	disadvantage of having to use multiple event loops (which do not support	3422	disadvantage of having to use multiple event loops (which do not support
2991	signal watchers).	3423	signal watchers).
2992		3424
2993	When this is not possible, or you want to use the default loop for	3425	When this is not possible, or you want to use the default loop for
2994	other reasons, then in the process that wants to start "fresh", call	3426	other reasons, then in the process that wants to start "fresh", call
2995	C<ev_default_destroy ()> followed by C<ev_default_loop (...)>. Destroying	3427	C<ev_loop_destroy (EV_DEFAULT)> followed by C<ev_default_loop (...)>.
2996	the default loop will "orphan" (not stop) all registered watchers, so you	3428	Destroying the default loop will "orphan" (not stop) all registered
2997	have to be careful not to execute code that modifies those watchers. Note	3429	watchers, so you have to be careful not to execute code that modifies
2998	also that in that case, you have to re-register any signal watchers.	3430	those watchers. Note also that in that case, you have to re-register any
		3431	signal watchers.
2999		3432
3000	=head3 Watcher-Specific Functions and Data Members	3433	=head3 Watcher-Specific Functions and Data Members
3001		3434
3002	=over 4	3435	=over 4
3003		3436
3004	=item ev_fork_init (ev_signal *, callback)	3437	=item ev_fork_init (ev_fork *, callback)
3005		3438
3006	Initialises and configures the fork watcher - it has no parameters of any	3439	Initialises and configures the fork watcher - it has no parameters of any
3007	kind. There is a C<ev_fork_set> macro, but using it is utterly pointless,	3440	kind. There is a C<ev_fork_set> macro, but using it is utterly pointless,
3008	believe me.	3441	really.
3009		3442
3010	=back	3443	=back
3011		3444
3012		3445
		3446	=head2 C<ev_cleanup> - even the best things end
		3447
		3448	Cleanup watchers are called just before the event loop is being destroyed
		3449	by a call to C<ev_loop_destroy>.
		3450
		3451	While there is no guarantee that the event loop gets destroyed, cleanup
		3452	watchers provide a convenient method to install cleanup hooks for your
		3453	program, worker threads and so on - you just to make sure to destroy the
		3454	loop when you want them to be invoked.
		3455
		3456	Cleanup watchers are invoked in the same way as any other watcher. Unlike
		3457	all other watchers, they do not keep a reference to the event loop (which
		3458	makes a lot of sense if you think about it). Like all other watchers, you
		3459	can call libev functions in the callback, except C<ev_cleanup_start>.
		3460
		3461	=head3 Watcher-Specific Functions and Data Members
		3462
		3463	=over 4
		3464
		3465	=item ev_cleanup_init (ev_cleanup *, callback)
		3466
		3467	Initialises and configures the cleanup watcher - it has no parameters of
		3468	any kind. There is a C<ev_cleanup_set> macro, but using it is utterly
		3469	pointless, I assure you.
		3470
		3471	=back
		3472
		3473	Example: Register an atexit handler to destroy the default loop, so any
		3474	cleanup functions are called.
		3475
		3476	static void
		3477	program_exits (void)
		3478	{
		3479	ev_loop_destroy (EV_DEFAULT_UC);
		3480	}
		3481
		3482	...
		3483	atexit (program_exits);
		3484
		3485
3013	=head2 C<ev_async> - how to wake up another event loop	3486	=head2 C<ev_async> - how to wake up an event loop
3014		3487
3015	In general, you cannot use an C<ev_loop> from multiple threads or other	3488	In general, you cannot use an C<ev_loop> from multiple threads or other
3016	asynchronous sources such as signal handlers (as opposed to multiple event	3489	asynchronous sources such as signal handlers (as opposed to multiple event
3017	loops - those are of course safe to use in different threads).	3490	loops - those are of course safe to use in different threads).
3018		3491
3019	Sometimes, however, you need to wake up another event loop you do not	3492	Sometimes, however, you need to wake up an event loop you do not control,
3020	control, for example because it belongs to another thread. This is what	3493	for example because it belongs to another thread. This is what C<ev_async>
3021	C<ev_async> watchers do: as long as the C<ev_async> watcher is active, you	3494	watchers do: as long as the C<ev_async> watcher is active, you can signal
3022	can signal it by calling C<ev_async_send>, which is thread- and signal	3495	it by calling C<ev_async_send>, which is thread- and signal safe.
3023	safe.
3024		3496
3025	This functionality is very similar to C<ev_signal> watchers, as signals,	3497	This functionality is very similar to C<ev_signal> watchers, as signals,
3026	too, are asynchronous in nature, and signals, too, will be compressed	3498	too, are asynchronous in nature, and signals, too, will be compressed
3027	(i.e. the number of callback invocations may be less than the number of	3499	(i.e. the number of callback invocations may be less than the number of
3028	C<ev_async_sent> calls).	3500	C<ev_async_send> calls). In fact, you could use signal watchers as a kind
3029		3501	of "global async watchers" by using a watcher on an otherwise unused
3030	Unlike C<ev_signal> watchers, C<ev_async> works with any event loop, not	3502	signal, and C<ev_feed_signal> to signal this watcher from another thread,
3031	just the default loop.	3503	even without knowing which loop owns the signal.
3032		3504
3033	=head3 Queueing	3505	=head3 Queueing
3034		3506
3035	C<ev_async> does not support queueing of data in any way. The reason	3507	C<ev_async> does not support queueing of data in any way. The reason
3036	is that the author does not know of a simple (or any) algorithm for a	3508	is that the author does not know of a simple (or any) algorithm for a
…		…
3128	trust me.	3600	trust me.
3129		3601
3130	=item ev_async_send (loop, ev_async *)	3602	=item ev_async_send (loop, ev_async *)
3131		3603
3132	Sends/signals/activates the given C<ev_async> watcher, that is, feeds	3604	Sends/signals/activates the given C<ev_async> watcher, that is, feeds
3133	an C<EV_ASYNC> event on the watcher into the event loop. Unlike	3605	an C<EV_ASYNC> event on the watcher into the event loop, and instantly
		3606	returns.
		3607
3134	C<ev_feed_event>, this call is safe to do from other threads, signal or	3608	Unlike C<ev_feed_event>, this call is safe to do from other threads,
3135	similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding	3609	signal or similar contexts (see the discussion of C<EV_ATOMIC_T> in the
3136	section below on what exactly this means).	3610	embedding section below on what exactly this means).
3137		3611
3138	Note that, as with other watchers in libev, multiple events might get	3612	Note that, as with other watchers in libev, multiple events might get
3139	compressed into a single callback invocation (another way to look at this	3613	compressed into a single callback invocation (another way to look at
3140	is that C<ev_async> watchers are level-triggered, set on C<ev_async_send>,	3614	this is that C<ev_async> watchers are level-triggered: they are set on
3141	reset when the event loop detects that).	3615	C<ev_async_send>, reset when the event loop detects that).
3142		3616
3143	This call incurs the overhead of a system call only once per event loop	3617	This call incurs the overhead of at most one extra system call per event
3144	iteration, so while the overhead might be noticeable, it doesn't apply to	3618	loop iteration, if the event loop is blocked, and no syscall at all if
3145	repeated calls to C<ev_async_send> for the same event loop.	3619	the event loop (or your program) is processing events. That means that
		3620	repeated calls are basically free (there is no need to avoid calls for
		3621	performance reasons) and that the overhead becomes smaller (typically
		3622	zero) under load.
3146		3623
3147	=item bool = ev_async_pending (ev_async *)	3624	=item bool = ev_async_pending (ev_async *)
3148		3625
3149	Returns a non-zero value when C<ev_async_send> has been called on the	3626	Returns a non-zero value when C<ev_async_send> has been called on the
3150	watcher but the event has not yet been processed (or even noted) by the	3627	watcher but the event has not yet been processed (or even noted) by the
…		…
3167		3644
3168	There are some other functions of possible interest. Described. Here. Now.	3645	There are some other functions of possible interest. Described. Here. Now.
3169		3646
3170	=over 4	3647	=over 4
3171		3648
3172	=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback)	3649	=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback, arg)
3173		3650
3174	This function combines a simple timer and an I/O watcher, calls your	3651	This function combines a simple timer and an I/O watcher, calls your
3175	callback on whichever event happens first and automatically stops both	3652	callback on whichever event happens first and automatically stops both
3176	watchers. This is useful if you want to wait for a single event on an fd	3653	watchers. This is useful if you want to wait for a single event on an fd
3177	or timeout without having to allocate/configure/start/stop/free one or	3654	or timeout without having to allocate/configure/start/stop/free one or
…		…
3205	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);	3682	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
3206		3683
3207	=item ev_feed_fd_event (loop, int fd, int revents)	3684	=item ev_feed_fd_event (loop, int fd, int revents)
3208		3685
3209	Feed an event on the given fd, as if a file descriptor backend detected	3686	Feed an event on the given fd, as if a file descriptor backend detected
3210	the given events it.	3687	the given events.
3211		3688
3212	=item ev_feed_signal_event (loop, int signum)	3689	=item ev_feed_signal_event (loop, int signum)
3213		3690
3214	Feed an event as if the given signal occurred (C<loop> must be the default	3691	Feed an event as if the given signal occurred. See also C<ev_feed_signal>,
3215	loop!).	3692	which is async-safe.
3216		3693
3217	=back	3694	=back
		3695
		3696
		3697	=head1 COMMON OR USEFUL IDIOMS (OR BOTH)
		3698
		3699	This section explains some common idioms that are not immediately
		3700	obvious. Note that examples are sprinkled over the whole manual, and this
		3701	section only contains stuff that wouldn't fit anywhere else.
		3702
		3703	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
		3704
		3705	Each watcher has, by default, a C<void *data> member that you can read
		3706	or modify at any time: libev will completely ignore it. This can be used
		3707	to associate arbitrary data with your watcher. If you need more data and
		3708	don't want to allocate memory separately and store a pointer to it in that
		3709	data member, you can also "subclass" the watcher type and provide your own
		3710	data:
		3711
		3712	struct my_io
		3713	{
		3714	ev_io io;
		3715	int otherfd;
		3716	void *somedata;
		3717	struct whatever *mostinteresting;
		3718	};
		3719
		3720	...
		3721	struct my_io w;
		3722	ev_io_init (&w.io, my_cb, fd, EV_READ);
		3723
		3724	And since your callback will be called with a pointer to the watcher, you
		3725	can cast it back to your own type:
		3726
		3727	static void my_cb (struct ev_loop *loop, ev_io *w_, int revents)
		3728	{
		3729	struct my_io *w = (struct my_io *)w_;
		3730	...
		3731	}
		3732
		3733	More interesting and less C-conformant ways of casting your callback
		3734	function type instead have been omitted.
		3735
		3736	=head2 BUILDING YOUR OWN COMPOSITE WATCHERS
		3737
		3738	Another common scenario is to use some data structure with multiple
		3739	embedded watchers, in effect creating your own watcher that combines
		3740	multiple libev event sources into one "super-watcher":
		3741
		3742	struct my_biggy
		3743	{
		3744	int some_data;
		3745	ev_timer t1;
		3746	ev_timer t2;
		3747	}
		3748
		3749	In this case getting the pointer to C<my_biggy> is a bit more
		3750	complicated: Either you store the address of your C<my_biggy> struct in
		3751	the C<data> member of the watcher (for woozies or C++ coders), or you need
		3752	to use some pointer arithmetic using C<offsetof> inside your watchers (for
		3753	real programmers):
		3754
		3755	#include <stddef.h>
		3756
		3757	static void
		3758	t1_cb (EV_P_ ev_timer *w, int revents)
		3759	{
		3760	struct my_biggy big = (struct my_biggy *)
		3761	(((char *)w) - offsetof (struct my_biggy, t1));
		3762	}
		3763
		3764	static void
		3765	t2_cb (EV_P_ ev_timer *w, int revents)
		3766	{
		3767	struct my_biggy big = (struct my_biggy *)
		3768	(((char *)w) - offsetof (struct my_biggy, t2));
		3769	}
		3770
		3771	=head2 AVOIDING FINISHING BEFORE RETURNING
		3772
		3773	Often you have structures like this in event-based programs:
		3774
		3775	callback ()
		3776	{
		3777	free (request);
		3778	}
		3779
		3780	request = start_new_request (..., callback);
		3781
		3782	The intent is to start some "lengthy" operation. The C<request> could be
		3783	used to cancel the operation, or do other things with it.
		3784
		3785	It's not uncommon to have code paths in C<start_new_request> that
		3786	immediately invoke the callback, for example, to report errors. Or you add
		3787	some caching layer that finds that it can skip the lengthy aspects of the
		3788	operation and simply invoke the callback with the result.
		3789
		3790	The problem here is that this will happen I<before> C<start_new_request>
		3791	has returned, so C<request> is not set.
		3792
		3793	Even if you pass the request by some safer means to the callback, you
		3794	might want to do something to the request after starting it, such as
		3795	canceling it, which probably isn't working so well when the callback has
		3796	already been invoked.
		3797
		3798	A common way around all these issues is to make sure that
		3799	C<start_new_request> I<always> returns before the callback is invoked. If
		3800	C<start_new_request> immediately knows the result, it can artificially
		3801	delay invoking the callback by using a C<prepare> or C<idle> watcher for
		3802	example, or more sneakily, by reusing an existing (stopped) watcher and
		3803	pushing it into the pending queue:
		3804
		3805	ev_set_cb (watcher, callback);
		3806	ev_feed_event (EV_A_ watcher, 0);
		3807
		3808	This way, C<start_new_request> can safely return before the callback is
		3809	invoked, while not delaying callback invocation too much.
		3810
		3811	=head2 MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS
		3812
		3813	Often (especially in GUI toolkits) there are places where you have
		3814	I<modal> interaction, which is most easily implemented by recursively
		3815	invoking C<ev_run>.
		3816
		3817	This brings the problem of exiting - a callback might want to finish the
		3818	main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but
		3819	a modal "Are you sure?" dialog is still waiting), or just the nested one
		3820	and not the main one (e.g. user clocked "Ok" in a modal dialog), or some
		3821	other combination: In these cases, a simple C<ev_break> will not work.
		3822
		3823	The solution is to maintain "break this loop" variable for each C<ev_run>
		3824	invocation, and use a loop around C<ev_run> until the condition is
		3825	triggered, using C<EVRUN_ONCE>:
		3826
		3827	// main loop
		3828	int exit_main_loop = 0;
		3829
		3830	while (!exit_main_loop)
		3831	ev_run (EV_DEFAULT_ EVRUN_ONCE);
		3832
		3833	// in a modal watcher
		3834	int exit_nested_loop = 0;
		3835
		3836	while (!exit_nested_loop)
		3837	ev_run (EV_A_ EVRUN_ONCE);
		3838
		3839	To exit from any of these loops, just set the corresponding exit variable:
		3840
		3841	// exit modal loop
		3842	exit_nested_loop = 1;
		3843
		3844	// exit main program, after modal loop is finished
		3845	exit_main_loop = 1;
		3846
		3847	// exit both
		3848	exit_main_loop = exit_nested_loop = 1;
		3849
		3850	=head2 THREAD LOCKING EXAMPLE
		3851
		3852	Here is a fictitious example of how to run an event loop in a different
		3853	thread from where callbacks are being invoked and watchers are
		3854	created/added/removed.
		3855
		3856	For a real-world example, see the C<EV::Loop::Async> perl module,
		3857	which uses exactly this technique (which is suited for many high-level
		3858	languages).
		3859
		3860	The example uses a pthread mutex to protect the loop data, a condition
		3861	variable to wait for callback invocations, an async watcher to notify the
		3862	event loop thread and an unspecified mechanism to wake up the main thread.
		3863
		3864	First, you need to associate some data with the event loop:
		3865
		3866	typedef struct {
		3867	mutex_t lock; /* global loop lock */
		3868	ev_async async_w;
		3869	thread_t tid;
		3870	cond_t invoke_cv;
		3871	} userdata;
		3872
		3873	void prepare_loop (EV_P)
		3874	{
		3875	// for simplicity, we use a static userdata struct.
		3876	static userdata u;
		3877
		3878	ev_async_init (&u->async_w, async_cb);
		3879	ev_async_start (EV_A_ &u->async_w);
		3880
		3881	pthread_mutex_init (&u->lock, 0);
		3882	pthread_cond_init (&u->invoke_cv, 0);
		3883
		3884	// now associate this with the loop
		3885	ev_set_userdata (EV_A_ u);
		3886	ev_set_invoke_pending_cb (EV_A_ l_invoke);
		3887	ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
		3888
		3889	// then create the thread running ev_run
		3890	pthread_create (&u->tid, 0, l_run, EV_A);
		3891	}
		3892
		3893	The callback for the C<ev_async> watcher does nothing: the watcher is used
		3894	solely to wake up the event loop so it takes notice of any new watchers
		3895	that might have been added:
		3896
		3897	static void
		3898	async_cb (EV_P_ ev_async *w, int revents)
		3899	{
		3900	// just used for the side effects
		3901	}
		3902
		3903	The C<l_release> and C<l_acquire> callbacks simply unlock/lock the mutex
		3904	protecting the loop data, respectively.
		3905
		3906	static void
		3907	l_release (EV_P)
		3908	{
		3909	userdata *u = ev_userdata (EV_A);
		3910	pthread_mutex_unlock (&u->lock);
		3911	}
		3912
		3913	static void
		3914	l_acquire (EV_P)
		3915	{
		3916	userdata *u = ev_userdata (EV_A);
		3917	pthread_mutex_lock (&u->lock);
		3918	}
		3919
		3920	The event loop thread first acquires the mutex, and then jumps straight
		3921	into C<ev_run>:
		3922
		3923	void *
		3924	l_run (void *thr_arg)
		3925	{
		3926	struct ev_loop *loop = (struct ev_loop *)thr_arg;
		3927
		3928	l_acquire (EV_A);
		3929	pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
		3930	ev_run (EV_A_ 0);
		3931	l_release (EV_A);
		3932
		3933	return 0;
		3934	}
		3935
		3936	Instead of invoking all pending watchers, the C<l_invoke> callback will
		3937	signal the main thread via some unspecified mechanism (signals? pipe
		3938	writes? C<Async::Interrupt>?) and then waits until all pending watchers
		3939	have been called (in a while loop because a) spurious wakeups are possible
		3940	and b) skipping inter-thread-communication when there are no pending
		3941	watchers is very beneficial):
		3942
		3943	static void
		3944	l_invoke (EV_P)
		3945	{
		3946	userdata *u = ev_userdata (EV_A);
		3947
		3948	while (ev_pending_count (EV_A))
		3949	{
		3950	wake_up_other_thread_in_some_magic_or_not_so_magic_way ();
		3951	pthread_cond_wait (&u->invoke_cv, &u->lock);
		3952	}
		3953	}
		3954
		3955	Now, whenever the main thread gets told to invoke pending watchers, it
		3956	will grab the lock, call C<ev_invoke_pending> and then signal the loop
		3957	thread to continue:
		3958
		3959	static void
		3960	real_invoke_pending (EV_P)
		3961	{
		3962	userdata *u = ev_userdata (EV_A);
		3963
		3964	pthread_mutex_lock (&u->lock);
		3965	ev_invoke_pending (EV_A);
		3966	pthread_cond_signal (&u->invoke_cv);
		3967	pthread_mutex_unlock (&u->lock);
		3968	}
		3969
		3970	Whenever you want to start/stop a watcher or do other modifications to an
		3971	event loop, you will now have to lock:
		3972
		3973	ev_timer timeout_watcher;
		3974	userdata *u = ev_userdata (EV_A);
		3975
		3976	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
		3977
		3978	pthread_mutex_lock (&u->lock);
		3979	ev_timer_start (EV_A_ &timeout_watcher);
		3980	ev_async_send (EV_A_ &u->async_w);
		3981	pthread_mutex_unlock (&u->lock);
		3982
		3983	Note that sending the C<ev_async> watcher is required because otherwise
		3984	an event loop currently blocking in the kernel will have no knowledge
		3985	about the newly added timer. By waking up the loop it will pick up any new
		3986	watchers in the next event loop iteration.
		3987
		3988	=head2 THREADS, COROUTINES, CONTINUATIONS, QUEUES... INSTEAD OF CALLBACKS
		3989
		3990	While the overhead of a callback that e.g. schedules a thread is small, it
		3991	is still an overhead. If you embed libev, and your main usage is with some
		3992	kind of threads or coroutines, you might want to customise libev so that
		3993	doesn't need callbacks anymore.
		3994
		3995	Imagine you have coroutines that you can switch to using a function
		3996	C<switch_to (coro)>, that libev runs in a coroutine called C<libev_coro>
		3997	and that due to some magic, the currently active coroutine is stored in a
		3998	global called C<current_coro>. Then you can build your own "wait for libev
		3999	event" primitive by changing C<EV_CB_DECLARE> and C<EV_CB_INVOKE> (note
		4000	the differing C<;> conventions):
		4001
		4002	#define EV_CB_DECLARE(type) struct my_coro *cb;
		4003	#define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb)
		4004
		4005	That means instead of having a C callback function, you store the
		4006	coroutine to switch to in each watcher, and instead of having libev call
		4007	your callback, you instead have it switch to that coroutine.
		4008
		4009	A coroutine might now wait for an event with a function called
		4010	C<wait_for_event>. (the watcher needs to be started, as always, but it doesn't
		4011	matter when, or whether the watcher is active or not when this function is
		4012	called):
		4013
		4014	void
		4015	wait_for_event (ev_watcher *w)
		4016	{
		4017	ev_set_cb (w, current_coro);
		4018	switch_to (libev_coro);
		4019	}
		4020
		4021	That basically suspends the coroutine inside C<wait_for_event> and
		4022	continues the libev coroutine, which, when appropriate, switches back to
		4023	this or any other coroutine.
		4024
		4025	You can do similar tricks if you have, say, threads with an event queue -
		4026	instead of storing a coroutine, you store the queue object and instead of
		4027	switching to a coroutine, you push the watcher onto the queue and notify
		4028	any waiters.
		4029
		4030	To embed libev, see L</EMBEDDING>, but in short, it's easiest to create two
		4031	files, F<my_ev.h> and F<my_ev.c> that include the respective libev files:
		4032
		4033	// my_ev.h
		4034	#define EV_CB_DECLARE(type) struct my_coro *cb;
		4035	#define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb)
		4036	#include "../libev/ev.h"
		4037
		4038	// my_ev.c
		4039	#define EV_H "my_ev.h"
		4040	#include "../libev/ev.c"
		4041
		4042	And then use F<my_ev.h> when you would normally use F<ev.h>, and compile
		4043	F<my_ev.c> into your project. When properly specifying include paths, you
		4044	can even use F<ev.h> as header file name directly.
3218		4045
3219		4046
3220	=head1 LIBEVENT EMULATION	4047	=head1 LIBEVENT EMULATION
3221		4048
3222	Libev offers a compatibility emulation layer for libevent. It cannot	4049	Libev offers a compatibility emulation layer for libevent. It cannot
3223	emulate the internals of libevent, so here are some usage hints:	4050	emulate the internals of libevent, so here are some usage hints:
3224		4051
3225	=over 4	4052	=over 4
		4053
		4054	=item * Only the libevent-1.4.1-beta API is being emulated.
		4055
		4056	This was the newest libevent version available when libev was implemented,
		4057	and is still mostly unchanged in 2010.
3226		4058
3227	=item * Use it by including <event.h>, as usual.	4059	=item * Use it by including <event.h>, as usual.
3228		4060
3229	=item * The following members are fully supported: ev_base, ev_callback,	4061	=item * The following members are fully supported: ev_base, ev_callback,
3230	ev_arg, ev_fd, ev_res, ev_events.	4062	ev_arg, ev_fd, ev_res, ev_events.
…		…
3236	=item * Priorities are not currently supported. Initialising priorities	4068	=item * Priorities are not currently supported. Initialising priorities
3237	will fail and all watchers will have the same priority, even though there	4069	will fail and all watchers will have the same priority, even though there
3238	is an ev_pri field.	4070	is an ev_pri field.
3239		4071
3240	=item * In libevent, the last base created gets the signals, in libev, the	4072	=item * In libevent, the last base created gets the signals, in libev, the
3241	first base created (== the default loop) gets the signals.	4073	base that registered the signal gets the signals.
3242		4074
3243	=item * Other members are not supported.	4075	=item * Other members are not supported.
3244		4076
3245	=item * The libev emulation is I<not> ABI compatible to libevent, you need	4077	=item * The libev emulation is I<not> ABI compatible to libevent, you need
3246	to use the libev header file and library.	4078	to use the libev header file and library.
3247		4079
3248	=back	4080	=back
3249		4081
3250	=head1 C++ SUPPORT	4082	=head1 C++ SUPPORT
		4083
		4084	=head2 C API
		4085
		4086	The normal C API should work fine when used from C++: both ev.h and the
		4087	libev sources can be compiled as C++. Therefore, code that uses the C API
		4088	will work fine.
		4089
		4090	Proper exception specifications might have to be added to callbacks passed
		4091	to libev: exceptions may be thrown only from watcher callbacks, all other
		4092	callbacks (allocator, syserr, loop acquire/release and periodic reschedule
		4093	callbacks) must not throw exceptions, and might need a C<noexcept>
		4094	specification. If you have code that needs to be compiled as both C and
		4095	C++ you can use the C<EV_NOEXCEPT> macro for this:
		4096
		4097	static void
		4098	fatal_error (const char *msg) EV_NOEXCEPT
		4099	{
		4100	perror (msg);
		4101	abort ();
		4102	}
		4103
		4104	...
		4105	ev_set_syserr_cb (fatal_error);
		4106
		4107	The only API functions that can currently throw exceptions are C<ev_run>,
		4108	C<ev_invoke>, C<ev_invoke_pending> and C<ev_loop_destroy> (the latter
		4109	because it runs cleanup watchers).
		4110
		4111	Throwing exceptions in watcher callbacks is only supported if libev itself
		4112	is compiled with a C++ compiler or your C and C++ environments allow
		4113	throwing exceptions through C libraries (most do).
		4114
		4115	=head2 C++ API
3251		4116
3252	Libev comes with some simplistic wrapper classes for C++ that mainly allow	4117	Libev comes with some simplistic wrapper classes for C++ that mainly allow
3253	you to use some convenience methods to start/stop watchers and also change	4118	you to use some convenience methods to start/stop watchers and also change
3254	the callback model to a model using method callbacks on objects.	4119	the callback model to a model using method callbacks on objects.
3255		4120
3256	To use it,	4121	To use it,
3257		4122
3258	#include <ev++.h>	4123	#include <ev++.h>
3259		4124
3260	This automatically includes F<ev.h> and puts all of its definitions (many	4125	This automatically includes F<ev.h> and puts all of its definitions (many
3261	of them macros) into the global namespace. All C++ specific things are	4126	of them macros) into the global namespace. All C++ specific things are
3262	put into the C<ev> namespace. It should support all the same embedding	4127	put into the C<ev> namespace. It should support all the same embedding
…		…
3265	Care has been taken to keep the overhead low. The only data member the C++	4130	Care has been taken to keep the overhead low. The only data member the C++
3266	classes add (compared to plain C-style watchers) is the event loop pointer	4131	classes add (compared to plain C-style watchers) is the event loop pointer
3267	that the watcher is associated with (or no additional members at all if	4132	that the watcher is associated with (or no additional members at all if
3268	you disable C<EV_MULTIPLICITY> when embedding libev).	4133	you disable C<EV_MULTIPLICITY> when embedding libev).
3269		4134
3270	Currently, functions, and static and non-static member functions can be	4135	Currently, functions, static and non-static member functions and classes
3271	used as callbacks. Other types should be easy to add as long as they only	4136	with C<operator ()> can be used as callbacks. Other types should be easy
3272	need one additional pointer for context. If you need support for other	4137	to add as long as they only need one additional pointer for context. If
3273	types of functors please contact the author (preferably after implementing	4138	you need support for other types of functors please contact the author
3274	it).	4139	(preferably after implementing it).
		4140
		4141	For all this to work, your C++ compiler either has to use the same calling
		4142	conventions as your C compiler (for static member functions), or you have
		4143	to embed libev and compile libev itself as C++.
3275		4144
3276	Here is a list of things available in the C<ev> namespace:	4145	Here is a list of things available in the C<ev> namespace:
3277		4146
3278	=over 4	4147	=over 4
3279		4148
…		…
3289	=item C<ev::io>, C<ev::timer>, C<ev::periodic>, C<ev::idle>, C<ev::sig> etc.	4158	=item C<ev::io>, C<ev::timer>, C<ev::periodic>, C<ev::idle>, C<ev::sig> etc.
3290		4159
3291	For each C<ev_TYPE> watcher in F<ev.h> there is a corresponding class of	4160	For each C<ev_TYPE> watcher in F<ev.h> there is a corresponding class of
3292	the same name in the C<ev> namespace, with the exception of C<ev_signal>	4161	the same name in the C<ev> namespace, with the exception of C<ev_signal>
3293	which is called C<ev::sig> to avoid clashes with the C<signal> macro	4162	which is called C<ev::sig> to avoid clashes with the C<signal> macro
3294	defines by many implementations.	4163	defined by many implementations.
3295		4164
3296	All of those classes have these methods:	4165	All of those classes have these methods:
3297		4166
3298	=over 4	4167	=over 4
3299		4168
…		…
3340	myclass obj;	4209	myclass obj;
3341	ev::io iow;	4210	ev::io iow;
3342	iow.set <myclass, &myclass::io_cb> (&obj);	4211	iow.set <myclass, &myclass::io_cb> (&obj);
3343		4212
3344	=item w->set (object *)	4213	=item w->set (object *)
3345
3346	This is an B<experimental> feature that might go away in a future version.
3347		4214
3348	This is a variation of a method callback - leaving out the method to call	4215	This is a variation of a method callback - leaving out the method to call
3349	will default the method to C<operator ()>, which makes it possible to use	4216	will default the method to C<operator ()>, which makes it possible to use
3350	functor objects without having to manually specify the C<operator ()> all	4217	functor objects without having to manually specify the C<operator ()> all
3351	the time. Incidentally, you can then also leave out the template argument	4218	the time. Incidentally, you can then also leave out the template argument
…		…
3363	void operator() (ev::io &w, int revents)	4230	void operator() (ev::io &w, int revents)
3364	{	4231	{
3365	...	4232	...
3366	}	4233	}
3367	}	4234	}
3368		4235
3369	myfunctor f;	4236	myfunctor f;
3370		4237
3371	ev::io w;	4238	ev::io w;
3372	w.set (&f);	4239	w.set (&f);
3373		4240
…		…
3391	Associates a different C<struct ev_loop> with this watcher. You can only	4258	Associates a different C<struct ev_loop> with this watcher. You can only
3392	do this when the watcher is inactive (and not pending either).	4259	do this when the watcher is inactive (and not pending either).
3393		4260
3394	=item w->set ([arguments])	4261	=item w->set ([arguments])
3395		4262
3396	Basically the same as C<ev_TYPE_set>, with the same arguments. Must be	4263	Basically the same as C<ev_TYPE_set> (except for C<ev::embed> watchers>),
		4264	with the same arguments. Either this method or a suitable start method
3397	called at least once. Unlike the C counterpart, an active watcher gets	4265	must be called at least once. Unlike the C counterpart, an active watcher
3398	automatically stopped and restarted when reconfiguring it with this	4266	gets automatically stopped and restarted when reconfiguring it with this
3399	method.	4267	method.
		4268
		4269	For C<ev::embed> watchers this method is called C<set_embed>, to avoid
		4270	clashing with the C<set (loop)> method.
		4271
		4272	For C<ev::io> watchers there is an additional C<set> method that acepts a
		4273	new event mask only, and internally calls C<ev_io_modfify>.
3400		4274
3401	=item w->start ()	4275	=item w->start ()
3402		4276
3403	Starts the watcher. Note that there is no C<loop> argument, as the	4277	Starts the watcher. Note that there is no C<loop> argument, as the
3404	constructor already stores the event loop.	4278	constructor already stores the event loop.
3405		4279
		4280	=item w->start ([arguments])
		4281
		4282	Instead of calling C<set> and C<start> methods separately, it is often
		4283	convenient to wrap them in one call. Uses the same type of arguments as
		4284	the configure C<set> method of the watcher.
		4285
3406	=item w->stop ()	4286	=item w->stop ()
3407		4287
3408	Stops the watcher if it is active. Again, no C<loop> argument.	4288	Stops the watcher if it is active. Again, no C<loop> argument.
3409		4289
3410	=item w->again () (C<ev::timer>, C<ev::periodic> only)	4290	=item w->again () (C<ev::timer>, C<ev::periodic> only)
…		…
3422		4302
3423	=back	4303	=back
3424		4304
3425	=back	4305	=back
3426		4306
3427	Example: Define a class with an IO and idle watcher, start one of them in	4307	Example: Define a class with two I/O and idle watchers, start the I/O
3428	the constructor.	4308	watchers in the constructor.
3429		4309
3430	class myclass	4310	class myclass
3431	{	4311	{
3432	ev::io io ; void io_cb (ev::io &w, int revents);	4312	ev::io io ; void io_cb (ev::io &w, int revents);
		4313	ev::io io2 ; void io2_cb (ev::io &w, int revents);
3433	ev::idle idle; void idle_cb (ev::idle &w, int revents);	4314	ev::idle idle; void idle_cb (ev::idle &w, int revents);
3434		4315
3435	myclass (int fd)	4316	myclass (int fd)
3436	{	4317	{
3437	io .set <myclass, &myclass::io_cb > (this);	4318	io .set <myclass, &myclass::io_cb > (this);
		4319	io2 .set <myclass, &myclass::io2_cb > (this);
3438	idle.set <myclass, &myclass::idle_cb> (this);	4320	idle.set <myclass, &myclass::idle_cb> (this);
3439		4321
3440	io.start (fd, ev::READ);	4322	io.set (fd, ev::WRITE); // configure the watcher
		4323	io.start (); // start it whenever convenient
		4324
		4325	io2.start (fd, ev::READ); // set + start in one call
3441	}	4326	}
3442	};	4327	};
3443		4328
3444		4329
3445	=head1 OTHER LANGUAGE BINDINGS	4330	=head1 OTHER LANGUAGE BINDINGS
…		…
3484	L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>.	4369	L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>.
3485		4370
3486	=item D	4371	=item D
3487		4372
3488	Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to	4373	Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to
3489	be found at L<http://proj.llucax.com.ar/wiki/evd>.	4374	be found at L<http://www.llucax.com.ar/proj/ev.d/index.html>.
3490		4375
3491	=item Ocaml	4376	=item Ocaml
3492		4377
3493	Erkki Seppala has written Ocaml bindings for libev, to be found at	4378	Erkki Seppala has written Ocaml bindings for libev, to be found at
3494	L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.	4379	L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.
…		…
3497		4382
3498	Brian Maher has written a partial interface to libev for lua (at the	4383	Brian Maher has written a partial interface to libev for lua (at the
3499	time of this writing, only C<ev_io> and C<ev_timer>), to be found at	4384	time of this writing, only C<ev_io> and C<ev_timer>), to be found at
3500	L<http://github.com/brimworks/lua-ev>.	4385	L<http://github.com/brimworks/lua-ev>.
3501		4386
		4387	=item Javascript
		4388
		4389	Node.js (L<http://nodejs.org>) uses libev as the underlying event library.
		4390
		4391	=item Others
		4392
		4393	There are others, and I stopped counting.
		4394
3502	=back	4395	=back
3503		4396
3504		4397
3505	=head1 MACRO MAGIC	4398	=head1 MACRO MAGIC
3506		4399
…		…
3519	loop argument"). The C<EV_A> form is used when this is the sole argument,	4412	loop argument"). The C<EV_A> form is used when this is the sole argument,
3520	C<EV_A_> is used when other arguments are following. Example:	4413	C<EV_A_> is used when other arguments are following. Example:
3521		4414
3522	ev_unref (EV_A);	4415	ev_unref (EV_A);
3523	ev_timer_add (EV_A_ watcher);	4416	ev_timer_add (EV_A_ watcher);
3524	ev_loop (EV_A_ 0);	4417	ev_run (EV_A_ 0);
3525		4418
3526	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,	4419	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,
3527	which is often provided by the following macro.	4420	which is often provided by the following macro.
3528		4421
3529	=item C<EV_P>, C<EV_P_>	4422	=item C<EV_P>, C<EV_P_>
…		…
3542	suitable for use with C<EV_A>.	4435	suitable for use with C<EV_A>.
3543		4436
3544	=item C<EV_DEFAULT>, C<EV_DEFAULT_>	4437	=item C<EV_DEFAULT>, C<EV_DEFAULT_>
3545		4438
3546	Similar to the other two macros, this gives you the value of the default	4439	Similar to the other two macros, this gives you the value of the default
3547	loop, if multiple loops are supported ("ev loop default").	4440	loop, if multiple loops are supported ("ev loop default"). The default loop
		4441	will be initialised if it isn't already initialised.
		4442
		4443	For non-multiplicity builds, these macros do nothing, so you always have
		4444	to initialise the loop somewhere.
3548		4445
3549	=item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_>	4446	=item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_>
3550		4447
3551	Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the	4448	Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the
3552	default loop has been initialised (C<UC> == unchecked). Their behaviour	4449	default loop has been initialised (C<UC> == unchecked). Their behaviour
…		…
3569	}	4466	}
3570		4467
3571	ev_check check;	4468	ev_check check;
3572	ev_check_init (&check, check_cb);	4469	ev_check_init (&check, check_cb);
3573	ev_check_start (EV_DEFAULT_ &check);	4470	ev_check_start (EV_DEFAULT_ &check);
3574	ev_loop (EV_DEFAULT_ 0);	4471	ev_run (EV_DEFAULT_ 0);
3575		4472
3576	=head1 EMBEDDING	4473	=head1 EMBEDDING
3577		4474
3578	Libev can (and often is) directly embedded into host	4475	Libev can (and often is) directly embedded into host
3579	applications. Examples of applications that embed it include the Deliantra	4476	applications. Examples of applications that embed it include the Deliantra
…		…
3619	ev_vars.h	4516	ev_vars.h
3620	ev_wrap.h	4517	ev_wrap.h
3621		4518
3622	ev_win32.c required on win32 platforms only	4519	ev_win32.c required on win32 platforms only
3623		4520
3624	ev_select.c only when select backend is enabled (which is enabled by default)	4521	ev_select.c only when select backend is enabled
3625	ev_poll.c only when poll backend is enabled (disabled by default)	4522	ev_poll.c only when poll backend is enabled
3626	ev_epoll.c only when the epoll backend is enabled (disabled by default)	4523	ev_epoll.c only when the epoll backend is enabled
		4524	ev_linuxaio.c only when the linux aio backend is enabled
		4525	ev_iouring.c only when the linux io_uring backend is enabled
3627	ev_kqueue.c only when the kqueue backend is enabled (disabled by default)	4526	ev_kqueue.c only when the kqueue backend is enabled
3628	ev_port.c only when the solaris port backend is enabled (disabled by default)	4527	ev_port.c only when the solaris port backend is enabled
3629		4528
3630	F<ev.c> includes the backend files directly when enabled, so you only need	4529	F<ev.c> includes the backend files directly when enabled, so you only need
3631	to compile this single file.	4530	to compile this single file.
3632		4531
3633	=head3 LIBEVENT COMPATIBILITY API	4532	=head3 LIBEVENT COMPATIBILITY API
…		…
3671	users of libev and the libev code itself must be compiled with compatible	4570	users of libev and the libev code itself must be compiled with compatible
3672	settings.	4571	settings.
3673		4572
3674	=over 4	4573	=over 4
3675		4574
		4575	=item EV_COMPAT3 (h)
		4576
		4577	Backwards compatibility is a major concern for libev. This is why this
		4578	release of libev comes with wrappers for the functions and symbols that
		4579	have been renamed between libev version 3 and 4.
		4580
		4581	You can disable these wrappers (to test compatibility with future
		4582	versions) by defining C<EV_COMPAT3> to C<0> when compiling your
		4583	sources. This has the additional advantage that you can drop the C<struct>
		4584	from C<struct ev_loop> declarations, as libev will provide an C<ev_loop>
		4585	typedef in that case.
		4586
		4587	In some future version, the default for C<EV_COMPAT3> will become C<0>,
		4588	and in some even more future version the compatibility code will be
		4589	removed completely.
		4590
3676	=item EV_STANDALONE (h)	4591	=item EV_STANDALONE (h)
3677		4592
3678	Must always be C<1> if you do not use autoconf configuration, which	4593	Must always be C<1> if you do not use autoconf configuration, which
3679	keeps libev from including F<config.h>, and it also defines dummy	4594	keeps libev from including F<config.h>, and it also defines dummy
3680	implementations for some libevent functions (such as logging, which is not	4595	implementations for some libevent functions (such as logging, which is not
3681	supported). It will also not define any of the structs usually found in	4596	supported). It will also not define any of the structs usually found in
3682	F<event.h> that are not directly supported by the libev core alone.	4597	F<event.h> that are not directly supported by the libev core alone.
3683		4598
3684	In standalone mode, libev will still try to automatically deduce the	4599	In standalone mode, libev will still try to automatically deduce the
3685	configuration, but has to be more conservative.	4600	configuration, but has to be more conservative.
		4601
		4602	=item EV_USE_FLOOR
		4603
		4604	If defined to be C<1>, libev will use the C<floor ()> function for its
		4605	periodic reschedule calculations, otherwise libev will fall back on a
		4606	portable (slower) implementation. If you enable this, you usually have to
		4607	link against libm or something equivalent. Enabling this when the C<floor>
		4608	function is not available will fail, so the safe default is to not enable
		4609	this.
3686		4610
3687	=item EV_USE_MONOTONIC	4611	=item EV_USE_MONOTONIC
3688		4612
3689	If defined to be C<1>, libev will try to detect the availability of the	4613	If defined to be C<1>, libev will try to detect the availability of the
3690	monotonic clock option at both compile time and runtime. Otherwise no	4614	monotonic clock option at both compile time and runtime. Otherwise no
…		…
3727	available and will probe for kernel support at runtime. This will improve	4651	available and will probe for kernel support at runtime. This will improve
3728	C<ev_signal> and C<ev_async> performance and reduce resource consumption.	4652	C<ev_signal> and C<ev_async> performance and reduce resource consumption.
3729	If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc	4653	If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
3730	2.7 or newer, otherwise disabled.	4654	2.7 or newer, otherwise disabled.
3731		4655
		4656	=item EV_USE_SIGNALFD
		4657
		4658	If defined to be C<1>, then libev will assume that C<signalfd ()> is
		4659	available and will probe for kernel support at runtime. This enables
		4660	the use of EVFLAG_SIGNALFD for faster and simpler signal handling. If
		4661	undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
		4662	2.7 or newer, otherwise disabled.
		4663
		4664	=item EV_USE_TIMERFD
		4665
		4666	If defined to be C<1>, then libev will assume that C<timerfd ()> is
		4667	available and will probe for kernel support at runtime. This allows
		4668	libev to detect time jumps accurately. If undefined, it will be enabled
		4669	if the headers indicate GNU/Linux + Glibc 2.8 or newer and define
		4670	C<TFD_TIMER_CANCEL_ON_SET>, otherwise disabled.
		4671
		4672	=item EV_USE_EVENTFD
		4673
		4674	If defined to be C<1>, then libev will assume that C<eventfd ()> is
		4675	available and will probe for kernel support at runtime. This will improve
		4676	C<ev_signal> and C<ev_async> performance and reduce resource consumption.
		4677	If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
		4678	2.7 or newer, otherwise disabled.
		4679
3732	=item EV_USE_SELECT	4680	=item EV_USE_SELECT
3733		4681
3734	If undefined or defined to be C<1>, libev will compile in support for the	4682	If undefined or defined to be C<1>, libev will compile in support for the
3735	C<select>(2) backend. No attempt at auto-detection will be done: if no	4683	C<select>(2) backend. No attempt at auto-detection will be done: if no
3736	other method takes over, select will be it. Otherwise the select backend	4684	other method takes over, select will be it. Otherwise the select backend
…		…
3776	If programs implement their own fd to handle mapping on win32, then this	4724	If programs implement their own fd to handle mapping on win32, then this
3777	macro can be used to override the C<close> function, useful to unregister	4725	macro can be used to override the C<close> function, useful to unregister
3778	file descriptors again. Note that the replacement function has to close	4726	file descriptors again. Note that the replacement function has to close
3779	the underlying OS handle.	4727	the underlying OS handle.
3780		4728
		4729	=item EV_USE_WSASOCKET
		4730
		4731	If defined to be C<1>, libev will use C<WSASocket> to create its internal
		4732	communication socket, which works better in some environments. Otherwise,
		4733	the normal C<socket> function will be used, which works better in other
		4734	environments.
		4735
3781	=item EV_USE_POLL	4736	=item EV_USE_POLL
3782		4737
3783	If defined to be C<1>, libev will compile in support for the C<poll>(2)	4738	If defined to be C<1>, libev will compile in support for the C<poll>(2)
3784	backend. Otherwise it will be enabled on non-win32 platforms. It	4739	backend. Otherwise it will be enabled on non-win32 platforms. It
3785	takes precedence over select.	4740	takes precedence over select.
…		…
3789	If defined to be C<1>, libev will compile in support for the Linux	4744	If defined to be C<1>, libev will compile in support for the Linux
3790	C<epoll>(7) backend. Its availability will be detected at runtime,	4745	C<epoll>(7) backend. Its availability will be detected at runtime,
3791	otherwise another method will be used as fallback. This is the preferred	4746	otherwise another method will be used as fallback. This is the preferred
3792	backend for GNU/Linux systems. If undefined, it will be enabled if the	4747	backend for GNU/Linux systems. If undefined, it will be enabled if the
3793	headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.	4748	headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
		4749
		4750	=item EV_USE_LINUXAIO
		4751
		4752	If defined to be C<1>, libev will compile in support for the Linux aio
		4753	backend (C<EV_USE_EPOLL> must also be enabled). If undefined, it will be
		4754	enabled on linux, otherwise disabled.
		4755
		4756	=item EV_USE_IOURING
		4757
		4758	If defined to be C<1>, libev will compile in support for the Linux
		4759	io_uring backend (C<EV_USE_EPOLL> must also be enabled). Due to it's
		4760	current limitations it has to be requested explicitly. If undefined, it
		4761	will be enabled on linux, otherwise disabled.
3794		4762
3795	=item EV_USE_KQUEUE	4763	=item EV_USE_KQUEUE
3796		4764
3797	If defined to be C<1>, libev will compile in support for the BSD style	4765	If defined to be C<1>, libev will compile in support for the BSD style
3798	C<kqueue>(2) backend. Its actual availability will be detected at runtime,	4766	C<kqueue>(2) backend. Its actual availability will be detected at runtime,
…		…
3820	If defined to be C<1>, libev will compile in support for the Linux inotify	4788	If defined to be C<1>, libev will compile in support for the Linux inotify
3821	interface to speed up C<ev_stat> watchers. Its actual availability will	4789	interface to speed up C<ev_stat> watchers. Its actual availability will
3822	be detected at runtime. If undefined, it will be enabled if the headers	4790	be detected at runtime. If undefined, it will be enabled if the headers
3823	indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.	4791	indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
3824		4792
		4793	=item EV_NO_SMP
		4794
		4795	If defined to be C<1>, libev will assume that memory is always coherent
		4796	between threads, that is, threads can be used, but threads never run on
		4797	different cpus (or different cpu cores). This reduces dependencies
		4798	and makes libev faster.
		4799
		4800	=item EV_NO_THREADS
		4801
		4802	If defined to be C<1>, libev will assume that it will never be called from
		4803	different threads (that includes signal handlers), which is a stronger
		4804	assumption than C<EV_NO_SMP>, above. This reduces dependencies and makes
		4805	libev faster.
		4806
3825	=item EV_ATOMIC_T	4807	=item EV_ATOMIC_T
3826		4808
3827	Libev requires an integer type (suitable for storing C<0> or C<1>) whose	4809	Libev requires an integer type (suitable for storing C<0> or C<1>) whose
3828	access is atomic with respect to other threads or signal contexts. No such	4810	access is atomic with respect to other threads or signal contexts. No
3829	type is easily found in the C language, so you can provide your own type	4811	such type is easily found in the C language, so you can provide your own
3830	that you know is safe for your purposes. It is used both for signal handler "locking"	4812	type that you know is safe for your purposes. It is used both for signal
3831	as well as for signal and thread safety in C<ev_async> watchers.	4813	handler "locking" as well as for signal and thread safety in C<ev_async>
		4814	watchers.
3832		4815
3833	In the absence of this define, libev will use C<sig_atomic_t volatile>	4816	In the absence of this define, libev will use C<sig_atomic_t volatile>
3834	(from F<signal.h>), which is usually good enough on most platforms.	4817	(from F<signal.h>), which is usually good enough on most platforms.
3835		4818
3836	=item EV_H (h)	4819	=item EV_H (h)
…		…
3863	will have the C<struct ev_loop *> as first argument, and you can create	4846	will have the C<struct ev_loop *> as first argument, and you can create
3864	additional independent event loops. Otherwise there will be no support	4847	additional independent event loops. Otherwise there will be no support
3865	for multiple event loops and there is no first event loop pointer	4848	for multiple event loops and there is no first event loop pointer
3866	argument. Instead, all functions act on the single default loop.	4849	argument. Instead, all functions act on the single default loop.
3867		4850
		4851	Note that C<EV_DEFAULT> and C<EV_DEFAULT_> will no longer provide a
		4852	default loop when multiplicity is switched off - you always have to
		4853	initialise the loop manually in this case.
		4854
3868	=item EV_MINPRI	4855	=item EV_MINPRI
3869		4856
3870	=item EV_MAXPRI	4857	=item EV_MAXPRI
3871		4858
3872	The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to	4859	The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to
…		…
3886	EV_PREPARE_ENABLE, EV_CHECK_ENABLE, EV_FORK_ENABLE, EV_SIGNAL_ENABLE,	4873	EV_PREPARE_ENABLE, EV_CHECK_ENABLE, EV_FORK_ENABLE, EV_SIGNAL_ENABLE,
3887	EV_ASYNC_ENABLE, EV_CHILD_ENABLE.	4874	EV_ASYNC_ENABLE, EV_CHILD_ENABLE.
3888		4875
3889	If undefined or defined to be C<1> (and the platform supports it), then	4876	If undefined or defined to be C<1> (and the platform supports it), then
3890	the respective watcher type is supported. If defined to be C<0>, then it	4877	the respective watcher type is supported. If defined to be C<0>, then it
3891	is not. Disabling watcher types mainly saves codesize.	4878	is not. Disabling watcher types mainly saves code size.
3892		4879
3893	=item EV_FEATURES	4880	=item EV_FEATURES
3894		4881
3895	If you need to shave off some kilobytes of code at the expense of some	4882	If you need to shave off some kilobytes of code at the expense of some
3896	speed (but with the full API), you can define this symbol to request	4883	speed (but with the full API), you can define this symbol to request
…		…
3908	#define EV_USE_POLL 1	4895	#define EV_USE_POLL 1
3909	#define EV_CHILD_ENABLE 1	4896	#define EV_CHILD_ENABLE 1
3910	#define EV_ASYNC_ENABLE 1	4897	#define EV_ASYNC_ENABLE 1
3911		4898
3912	The actual value is a bitset, it can be a combination of the following	4899	The actual value is a bitset, it can be a combination of the following
3913	values:	4900	values (by default, all of these are enabled):
3914		4901
3915	=over 4	4902	=over 4
3916		4903
3917	=item C<1> - faster/larger code	4904	=item C<1> - faster/larger code
3918		4905
3919	Use larger code to speed up some operations.	4906	Use larger code to speed up some operations.
3920		4907
3921	Currently this is used to override some inlining decisions (enlarging the roughly	4908	Currently this is used to override some inlining decisions (enlarging the
3922	30% code size on amd64.	4909	code size by roughly 30% on amd64).
3923		4910
3924	When optimising for size, use of compiler flags such as C<-Os> with	4911	When optimising for size, use of compiler flags such as C<-Os> with
3925	gcc recommended, as well as C<-DNDEBUG>, as libev contains a number of	4912	gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of
3926	assertions.	4913	assertions.
3927		4914
		4915	The default is off when C<__OPTIMIZE_SIZE__> is defined by your compiler
		4916	(e.g. gcc with C<-Os>).
		4917
3928	=item C<2> - faster/larger data structures	4918	=item C<2> - faster/larger data structures
3929		4919
3930	Replaces the small 2-heap for timer management by a faster 4-heap, larger	4920	Replaces the small 2-heap for timer management by a faster 4-heap, larger
3931	hash table sizes and so on. This will usually further increase codesize	4921	hash table sizes and so on. This will usually further increase code size
3932	and can additionally have an effect on the size of data structures at	4922	and can additionally have an effect on the size of data structures at
3933	runtime.	4923	runtime.
		4924
		4925	The default is off when C<__OPTIMIZE_SIZE__> is defined by your compiler
		4926	(e.g. gcc with C<-Os>).
3934		4927
3935	=item C<4> - full API configuration	4928	=item C<4> - full API configuration
3936		4929
3937	This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and	4930	This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and
3938	enables multiplicity (C<EV_MULTIPLICITY>=1).	4931	enables multiplicity (C<EV_MULTIPLICITY>=1).
…		…
3970	With an intelligent-enough linker (gcc+binutils are intelligent enough	4963	With an intelligent-enough linker (gcc+binutils are intelligent enough
3971	when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by	4964	when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by
3972	your program might be left out as well - a binary starting a timer and an	4965	your program might be left out as well - a binary starting a timer and an
3973	I/O watcher then might come out at only 5Kb.	4966	I/O watcher then might come out at only 5Kb.
3974		4967
		4968	=item EV_API_STATIC
		4969
		4970	If this symbol is defined (by default it is not), then all identifiers
		4971	will have static linkage. This means that libev will not export any
		4972	identifiers, and you cannot link against libev anymore. This can be useful
		4973	when you embed libev, only want to use libev functions in a single file,
		4974	and do not want its identifiers to be visible.
		4975
		4976	To use this, define C<EV_API_STATIC> and include F<ev.c> in the file that
		4977	wants to use libev.
		4978
		4979	This option only works when libev is compiled with a C compiler, as C++
		4980	doesn't support the required declaration syntax.
		4981
3975	=item EV_AVOID_STDIO	4982	=item EV_AVOID_STDIO
3976		4983
3977	If this is set to C<1> at compiletime, then libev will avoid using stdio	4984	If this is set to C<1> at compiletime, then libev will avoid using stdio
3978	functions (printf, scanf, perror etc.). This will increase the codesize	4985	functions (printf, scanf, perror etc.). This will increase the code size
3979	somewhat, but if your program doesn't otherwise depend on stdio and your	4986	somewhat, but if your program doesn't otherwise depend on stdio and your
3980	libc allows it, this avoids linking in the stdio library which is quite	4987	libc allows it, this avoids linking in the stdio library which is quite
3981	big.	4988	big.
3982		4989
3983	Note that error messages might become less precise when this option is	4990	Note that error messages might become less precise when this option is
…		…
3987		4994
3988	The highest supported signal number, +1 (or, the number of	4995	The highest supported signal number, +1 (or, the number of
3989	signals): Normally, libev tries to deduce the maximum number of signals	4996	signals): Normally, libev tries to deduce the maximum number of signals
3990	automatically, but sometimes this fails, in which case it can be	4997	automatically, but sometimes this fails, in which case it can be
3991	specified. Also, using a lower number than detected (C<32> should be	4998	specified. Also, using a lower number than detected (C<32> should be
3992	good for about any system in existance) can save some memory, as libev	4999	good for about any system in existence) can save some memory, as libev
3993	statically allocates some 12-24 bytes per signal number.	5000	statically allocates some 12-24 bytes per signal number.
3994		5001
3995	=item EV_PID_HASHSIZE	5002	=item EV_PID_HASHSIZE
3996		5003
3997	C<ev_child> watchers use a small hash table to distribute workload by	5004	C<ev_child> watchers use a small hash table to distribute workload by
…		…
4029	The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it	5036	The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
4030	will be C<0>.	5037	will be C<0>.
4031		5038
4032	=item EV_VERIFY	5039	=item EV_VERIFY
4033		5040
4034	Controls how much internal verification (see C<ev_loop_verify ()>) will	5041	Controls how much internal verification (see C<ev_verify ()>) will
4035	be done: If set to C<0>, no internal verification code will be compiled	5042	be done: If set to C<0>, no internal verification code will be compiled
4036	in. If set to C<1>, then verification code will be compiled in, but not	5043	in. If set to C<1>, then verification code will be compiled in, but not
4037	called. If set to C<2>, then the internal verification code will be	5044	called. If set to C<2>, then the internal verification code will be
4038	called once per loop, which can slow down libev. If set to C<3>, then the	5045	called once per loop, which can slow down libev. If set to C<3>, then the
4039	verification code will be called very frequently, which will slow down	5046	verification code will be called very frequently, which will slow down
4040	libev considerably.	5047	libev considerably.
4041		5048
		5049	Verification errors are reported via C's C<assert> mechanism, so if you
		5050	disable that (e.g. by defining C<NDEBUG>) then no errors will be reported.
		5051
4042	The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it	5052	The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
4043	will be C<0>.	5053	will be C<0>.
4044		5054
4045	=item EV_COMMON	5055	=item EV_COMMON
4046		5056
4047	By default, all watchers have a C<void *data> member. By redefining	5057	By default, all watchers have a C<void *data> member. By redefining
4048	this macro to a something else you can include more and other types of	5058	this macro to something else you can include more and other types of
4049	members. You have to define it each time you include one of the files,	5059	members. You have to define it each time you include one of the files,
4050	though, and it must be identical each time.	5060	though, and it must be identical each time.
4051		5061
4052	For example, the perl EV module uses something like this:	5062	For example, the perl EV module uses something like this:
4053		5063
…		…
4122	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:	5132	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
4123		5133
4124	#include "ev_cpp.h"	5134	#include "ev_cpp.h"
4125	#include "ev.c"	5135	#include "ev.c"
4126		5136
4127	=head1 INTERACTION WITH OTHER PROGRAMS OR LIBRARIES	5137	=head1 INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT
4128		5138
4129	=head2 THREADS AND COROUTINES	5139	=head2 THREADS AND COROUTINES
4130		5140
4131	=head3 THREADS	5141	=head3 THREADS
4132		5142
…		…
4183	default loop and triggering an C<ev_async> watcher from the default loop	5193	default loop and triggering an C<ev_async> watcher from the default loop
4184	watcher callback into the event loop interested in the signal.	5194	watcher callback into the event loop interested in the signal.
4185		5195
4186	=back	5196	=back
4187		5197
4188	=head4 THREAD LOCKING EXAMPLE	5198	See also L</THREAD LOCKING EXAMPLE>.
4189
4190	Here is a fictitious example of how to run an event loop in a different
4191	thread than where callbacks are being invoked and watchers are
4192	created/added/removed.
4193
4194	For a real-world example, see the C<EV::Loop::Async> perl module,
4195	which uses exactly this technique (which is suited for many high-level
4196	languages).
4197
4198	The example uses a pthread mutex to protect the loop data, a condition
4199	variable to wait for callback invocations, an async watcher to notify the
4200	event loop thread and an unspecified mechanism to wake up the main thread.
4201
4202	First, you need to associate some data with the event loop:
4203
4204	typedef struct {
4205	mutex_t lock; /* global loop lock */
4206	ev_async async_w;
4207	thread_t tid;
4208	cond_t invoke_cv;
4209	} userdata;
4210
4211	void prepare_loop (EV_P)
4212	{
4213	// for simplicity, we use a static userdata struct.
4214	static userdata u;
4215
4216	ev_async_init (&u->async_w, async_cb);
4217	ev_async_start (EV_A_ &u->async_w);
4218
4219	pthread_mutex_init (&u->lock, 0);
4220	pthread_cond_init (&u->invoke_cv, 0);
4221
4222	// now associate this with the loop
4223	ev_set_userdata (EV_A_ u);
4224	ev_set_invoke_pending_cb (EV_A_ l_invoke);
4225	ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
4226
4227	// then create the thread running ev_loop
4228	pthread_create (&u->tid, 0, l_run, EV_A);
4229	}
4230
4231	The callback for the C<ev_async> watcher does nothing: the watcher is used
4232	solely to wake up the event loop so it takes notice of any new watchers
4233	that might have been added:
4234
4235	static void
4236	async_cb (EV_P_ ev_async *w, int revents)
4237	{
4238	// just used for the side effects
4239	}
4240
4241	The C<l_release> and C<l_acquire> callbacks simply unlock/lock the mutex
4242	protecting the loop data, respectively.
4243
4244	static void
4245	l_release (EV_P)
4246	{
4247	userdata *u = ev_userdata (EV_A);
4248	pthread_mutex_unlock (&u->lock);
4249	}
4250
4251	static void
4252	l_acquire (EV_P)
4253	{
4254	userdata *u = ev_userdata (EV_A);
4255	pthread_mutex_lock (&u->lock);
4256	}
4257
4258	The event loop thread first acquires the mutex, and then jumps straight
4259	into C<ev_loop>:
4260
4261	void *
4262	l_run (void *thr_arg)
4263	{
4264	struct ev_loop *loop = (struct ev_loop *)thr_arg;
4265
4266	l_acquire (EV_A);
4267	pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
4268	ev_loop (EV_A_ 0);
4269	l_release (EV_A);
4270
4271	return 0;
4272	}
4273
4274	Instead of invoking all pending watchers, the C<l_invoke> callback will
4275	signal the main thread via some unspecified mechanism (signals? pipe
4276	writes? C<Async::Interrupt>?) and then waits until all pending watchers
4277	have been called (in a while loop because a) spurious wakeups are possible
4278	and b) skipping inter-thread-communication when there are no pending
4279	watchers is very beneficial):
4280
4281	static void
4282	l_invoke (EV_P)
4283	{
4284	userdata *u = ev_userdata (EV_A);
4285
4286	while (ev_pending_count (EV_A))
4287	{
4288	wake_up_other_thread_in_some_magic_or_not_so_magic_way ();
4289	pthread_cond_wait (&u->invoke_cv, &u->lock);
4290	}
4291	}
4292
4293	Now, whenever the main thread gets told to invoke pending watchers, it
4294	will grab the lock, call C<ev_invoke_pending> and then signal the loop
4295	thread to continue:
4296
4297	static void
4298	real_invoke_pending (EV_P)
4299	{
4300	userdata *u = ev_userdata (EV_A);
4301
4302	pthread_mutex_lock (&u->lock);
4303	ev_invoke_pending (EV_A);
4304	pthread_cond_signal (&u->invoke_cv);
4305	pthread_mutex_unlock (&u->lock);
4306	}
4307
4308	Whenever you want to start/stop a watcher or do other modifications to an
4309	event loop, you will now have to lock:
4310
4311	ev_timer timeout_watcher;
4312	userdata *u = ev_userdata (EV_A);
4313
4314	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
4315
4316	pthread_mutex_lock (&u->lock);
4317	ev_timer_start (EV_A_ &timeout_watcher);
4318	ev_async_send (EV_A_ &u->async_w);
4319	pthread_mutex_unlock (&u->lock);
4320
4321	Note that sending the C<ev_async> watcher is required because otherwise
4322	an event loop currently blocking in the kernel will have no knowledge
4323	about the newly added timer. By waking up the loop it will pick up any new
4324	watchers in the next event loop iteration.
4325		5199
4326	=head3 COROUTINES	5200	=head3 COROUTINES
4327		5201
4328	Libev is very accommodating to coroutines ("cooperative threads"):	5202	Libev is very accommodating to coroutines ("cooperative threads"):
4329	libev fully supports nesting calls to its functions from different	5203	libev fully supports nesting calls to its functions from different
4330	coroutines (e.g. you can call C<ev_loop> on the same loop from two	5204	coroutines (e.g. you can call C<ev_run> on the same loop from two
4331	different coroutines, and switch freely between both coroutines running	5205	different coroutines, and switch freely between both coroutines running
4332	the loop, as long as you don't confuse yourself). The only exception is	5206	the loop, as long as you don't confuse yourself). The only exception is
4333	that you must not do this from C<ev_periodic> reschedule callbacks.	5207	that you must not do this from C<ev_periodic> reschedule callbacks.
4334		5208
4335	Care has been taken to ensure that libev does not keep local state inside	5209	Care has been taken to ensure that libev does not keep local state inside
4336	C<ev_loop>, and other calls do not usually allow for coroutine switches as	5210	C<ev_run>, and other calls do not usually allow for coroutine switches as
4337	they do not call any callbacks.	5211	they do not call any callbacks.
4338		5212
4339	=head2 COMPILER WARNINGS	5213	=head2 COMPILER WARNINGS
4340		5214
4341	Depending on your compiler and compiler settings, you might get no or a	5215	Depending on your compiler and compiler settings, you might get no or a
…		…
4352	maintainable.	5226	maintainable.
4353		5227
4354	And of course, some compiler warnings are just plain stupid, or simply	5228	And of course, some compiler warnings are just plain stupid, or simply
4355	wrong (because they don't actually warn about the condition their message	5229	wrong (because they don't actually warn about the condition their message
4356	seems to warn about). For example, certain older gcc versions had some	5230	seems to warn about). For example, certain older gcc versions had some
4357	warnings that resulted an extreme number of false positives. These have	5231	warnings that resulted in an extreme number of false positives. These have
4358	been fixed, but some people still insist on making code warn-free with	5232	been fixed, but some people still insist on making code warn-free with
4359	such buggy versions.	5233	such buggy versions.
4360		5234
4361	While libev is written to generate as few warnings as possible,	5235	While libev is written to generate as few warnings as possible,
4362	"warn-free" code is not a goal, and it is recommended not to build libev	5236	"warn-free" code is not a goal, and it is recommended not to build libev
…		…
4398	I suggest using suppression lists.	5272	I suggest using suppression lists.
4399		5273
4400		5274
4401	=head1 PORTABILITY NOTES	5275	=head1 PORTABILITY NOTES
4402		5276
		5277	=head2 GNU/LINUX 32 BIT LIMITATIONS
		5278
		5279	GNU/Linux is the only common platform that supports 64 bit file/large file
		5280	interfaces but I<disables> them by default.
		5281
		5282	That means that libev compiled in the default environment doesn't support
		5283	files larger than 2GiB or so, which mainly affects C<ev_stat> watchers.
		5284
		5285	Unfortunately, many programs try to work around this GNU/Linux issue
		5286	by enabling the large file API, which makes them incompatible with the
		5287	standard libev compiled for their system.
		5288
		5289	Likewise, libev cannot enable the large file API itself as this would
		5290	suddenly make it incompatible to the default compile time environment,
		5291	i.e. all programs not using special compile switches.
		5292
		5293	=head2 OS/X AND DARWIN BUGS
		5294
		5295	The whole thing is a bug if you ask me - basically any system interface
		5296	you touch is broken, whether it is locales, poll, kqueue or even the
		5297	OpenGL drivers.
		5298
		5299	=head3 C<kqueue> is buggy
		5300
		5301	The kqueue syscall is broken in all known versions - most versions support
		5302	only sockets, many support pipes.
		5303
		5304	Libev tries to work around this by not using C<kqueue> by default on this
		5305	rotten platform, but of course you can still ask for it when creating a
		5306	loop - embedding a socket-only kqueue loop into a select-based one is
		5307	probably going to work well.
		5308
		5309	=head3 C<poll> is buggy
		5310
		5311	Instead of fixing C<kqueue>, Apple replaced their (working) C<poll>
		5312	implementation by something calling C<kqueue> internally around the 10.5.6
		5313	release, so now C<kqueue> I<and> C<poll> are broken.
		5314
		5315	Libev tries to work around this by not using C<poll> by default on
		5316	this rotten platform, but of course you can still ask for it when creating
		5317	a loop.
		5318
		5319	=head3 C<select> is buggy
		5320
		5321	All that's left is C<select>, and of course Apple found a way to fuck this
		5322	one up as well: On OS/X, C<select> actively limits the number of file
		5323	descriptors you can pass in to 1024 - your program suddenly crashes when
		5324	you use more.
		5325
		5326	There is an undocumented "workaround" for this - defining
		5327	C<_DARWIN_UNLIMITED_SELECT>, which libev tries to use, so select I<should>
		5328	work on OS/X.
		5329
		5330	=head2 SOLARIS PROBLEMS AND WORKAROUNDS
		5331
		5332	=head3 C<errno> reentrancy
		5333
		5334	The default compile environment on Solaris is unfortunately so
		5335	thread-unsafe that you can't even use components/libraries compiled
		5336	without C<-D_REENTRANT> in a threaded program, which, of course, isn't
		5337	defined by default. A valid, if stupid, implementation choice.
		5338
		5339	If you want to use libev in threaded environments you have to make sure
		5340	it's compiled with C<_REENTRANT> defined.
		5341
		5342	=head3 Event port backend
		5343
		5344	The scalable event interface for Solaris is called "event
		5345	ports". Unfortunately, this mechanism is very buggy in all major
		5346	releases. If you run into high CPU usage, your program freezes or you get
		5347	a large number of spurious wakeups, make sure you have all the relevant
		5348	and latest kernel patches applied. No, I don't know which ones, but there
		5349	are multiple ones to apply, and afterwards, event ports actually work
		5350	great.
		5351
		5352	If you can't get it to work, you can try running the program by setting
		5353	the environment variable C<LIBEV_FLAGS=3> to only allow C<poll> and
		5354	C<select> backends.
		5355
		5356	=head2 AIX POLL BUG
		5357
		5358	AIX unfortunately has a broken C<poll.h> header. Libev works around
		5359	this by trying to avoid the poll backend altogether (i.e. it's not even
		5360	compiled in), which normally isn't a big problem as C<select> works fine
		5361	with large bitsets on AIX, and AIX is dead anyway.
		5362
4403	=head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS	5363	=head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS
		5364
		5365	=head3 General issues
4404		5366
4405	Win32 doesn't support any of the standards (e.g. POSIX) that libev	5367	Win32 doesn't support any of the standards (e.g. POSIX) that libev
4406	requires, and its I/O model is fundamentally incompatible with the POSIX	5368	requires, and its I/O model is fundamentally incompatible with the POSIX
4407	model. Libev still offers limited functionality on this platform in	5369	model. Libev still offers limited functionality on this platform in
4408	the form of the C<EVBACKEND_SELECT> backend, and only supports socket	5370	the form of the C<EVBACKEND_SELECT> backend, and only supports socket
4409	descriptors. This only applies when using Win32 natively, not when using	5371	descriptors. This only applies when using Win32 natively, not when using
4410	e.g. cygwin.	5372	e.g. cygwin. Actually, it only applies to the microsofts own compilers,
		5373	as every compiler comes with a slightly differently broken/incompatible
		5374	environment.
4411		5375
4412	Lifting these limitations would basically require the full	5376	Lifting these limitations would basically require the full
4413	re-implementation of the I/O system. If you are into these kinds of	5377	re-implementation of the I/O system. If you are into this kind of thing,
4414	things, then note that glib does exactly that for you in a very portable	5378	then note that glib does exactly that for you in a very portable way (note
4415	way (note also that glib is the slowest event library known to man).	5379	also that glib is the slowest event library known to man).
4416		5380
4417	There is no supported compilation method available on windows except	5381	There is no supported compilation method available on windows except
4418	embedding it into other applications.	5382	embedding it into other applications.
4419		5383
4420	Sensible signal handling is officially unsupported by Microsoft - libev	5384	Sensible signal handling is officially unsupported by Microsoft - libev
…		…
4448	you do I<not> compile the F<ev.c> or any other embedded source files!):	5412	you do I<not> compile the F<ev.c> or any other embedded source files!):
4449		5413
4450	#include "evwrap.h"	5414	#include "evwrap.h"
4451	#include "ev.c"	5415	#include "ev.c"
4452		5416
4453	=over 4
4454
4455	=item The winsocket select function	5417	=head3 The winsocket C<select> function
4456		5418
4457	The winsocket C<select> function doesn't follow POSIX in that it	5419	The winsocket C<select> function doesn't follow POSIX in that it
4458	requires socket I<handles> and not socket I<file descriptors> (it is	5420	requires socket I<handles> and not socket I<file descriptors> (it is
4459	also extremely buggy). This makes select very inefficient, and also	5421	also extremely buggy). This makes select very inefficient, and also
4460	requires a mapping from file descriptors to socket handles (the Microsoft	5422	requires a mapping from file descriptors to socket handles (the Microsoft
…		…
4469	#define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */	5431	#define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */
4470		5432
4471	Note that winsockets handling of fd sets is O(n), so you can easily get a	5433	Note that winsockets handling of fd sets is O(n), so you can easily get a
4472	complexity in the O(n²) range when using win32.	5434	complexity in the O(n²) range when using win32.
4473		5435
4474	=item Limited number of file descriptors	5436	=head3 Limited number of file descriptors
4475		5437
4476	Windows has numerous arbitrary (and low) limits on things.	5438	Windows has numerous arbitrary (and low) limits on things.
4477		5439
4478	Early versions of winsocket's select only supported waiting for a maximum	5440	Early versions of winsocket's select only supported waiting for a maximum
4479	of C<64> handles (probably owning to the fact that all windows kernels	5441	of C<64> handles (probably owning to the fact that all windows kernels
…		…
4494	runtime libraries. This might get you to about C<512> or C<2048> sockets	5456	runtime libraries. This might get you to about C<512> or C<2048> sockets
4495	(depending on windows version and/or the phase of the moon). To get more,	5457	(depending on windows version and/or the phase of the moon). To get more,
4496	you need to wrap all I/O functions and provide your own fd management, but	5458	you need to wrap all I/O functions and provide your own fd management, but
4497	the cost of calling select (O(n²)) will likely make this unworkable.	5459	the cost of calling select (O(n²)) will likely make this unworkable.
4498		5460
4499	=back
4500
4501	=head2 PORTABILITY REQUIREMENTS	5461	=head2 PORTABILITY REQUIREMENTS
4502		5462
4503	In addition to a working ISO-C implementation and of course the	5463	In addition to a working ISO-C implementation and of course the
4504	backend-specific APIs, libev relies on a few additional extensions:	5464	backend-specific APIs, libev relies on a few additional extensions:
4505		5465
…		…
4511	Libev assumes not only that all watcher pointers have the same internal	5471	Libev assumes not only that all watcher pointers have the same internal
4512	structure (guaranteed by POSIX but not by ISO C for example), but it also	5472	structure (guaranteed by POSIX but not by ISO C for example), but it also
4513	assumes that the same (machine) code can be used to call any watcher	5473	assumes that the same (machine) code can be used to call any watcher
4514	callback: The watcher callbacks have different type signatures, but libev	5474	callback: The watcher callbacks have different type signatures, but libev
4515	calls them using an C<ev_watcher *> internally.	5475	calls them using an C<ev_watcher *> internally.
		5476
		5477	=item null pointers and integer zero are represented by 0 bytes
		5478
		5479	Libev uses C<memset> to initialise structs and arrays to C<0> bytes, and
		5480	relies on this setting pointers and integers to null.
		5481
		5482	=item pointer accesses must be thread-atomic
		5483
		5484	Accessing a pointer value must be atomic, it must both be readable and
		5485	writable in one piece - this is the case on all current architectures.
4516		5486
4517	=item C<sig_atomic_t volatile> must be thread-atomic as well	5487	=item C<sig_atomic_t volatile> must be thread-atomic as well
4518		5488
4519	The type C<sig_atomic_t volatile> (or whatever is defined as	5489	The type C<sig_atomic_t volatile> (or whatever is defined as
4520	C<EV_ATOMIC_T>) must be atomic with respect to accesses from different	5490	C<EV_ATOMIC_T>) must be atomic with respect to accesses from different
…		…
4529	thread" or will block signals process-wide, both behaviours would	5499	thread" or will block signals process-wide, both behaviours would
4530	be compatible with libev. Interaction between C<sigprocmask> and	5500	be compatible with libev. Interaction between C<sigprocmask> and
4531	C<pthread_sigmask> could complicate things, however.	5501	C<pthread_sigmask> could complicate things, however.
4532		5502
4533	The most portable way to handle signals is to block signals in all threads	5503	The most portable way to handle signals is to block signals in all threads
4534	except the initial one, and run the default loop in the initial thread as	5504	except the initial one, and run the signal handling loop in the initial
4535	well.	5505	thread as well.
4536		5506
4537	=item C<long> must be large enough for common memory allocation sizes	5507	=item C<long> must be large enough for common memory allocation sizes
4538		5508
4539	To improve portability and simplify its API, libev uses C<long> internally	5509	To improve portability and simplify its API, libev uses C<long> internally
4540	instead of C<size_t> when allocating its data structures. On non-POSIX	5510	instead of C<size_t> when allocating its data structures. On non-POSIX
…		…
4543	watchers.	5513	watchers.
4544		5514
4545	=item C<double> must hold a time value in seconds with enough accuracy	5515	=item C<double> must hold a time value in seconds with enough accuracy
4546		5516
4547	The type C<double> is used to represent timestamps. It is required to	5517	The type C<double> is used to represent timestamps. It is required to
4548	have at least 51 bits of mantissa (and 9 bits of exponent), which is good	5518	have at least 51 bits of mantissa (and 9 bits of exponent), which is
4549	enough for at least into the year 4000. This requirement is fulfilled by	5519	good enough for at least into the year 4000 with millisecond accuracy
		5520	(the design goal for libev). This requirement is overfulfilled by
4550	implementations implementing IEEE 754, which is basically all existing	5521	implementations using IEEE 754, which is basically all existing ones.
		5522
4551	ones. With IEEE 754 doubles, you get microsecond accuracy until at least	5523	With IEEE 754 doubles, you get microsecond accuracy until at least the
4552	2200.	5524	year 2255 (and millisecond accuracy till the year 287396 - by then, libev
		5525	is either obsolete or somebody patched it to use C<long double> or
		5526	something like that, just kidding).
4553		5527
4554	=back	5528	=back
4555		5529
4556	If you know of other additional requirements drop me a note.	5530	If you know of other additional requirements drop me a note.
4557		5531
…		…
4619	=item Processing ev_async_send: O(number_of_async_watchers)	5593	=item Processing ev_async_send: O(number_of_async_watchers)
4620		5594
4621	=item Processing signals: O(max_signal_number)	5595	=item Processing signals: O(max_signal_number)
4622		5596
4623	Sending involves a system call I<iff> there were no other C<ev_async_send>	5597	Sending involves a system call I<iff> there were no other C<ev_async_send>
4624	calls in the current loop iteration. Checking for async and signal events	5598	calls in the current loop iteration and the loop is currently
		5599	blocked. Checking for async and signal events involves iterating over all
4625	involves iterating over all running async watchers or all signal numbers.	5600	running async watchers or all signal numbers.
4626		5601
4627	=back	5602	=back
4628		5603
4629		5604
4630	=head1 PORTING FROM LIBEV 3.X TO 4.X	5605	=head1 PORTING FROM LIBEV 3.X TO 4.X
4631		5606
4632	The major version 4 introduced some minor incompatible changes to the API.	5607	The major version 4 introduced some incompatible changes to the API.
4633		5608
4634	At the moment, the C<ev.h> header file tries to implement superficial	5609	At the moment, the C<ev.h> header file provides compatibility definitions
4635	compatibility, so most programs should still compile. Those might be	5610	for all changes, so most programs should still compile. The compatibility
4636	removed in later versions of libev, so better update early than late.	5611	layer might be removed in later versions of libev, so better update to the
		5612	new API early than late.
4637		5613
4638	=over 4	5614	=over 4
4639		5615
4640	=item C<ev_loop_count> renamed to C<ev_iteration>	5616	=item C<EV_COMPAT3> backwards compatibility mechanism
4641		5617
4642	=item C<ev_loop_depth> renamed to C<ev_depth>	5618	The backward compatibility mechanism can be controlled by
		5619	C<EV_COMPAT3>. See L</"PREPROCESSOR SYMBOLS/MACROS"> in the L</EMBEDDING>
		5620	section.
4643		5621
4644	=item C<ev_loop_verify> renamed to C<ev_verify>	5622	=item C<ev_default_destroy> and C<ev_default_fork> have been removed
		5623
		5624	These calls can be replaced easily by their C<ev_loop_xxx> counterparts:
		5625
		5626	ev_loop_destroy (EV_DEFAULT_UC);
		5627	ev_loop_fork (EV_DEFAULT);
		5628
		5629	=item function/symbol renames
		5630
		5631	A number of functions and symbols have been renamed:
		5632
		5633	ev_loop => ev_run
		5634	EVLOOP_NONBLOCK => EVRUN_NOWAIT
		5635	EVLOOP_ONESHOT => EVRUN_ONCE
		5636
		5637	ev_unloop => ev_break
		5638	EVUNLOOP_CANCEL => EVBREAK_CANCEL
		5639	EVUNLOOP_ONE => EVBREAK_ONE
		5640	EVUNLOOP_ALL => EVBREAK_ALL
		5641
		5642	EV_TIMEOUT => EV_TIMER
		5643
		5644	ev_loop_count => ev_iteration
		5645	ev_loop_depth => ev_depth
		5646	ev_loop_verify => ev_verify
4645		5647
4646	Most functions working on C<struct ev_loop> objects don't have an	5648	Most functions working on C<struct ev_loop> objects don't have an
4647	C<ev_loop_> prefix, so it was removed. Note that C<ev_loop_fork> is	5649	C<ev_loop_> prefix, so it was removed; C<ev_loop>, C<ev_unloop> and
		5650	associated constants have been renamed to not collide with the C<struct
		5651	ev_loop> anymore and C<EV_TIMER> now follows the same naming scheme
		5652	as all other watcher types. Note that C<ev_loop_fork> is still called
4648	still called C<ev_loop_fork> because it would otherwise clash with the	5653	C<ev_loop_fork> because it would otherwise clash with the C<ev_fork>
4649	C<ev_fork> typedef.	5654	typedef.
4650
4651	=item C<EV_TIMEOUT> renamed to C<EV_TIMER> in C<revents>
4652
4653	This is a simple rename - all other watcher types use their name
4654	as revents flag, and now C<ev_timer> does, too.
4655
4656	Both C<EV_TIMER> and C<EV_TIMEOUT> symbols were present in 3.x versions
4657	and continue to be present for the forseeable future, so this is mostly a
4658	documentation change.
4659		5655
4660	=item C<EV_MINIMAL> mechanism replaced by C<EV_FEATURES>	5656	=item C<EV_MINIMAL> mechanism replaced by C<EV_FEATURES>
4661		5657
4662	The preprocessor symbol C<EV_MINIMAL> has been replaced by a different	5658	The preprocessor symbol C<EV_MINIMAL> has been replaced by a different
4663	mechanism, C<EV_FEATURES>. Programs using C<EV_MINIMAL> usually compile	5659	mechanism, C<EV_FEATURES>. Programs using C<EV_MINIMAL> usually compile
…		…
4670		5666
4671	=over 4	5667	=over 4
4672		5668
4673	=item active	5669	=item active
4674		5670
4675	A watcher is active as long as it has been started (has been attached to	5671	A watcher is active as long as it has been started and not yet stopped.
4676	an event loop) but not yet stopped (disassociated from the event loop).	5672	See L</WATCHER STATES> for details.
4677		5673
4678	=item application	5674	=item application
4679		5675
4680	In this document, an application is whatever is using libev.	5676	In this document, an application is whatever is using libev.
		5677
		5678	=item backend
		5679
		5680	The part of the code dealing with the operating system interfaces.
4681		5681
4682	=item callback	5682	=item callback
4683		5683
4684	The address of a function that is called when some event has been	5684	The address of a function that is called when some event has been
4685	detected. Callbacks are being passed the event loop, the watcher that	5685	detected. Callbacks are being passed the event loop, the watcher that
4686	received the event, and the actual event bitset.	5686	received the event, and the actual event bitset.
4687		5687
4688	=item callback invocation	5688	=item callback/watcher invocation
4689		5689
4690	The act of calling the callback associated with a watcher.	5690	The act of calling the callback associated with a watcher.
4691		5691
4692	=item event	5692	=item event
4693		5693
…		…
4712	The model used to describe how an event loop handles and processes	5712	The model used to describe how an event loop handles and processes
4713	watchers and events.	5713	watchers and events.
4714		5714
4715	=item pending	5715	=item pending
4716		5716
4717	A watcher is pending as soon as the corresponding event has been detected,	5717	A watcher is pending as soon as the corresponding event has been
4718	and stops being pending as soon as the watcher will be invoked or its	5718	detected. See L</WATCHER STATES> for details.
4719	pending status is explicitly cleared by the application.
4720
4721	A watcher can be pending, but not active. Stopping a watcher also clears
4722	its pending status.
4723		5719
4724	=item real time	5720	=item real time
4725		5721
4726	The physical time that is observed. It is apparently strictly monotonic :)	5722	The physical time that is observed. It is apparently strictly monotonic :)
4727		5723
4728	=item wall-clock time	5724	=item wall-clock time
4729		5725
4730	The time and date as shown on clocks. Unlike real time, it can actually	5726	The time and date as shown on clocks. Unlike real time, it can actually
4731	be wrong and jump forwards and backwards, e.g. when the you adjust your	5727	be wrong and jump forwards and backwards, e.g. when you adjust your
4732	clock.	5728	clock.
4733		5729
4734	=item watcher	5730	=item watcher
4735		5731
4736	A data structure that describes interest in certain events. Watchers need	5732	A data structure that describes interest in certain events. Watchers need
4737	to be started (attached to an event loop) before they can receive events.	5733	to be started (attached to an event loop) before they can receive events.
4738		5734
4739	=item watcher invocation
4740
4741	The act of calling the callback associated with a watcher.
4742
4743	=back	5735	=back
4744		5736
4745	=head1 AUTHOR	5737	=head1 AUTHOR
4746		5738
4747	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson.	5739	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael
		5740	Magnusson and Emanuele Giaquinta, and minor corrections by many others.
4748		5741

Diff Legend

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