ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.308 by root, Thu Oct 21 02:46:59 2010 UTC vs.
Revision 1.459 by root, Wed Jan 22 01:50:42 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
…		…
78	with libev.	80	with libev.
79		81
80	Familiarity 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.
82		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>.
		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
87	these event sources and provide your program with events.	97	these event sources and provide your program with events.
…		…
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 (in practise	139	the (fractional) number of seconds since the (POSIX) epoch (in practice
130	somewhere near the beginning of 1970, details are complicated, don't	140	somewhere near the beginning of 1970, details are complicated, don't
131	ask). This type is called C<ev_tstamp>, which is what you should use	141	ask). This type is called C<ev_tstamp>, which is what you should use
132	too. It usually aliases to the C<double> type in C. When you need to do	142	too. It usually aliases to the C<double> type in C. When you need to do
133	any calculations on it, you should treat it as some floating point value.	143	any calculations on it, you should treat it as some floating point value.
134		144
…		…
149	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
150	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,
151	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
152	the libev caller and need to be fixed there.	162	the libev caller and need to be fixed there.
153		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
154	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
155	extensive consistency checking code. These do not trigger under normal
156	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.
157		171
158		172
159	=head1 GLOBAL FUNCTIONS	173	=head1 GLOBAL FUNCTIONS
160		174
161	These functions can be called anytime, even before initialising the	175	These functions can be called anytime, even before initialising the
…		…
165		179
166	=item ev_tstamp ev_time ()	180	=item ev_tstamp ev_time ()
167		181
168	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
169	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
170	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>.
171		186
172	=item ev_sleep (ev_tstamp interval)	187	=item ev_sleep (ev_tstamp interval)
173		188
174	Sleep for the given interval: The current thread will be blocked until	189	Sleep for the given interval: The current thread will be blocked
175	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
176	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 >>).
177		198
178	=item int ev_version_major ()	199	=item int ev_version_major ()
179		200
180	=item int ev_version_minor ()	201	=item int ev_version_minor ()
181		202
…		…
192	as this indicates an incompatible change. Minor versions are usually	213	as this indicates an incompatible change. Minor versions are usually
193	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
194	not a problem.	215	not a problem.
195		216
196	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
197	version (note, however, that this will not detect ABI mismatches :).	218	version (note, however, that this will not detect other ABI mismatches,
		219	such as LFS or reentrancy).
198		220
199	assert (("libev version mismatch",	221	assert (("libev version mismatch",
200	ev_version_major () == EV_VERSION_MAJOR	222	ev_version_major () == EV_VERSION_MAJOR
201	&& ev_version_minor () >= EV_VERSION_MINOR));	223	&& ev_version_minor () >= EV_VERSION_MINOR));
202		224
…		…
213	assert (("sorry, no epoll, no sex",	235	assert (("sorry, no epoll, no sex",
214	ev_supported_backends () & EVBACKEND_EPOLL));	236	ev_supported_backends () & EVBACKEND_EPOLL));
215		237
216	=item unsigned int ev_recommended_backends ()	238	=item unsigned int ev_recommended_backends ()
217		239
218	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
219	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
220	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
221	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
222	(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
223	libev will probe for if you specify no backends explicitly.	246	probe for if you specify no backends explicitly.
224		247
225	=item unsigned int ev_embeddable_backends ()	248	=item unsigned int ev_embeddable_backends ()
226		249
227	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
228	is the theoretical, all-platform, value. To find which backends	251	value is platform-specific but can include backends not available on the
229	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
230	C<ev_embeddable_backends () & ev_supported_backends ()>, likewise for	253	the current system, you would need to look at C<ev_embeddable_backends ()
231	recommended ones.	254	& ev_supported_backends ()>, likewise for recommended ones.
232		255
233	See the description of C<ev_embed> watchers for more info.	256	See the description of C<ev_embed> watchers for more info.
234		257
235	=item ev_set_allocator (void *(*cb)(void *ptr, long size)) [NOT REENTRANT]	258	=item ev_set_allocator (void *(*cb)(void *ptr, long size) throw ())
236		259
237	Sets the allocation function to use (the prototype is similar - the	260	Sets the allocation function to use (the prototype is similar - the
238	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
239	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
240	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
…		…
246		269
247	You could override this function in high-availability programs to, say,	270	You could override this function in high-availability programs to, say,
248	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,
249	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.
250		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
251	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
252	retries (example requires a standards-compliant C<realloc>).	289	retries.
253		290
254	static void *	291	static void *
255	persistent_realloc (void *ptr, size_t size)	292	persistent_realloc (void *ptr, size_t size)
256	{	293	{
		294	if (!size)
		295	{
		296	free (ptr);
		297	return 0;
		298	}
		299
257	for (;;)	300	for (;;)
258	{	301	{
259	void *newptr = realloc (ptr, size);	302	void *newptr = realloc (ptr, size);
260		303
261	if (newptr)	304	if (newptr)
…		…
266	}	309	}
267		310
268	...	311	...
269	ev_set_allocator (persistent_realloc);	312	ev_set_allocator (persistent_realloc);
270		313
271	=item ev_set_syserr_cb (void (*cb)(const char *msg)); [NOT REENTRANT]	314	=item ev_set_syserr_cb (void (*cb)(const char *msg) throw ())
272		315
273	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
274	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
275	indicating the system call or subsystem causing the problem. If this	318	indicating the system call or subsystem causing the problem. If this
276	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
…		…
288	}	331	}
289		332
290	...	333	...
291	ev_set_syserr_cb (fatal_error);	334	ev_set_syserr_cb (fatal_error);
292		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
293	=back	349	=back
294		350
295	=head1 FUNCTIONS CONTROLLING THE EVENT LOOP	351	=head1 FUNCTIONS CONTROLLING EVENT LOOPS
296		352
297	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
298	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
299	I<function>).	355	libev 3 had an C<ev_loop> function colliding with the struct name).
300		356
301	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
302	supports signals and child events, and dynamically created loops which do	358	supports child process events, and dynamically created event loops which
303	not.	359	do not.
304		360
305	=over 4	361	=over 4
306		362
307	=item struct ev_loop *ev_default_loop (unsigned int flags)	363	=item struct ev_loop *ev_default_loop (unsigned int flags)
308		364
309	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
310	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
311	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
312	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".
313		375
314	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
315	function.	377	function (or via the C<EV_DEFAULT> macro).
316		378
317	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
318	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
319	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).
320		383
321	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,
322	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
323	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
324	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
325	can simply overwrite the C<SIGCHLD> signal handler I<after> calling	388	C<SIGCHLD> signal handler I<after> calling C<ev_default_init>.
326	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.
327		408
328	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
329	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>).
330		411
331	The following flags are supported:	412	The following flags are supported:
…		…
341		422
342	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
343	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
344	C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will	425	C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will
345	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
346	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
347	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).
348		431
349	=item C<EVFLAG_FORKCHECK>	432	=item C<EVFLAG_FORKCHECK>
350		433
351	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
352	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.
353		436
354	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,
355	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
356	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
357	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
358	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
359	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).
360		444
361	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
362	forget about forgetting to tell libev about forking) when you use this	446	forget about forgetting to tell libev about forking, although you still
363	flag.	447	have to ignore C<SIGPIPE>) when you use this flag.
364		448
365	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>
366	environment variable.	450	environment variable.
367		451
368	=item C<EVFLAG_NOINOTIFY>	452	=item C<EVFLAG_NOINOTIFY>
369		453
370	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
371	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
372	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
373	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.
374		458
375	=item C<EVFLAG_SIGNALFD>	459	=item C<EVFLAG_SIGNALFD>
376		460
377	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
378	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
379	delivers signals synchronously, which makes it both faster and might make	463	delivers signals synchronously, which makes it both faster and might make
380	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
381	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
382	threads that are not interested in handling them.	466	threads that are not interested in handling them.
383		467
384	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
385	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
386	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.
387		495
388	=item C<EVBACKEND_SELECT> (value 1, portable select backend)	496	=item C<EVBACKEND_SELECT> (value 1, portable select backend)
389		497
390	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
391	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,
…		…
416	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
417	C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>.	525	C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>.
418		526
419	=item C<EVBACKEND_EPOLL> (value 4, Linux)	527	=item C<EVBACKEND_EPOLL> (value 4, Linux)
420		528
421	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
422	kernels).	530	kernels).
423		531
424	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
425	but it scales phenomenally better. While poll and select usually scale	533	it scales phenomenally better. While poll and select usually scale like
426	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
427	epoll scales either O(1) or O(active_fds).	535	fd), epoll scales either O(1) or O(active_fds).
428		536
429	The epoll mechanism deserves honorable mention as the most misdesigned	537	The epoll mechanism deserves honorable mention as the most misdesigned
430	of the more advanced event mechanisms: mere annoyances include silently	538	of the more advanced event mechanisms: mere annoyances include silently
431	dropping file descriptors, requiring a system call per change per file	539	dropping file descriptors, requiring a system call per change per file
432	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
433	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
434	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
435	take considerable time (one syscall per file descriptor) and is of course	545	set, which can take considerable time (one syscall per file descriptor)
436	hard to detect.	546	and is of course hard to detect.
437		547
438	Epoll is also notoriously buggy - embedding epoll fds I<should> work, but	548	Epoll is also notoriously buggy - embedding epoll fds I<should> work,
439	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
440	I<different> file descriptors (even already closed ones, so one cannot	550	totally I<different> file descriptors (even already closed ones, so
441	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
442	on SMP systems). Libev tries to counter these spurious notifications by	552	(especially on SMP systems). Libev tries to counter these spurious
443	employing an additional generation counter and comparing that against the	553	notifications by employing an additional generation counter and comparing
444	events to filter out spurious ones, recreating the set when required. Last	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
445	not least, it also refuses to work with some file descriptors which work	558	not least, it also refuses to work with some file descriptors which work
446	perfectly fine with C<select> (files, many character devices...).	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...
447		564
448	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
449	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
450	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
451	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
…		…
463	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
464	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
465	the usage. So sad.	582	the usage. So sad.
466		583
467	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
468	all kernel versions tested so far.	585	a lot of kernel revisions, but probably(!) works in current versions.
469		586
470	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
471	C<EVBACKEND_POLL>.	588	C<EVBACKEND_POLL>.
472		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
473	=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)	634	=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)
474		635
475	Kqueue deserves special mention, as at the time of this writing, it	636	Kqueue deserves special mention, as at the time this backend was
476	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
477	with anything but sockets and pipes, except on Darwin, where of course	638	work reliably with anything but sockets and pipes, except on Darwin,
478	it's completely useless). Unlike epoll, however, whose brokenness	639	where of course it's completely useless). Unlike epoll, however, whose
479	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)
480	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
481	"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
482	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
483	system like NetBSD.	644	known-to-be-good (-enough) system like NetBSD.
484		645
485	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
486	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
487	the target platform). See C<ev_embed> watchers for more info.	648	the target platform). See C<ev_embed> watchers for more info.
488		649
489	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
490	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
491	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
492	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
493	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
494	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
495	cases	656	drops fds silently in similarly hard-to-detect cases.
496		657
497	This backend usually performs well under most conditions.	658	This backend usually performs well under most conditions.
498		659
499	While nominally embeddable in other event loops, this doesn't work	660	While nominally embeddable in other event loops, this doesn't work
500	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
…		…
517	=item C<EVBACKEND_PORT> (value 32, Solaris 10)	678	=item C<EVBACKEND_PORT> (value 32, Solaris 10)
518		679
519	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,
520	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)).
521		682
522	Please note that Solaris event ports can deliver a lot of spurious
523	notifications, so you need to use non-blocking I/O or other means to avoid
524	blocking when no data (or space) is available.
525
526	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
527	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
528	descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend	685	descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend
529	might perform better.	686	might perform better.
530		687
531	On the positive side, with the exception of the spurious readiness	688	On the positive side, this backend actually performed fully to
532	notifications, this backend actually performed fully to specification
533	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
534	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.
535		702
536	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
537	C<EVBACKEND_POLL>.	704	C<EVBACKEND_POLL>.
538		705
539	=item C<EVBACKEND_ALL>	706	=item C<EVBACKEND_ALL>
540		707
541	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
542	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
543	C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>.	710	C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>.
544		711
545	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).
546		721
547	=back	722	=back
548		723
549	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,
550	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
551	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
552	()> will be tried.	727	()> will be tried.
553		728
554	Example: This is the most typical usage.
555
556	if (!ev_default_loop (0))
557	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
558
559	Example: Restrict libev to the select and poll backends, and do not allow
560	environment settings to be taken into account:
561
562	ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV);
563
564	Example: Use whatever libev has to offer, but make sure that kqueue is
565	used if available (warning, breaks stuff, best use only with your own
566	private event loop and only if you know the OS supports your types of
567	fds):
568
569	ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE);
570
571	=item struct ev_loop *ev_loop_new (unsigned int flags)
572
573	Similar to C<ev_default_loop>, but always creates a new event loop that is
574	always distinct from the default loop.
575
576	Note that this function I<is> thread-safe, and one common way to use
577	libev with threads is indeed to create one loop per thread, and using the
578	default loop in the "main" or "initial" thread.
579
580	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.
581		730
582	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);	731	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
583	if (!epoller)	732	if (!epoller)
584	fatal ("no epoll found here, maybe it hides under your chair");	733	fatal ("no epoll found here, maybe it hides under your chair");
585		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
586	=item ev_default_destroy ()	746	=item ev_loop_destroy (loop)
587		747
588	Destroys the default loop (frees all memory and kernel state etc.). None	748	Destroys an event loop object (frees all memory and kernel state
589	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
590	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
591	either stop all watchers cleanly yourself I<before> calling this function,	751	responsibility to either stop all watchers cleanly yourself I<before>
592	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
593	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).
594		755
595	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
596	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
597	as signal and child watchers) would need to be stopped manually.	758	as signal and child watchers) would need to be stopped manually.
598		759
599	In general it is not advisable to call this function except in the	760	This function is normally used on loop objects allocated by
600	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.
601	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>
602	C<ev_loop_new> and C<ev_loop_destroy>.	767	and C<ev_loop_destroy>.
603		768
604	=item ev_loop_destroy (loop)	769	=item ev_loop_fork (loop)
605		770
606	Like C<ev_default_destroy>, but destroys an event loop created by an
607	earlier call to C<ev_loop_new>.
608
609	=item ev_default_fork ()
610
611	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
612	to reinitialise the kernel state for backends that have one. Despite the	772	to reinitialise the kernel state for backends that have one. Despite
613	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
614	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
615	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
616	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>.
617		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
618	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
619	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
620	because some kernel interfaces *cough* I<kqueue> *cough* do funny things	783	because some kernel interfaces *cough* I<kqueue> *cough* do funny things
621	during fork.	784	during fork.
622		785
623	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
624	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
625	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
626	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).
627		792
628	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
629	it just in case after a fork. To make this easy, the function will fit in	794	it just in case after a fork.
630	quite nicely into a call to C<pthread_atfork>:
631		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	...
632	pthread_atfork (0, 0, ev_default_fork);	806	pthread_atfork (0, 0, post_fork_child);
633
634	=item ev_loop_fork (loop)
635
636	Like C<ev_default_fork>, but acts on an event loop created by
637	C<ev_loop_new>. Yes, you have to call this on every allocated event loop
638	after fork that you want to re-use in the child, and how you keep track of
639	them is entirely your own problem.
640		807
641	=item int ev_is_default_loop (loop)	808	=item int ev_is_default_loop (loop)
642		809
643	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
644	otherwise.	811	otherwise.
645		812
646	=item unsigned int ev_iteration (loop)	813	=item unsigned int ev_iteration (loop)
647		814
648	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
649	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>
650	happily wraps around with enough iterations.	817	and happily wraps around with enough iterations.
651		818
652	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
653	"ticks" the number of loop iterations), as it roughly corresponds with	820	"ticks" the number of loop iterations), as it roughly corresponds with
654	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
655	prepare and check phases.	822	prepare and check phases.
656		823
657	=item unsigned int ev_depth (loop)	824	=item unsigned int ev_depth (loop)
658		825
659	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
660	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.
661		828
662	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
663	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),
664	in which case it is higher.	831	in which case it is higher.
665		832
666	Leaving C<ev_loop> abnormally (setjmp/longjmp, cancelling the thread	833	Leaving C<ev_run> abnormally (setjmp/longjmp, cancelling the thread,
667	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
668	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.
669		837
670	=item unsigned int ev_backend (loop)	838	=item unsigned int ev_backend (loop)
671		839
672	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
673	use.	841	use.
…		…
682		850
683	=item ev_now_update (loop)	851	=item ev_now_update (loop)
684		852
685	Establishes the current time by querying the kernel, updating the time	853	Establishes the current time by querying the kernel, updating the time
686	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
687	is usually done automatically within C<ev_loop ()>.	855	is usually done automatically within C<ev_run ()>.
688		856
689	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
690	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
691	the current time is a good idea.	859	the current time is a good idea.
692		860
693	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.
694		862
695	=item ev_suspend (loop)	863	=item ev_suspend (loop)
696		864
697	=item ev_resume (loop)	865	=item ev_resume (loop)
698		866
699	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
700	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.
701		869
702	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
703	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
704	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
705	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>
…		…
716	without a previous call to C<ev_suspend>.	884	without a previous call to C<ev_suspend>.
717		885
718	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
719	event loop time (see C<ev_now_update>).	887	event loop time (see C<ev_now_update>).
720		888
721	=item ev_loop (loop, int flags)	889	=item bool ev_run (loop, int flags)
722		890
723	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
724	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
725	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>.
726		896
727	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
728	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.
729		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
730	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
731	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
732	finished (especially in interactive programs), but having a program	907	finished (especially in interactive programs), but having a program
733	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
734	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
735	beauty.	910	beauty.
736		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
737	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
738	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
739	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
740	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.
741		922
742	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
743	necessary) and will handle those and any already outstanding ones. It	924	necessary) and will handle those and any already outstanding ones. It
744	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
745	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
746	user-registered callback will be called), and will return after one	927	user-registered callback will be called), and will return after one
747	iteration of the loop.	928	iteration of the loop.
748		929
749	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
750	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
751	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
752	usually a better approach for this kind of thing.	933	usually a better approach for this kind of thing.
753		934
754	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):
755		938
		939	- Increment loop depth.
		940	- Reset the ev_break status.
756	- Before the first iteration, call any pending watchers.	941	- Before the first iteration, call any pending watchers.
		942	LOOP:
757	* If EVFLAG_FORKCHECK was used, check for a fork.	943	- If EVFLAG_FORKCHECK was used, check for a fork.
758	- 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.
759	- Queue and call all prepare watchers.	945	- Queue and call all prepare watchers.
		946	- If ev_break was called, goto FINISH.
760	- If we have been forked, detach and recreate the kernel state	947	- If we have been forked, detach and recreate the kernel state
761	as to not disturb the other process.	948	as to not disturb the other process.
762	- Update the kernel state with all outstanding changes.	949	- Update the kernel state with all outstanding changes.
763	- Update the "event loop time" (ev_now ()).	950	- Update the "event loop time" (ev_now ()).
764	- Calculate for how long to sleep or block, if at all	951	- Calculate for how long to sleep or block, if at all
765	(active idle watchers, EVLOOP_NONBLOCK or not having	952	(active idle watchers, EVRUN_NOWAIT or not having
766	any active watchers at all will result in not sleeping).	953	any active watchers at all will result in not sleeping).
767	- 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.
768	- Block the process, waiting for any events.	956	- Block the process, waiting for any events.
769	- Queue all outstanding I/O (fd) events.	957	- Queue all outstanding I/O (fd) events.
770	- 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.
771	- Queue all expired timers.	959	- Queue all expired timers.
772	- Queue all expired periodics.	960	- Queue all expired periodics.
773	- Unless any events are pending now, queue all idle watchers.	961	- Queue all idle watchers with priority higher than that of pending events.
774	- Queue all check watchers.	962	- Queue all check watchers.
775	- 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).
776	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
777	be handled here by queueing them when their watcher gets executed.	965	be handled here by queueing them when their watcher gets executed.
778	- 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
779	were used, or there are no active watchers, return, otherwise	967	were used, or there are no active watchers, goto FINISH, otherwise
780	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.
781		973
782	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
783	anymore.	975	anymore.
784		976
785	... queue jobs here, make sure they register event watchers as long	977	... queue jobs here, make sure they register event watchers as long
786	... 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..)
787	ev_loop (my_loop, 0);	979	ev_run (my_loop, 0);
788	... jobs done or somebody called unloop. yeah!	980	... jobs done or somebody called break. yeah!
789		981
790	=item ev_unloop (loop, how)	982	=item ev_break (loop, how)
791		983
792	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
793	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
794	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
795	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.
796		988
797	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>.
798		990
799	It is safe to call C<ev_unloop> from outside 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.
800		993
801	=item ev_ref (loop)	994	=item ev_ref (loop)
802		995
803	=item ev_unref (loop)	996	=item ev_unref (loop)
804		997
805	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
806	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
807	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.
808		1001
809	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
810	unregister, but that nevertheless should not keep C<ev_loop> from	1003	unregister, but that nevertheless should not keep C<ev_run> from
811	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>
812	before stopping it.	1005	before stopping it.
813		1006
814	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
815	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
816	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
817	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
818	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
819	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
820	before, respectively. Note also that libev might stop watchers itself	1013	before, respectively. Note also that libev might stop watchers itself
821	(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>
822	in the callback).	1015	in the callback).
823		1016
824	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>
825	running when nothing else is active.	1018	running when nothing else is active.
826		1019
827	ev_signal exitsig;	1020	ev_signal exitsig;
828	ev_signal_init (&exitsig, sig_cb, SIGINT);	1021	ev_signal_init (&exitsig, sig_cb, SIGINT);
829	ev_signal_start (loop, &exitsig);	1022	ev_signal_start (loop, &exitsig);
830	evf_unref (loop);	1023	ev_unref (loop);
831		1024
832	Example: For some weird reason, unregister the above signal handler again.	1025	Example: For some weird reason, unregister the above signal handler again.
833		1026
834	ev_ref (loop);	1027	ev_ref (loop);
835	ev_signal_stop (loop, &exitsig);	1028	ev_signal_stop (loop, &exitsig);
…		…
855	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.
856		1049
857	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
858	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,
859	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
860	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
861	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
862	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
863	once per this interval, on average.	1056	once per this interval, on average (as long as the host time resolution is
		1057	good enough).
864		1058
865	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
866	to spend more time collecting timeouts, at the expense of increased	1060	to spend more time collecting timeouts, at the expense of increased
867	latency/jitter/inexactness (the watcher callback will be called	1061	latency/jitter/inexactness (the watcher callback will be called
868	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
…		…
892	ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01);	1086	ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01);
893		1087
894	=item ev_invoke_pending (loop)	1088	=item ev_invoke_pending (loop)
895		1089
896	This call will simply invoke all pending watchers while resetting their	1090	This call will simply invoke all pending watchers while resetting their
897	pending state. Normally, C<ev_loop> does this automatically when required,	1091	pending state. Normally, C<ev_run> does this automatically when required,
898	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).
899		1097
900	=item int ev_pending_count (loop)	1098	=item int ev_pending_count (loop)
901		1099
902	Returns the number of pending watchers - zero indicates that no watchers	1100	Returns the number of pending watchers - zero indicates that no watchers
903	are pending.	1101	are pending.
904		1102
905	=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))
906		1104
907	This overrides the invoke pending functionality of the loop: Instead of	1105	This overrides the invoke pending functionality of the loop: Instead of
908	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
909	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
910	invoke the actual watchers inside another context (another thread etc.).	1108	invoke the actual watchers inside another context (another thread etc.).
911		1109
912	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
913	callback.	1111	callback.
914		1112
915	=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 ())
916		1114
917	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
918	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
919	each call to a libev function.	1117	each call to a libev function.
920		1118
921	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
922	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
923	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
924	and I<acquire> callbacks on the loop.	1122	I<release> and I<acquire> callbacks on the loop.
925		1123
926	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
927	suspended waiting for new events, and C<acquire> is called just	1125	suspended waiting for new events, and C<acquire> is called just
928	afterwards.	1126	afterwards.
929		1127
…		…
932		1130
933	While event loop modifications are allowed between invocations of	1131	While event loop modifications are allowed between invocations of
934	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
935	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
936	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
937	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
938	to take note of any changes you made.	1136	to take note of any changes you made.
939		1137
940	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
941	invocations of C<release> and C<acquire>.	1139	invocations of C<release> and C<acquire>.
942		1140
943	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
944	document.	1142	document.
945		1143
946	=item ev_set_userdata (loop, void *data)	1144	=item ev_set_userdata (loop, void *data)
947		1145
948	=item ev_userdata (loop)	1146	=item void *ev_userdata (loop)
949		1147
950	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
951	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
952	C<0.>	1150	C<0>.
953		1151
954	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,
955	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
956	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
957	any other purpose as well.	1155	any other purpose as well.
958		1156
959	=item ev_loop_verify (loop)	1157	=item ev_verify (loop)
960		1158
961	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
962	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
963	through all internal structures and checks them for validity. If anything	1161	through all internal structures and checks them for validity. If anything
964	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
…		…
975		1173
976	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
977	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
978	watchers and C<ev_io_start> for I/O watchers.	1176	watchers and C<ev_io_start> for I/O watchers.
979		1177
980	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
981	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
982	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:
983		1182
984	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)
985	{	1184	{
986	ev_io_stop (w);	1185	ev_io_stop (w);
987	ev_unloop (loop, EVUNLOOP_ALL);	1186	ev_break (loop, EVBREAK_ALL);
988	}	1187	}
989		1188
990	struct ev_loop *loop = ev_default_loop (0);	1189	struct ev_loop *loop = ev_default_loop (0);
991		1190
992	ev_io stdin_watcher;	1191	ev_io stdin_watcher;
993		1192
994	ev_init (&stdin_watcher, my_cb);	1193	ev_init (&stdin_watcher, my_cb);
995	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);	1194	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);
996	ev_io_start (loop, &stdin_watcher);	1195	ev_io_start (loop, &stdin_watcher);
997		1196
998	ev_loop (loop, 0);	1197	ev_run (loop, 0);
999		1198
1000	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
1001	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
1002	stack).	1201	stack).
1003		1202
1004	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>
1005	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).
1006		1205
1007	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
1008	(watcher *, callback)>, which expects a callback to be provided. This	1207	*, callback)>, which expects a callback to be provided. This callback is
1009	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
1010	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
1011	is readable and/or writable).	1210	and/or writable).
1012		1211
1013	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 *, ...) >>
1014	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
1015	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<<
1016	ev_TYPE_init (watcher *, callback, ...) >>.	1215	ev_TYPE_init (watcher *, callback, ...) >>.
…		…
1067		1266
1068	=item C<EV_PREPARE>	1267	=item C<EV_PREPARE>
1069		1268
1070	=item C<EV_CHECK>	1269	=item C<EV_CHECK>
1071		1270
1072	All C<ev_prepare> watchers are invoked just I<before> C<ev_loop> starts	1271	All C<ev_prepare> watchers are invoked just I<before> C<ev_run> starts to
1073	to gather new events, and all C<ev_check> watchers are invoked just after	1272	gather new events, and all C<ev_check> watchers are queued (not invoked)
1074	C<ev_loop> has gathered them, but before it invokes any callbacks for any	1273	just after C<ev_run> has gathered them, but before it queues any callbacks
		1274	for any received events. That means C<ev_prepare> watchers are the last
		1275	watchers invoked before the event loop sleeps or polls for new events, and
		1276	C<ev_check> watchers will be invoked before any other watchers of the same
		1277	or lower priority within an event loop iteration.
		1278
1075	received events. Callbacks of both watcher types can start and stop as	1279	Callbacks of both watcher types can start and stop as many watchers as
1076	many watchers as they want, and all of them will be taken into account	1280	they want, and all of them will be taken into account (for example, a
1077	(for example, a C<ev_prepare> watcher might start an idle watcher to keep	1281	C<ev_prepare> watcher might start an idle watcher to keep C<ev_run> from
1078	C<ev_loop> from blocking).	1282	blocking).
1079		1283
1080	=item C<EV_EMBED>	1284	=item C<EV_EMBED>
1081		1285
1082	The embedded event loop specified in the C<ev_embed> watcher needs attention.	1286	The embedded event loop specified in the C<ev_embed> watcher needs attention.
1083		1287
1084	=item C<EV_FORK>	1288	=item C<EV_FORK>
1085		1289
1086	The event loop has been resumed in the child process after fork (see	1290	The event loop has been resumed in the child process after fork (see
1087	C<ev_fork>).	1291	C<ev_fork>).
		1292
		1293	=item C<EV_CLEANUP>
		1294
		1295	The event loop is about to be destroyed (see C<ev_cleanup>).
1088		1296
1089	=item C<EV_ASYNC>	1297	=item C<EV_ASYNC>
1090		1298
1091	The given async watcher has been asynchronously notified (see C<ev_async>).	1299	The given async watcher has been asynchronously notified (see C<ev_async>).
1092		1300
…		…
1202		1410
1203	=item callback ev_cb (ev_TYPE *watcher)	1411	=item callback ev_cb (ev_TYPE *watcher)
1204		1412
1205	Returns the callback currently set on the watcher.	1413	Returns the callback currently set on the watcher.
1206		1414
1207	=item ev_cb_set (ev_TYPE *watcher, callback)	1415	=item ev_set_cb (ev_TYPE *watcher, callback)
1208		1416
1209	Change the callback. You can change the callback at virtually any time	1417	Change the callback. You can change the callback at virtually any time
1210	(modulo threads).	1418	(modulo threads).
1211		1419
1212	=item ev_set_priority (ev_TYPE *watcher, int priority)	1420	=item ev_set_priority (ev_TYPE *watcher, int priority)
…		…
1230	or might not have been clamped to the valid range.	1438	or might not have been clamped to the valid range.
1231		1439
1232	The default priority used by watchers when no priority has been set is	1440	The default priority used by watchers when no priority has been set is
1233	always C<0>, which is supposed to not be too high and not be too low :).	1441	always C<0>, which is supposed to not be too high and not be too low :).
1234		1442
1235	See L<WATCHER PRIORITY MODELS>, below, for a more thorough treatment of	1443	See L</WATCHER PRIORITY MODELS>, below, for a more thorough treatment of
1236	priorities.	1444	priorities.
1237		1445
1238	=item ev_invoke (loop, ev_TYPE *watcher, int revents)	1446	=item ev_invoke (loop, ev_TYPE *watcher, int revents)
1239		1447
1240	Invoke the C<watcher> with the given C<loop> and C<revents>. Neither	1448	Invoke the C<watcher> with the given C<loop> and C<revents>. Neither
…		…
1265	See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related	1473	See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related
1266	functions that do not need a watcher.	1474	functions that do not need a watcher.
1267		1475
1268	=back	1476	=back
1269		1477
		1478	See also the L</ASSOCIATING CUSTOM DATA WITH A WATCHER> and L</BUILDING YOUR
		1479	OWN COMPOSITE WATCHERS> idioms.
1270		1480
1271	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER	1481	=head2 WATCHER STATES
1272		1482
1273	Each watcher has, by default, a member C<void *data> that you can change	1483	There are various watcher states mentioned throughout this manual -
1274	and read at any time: libev will completely ignore it. This can be used	1484	active, pending and so on. In this section these states and the rules to
1275	to associate arbitrary data with your watcher. If you need more data and	1485	transition between them will be described in more detail - and while these
1276	don't want to allocate memory and store a pointer to it in that data	1486	rules might look complicated, they usually do "the right thing".
1277	member, you can also "subclass" the watcher type and provide your own
1278	data:
1279		1487
1280	struct my_io	1488	=over 4
1281	{
1282	ev_io io;
1283	int otherfd;
1284	void *somedata;
1285	struct whatever *mostinteresting;
1286	};
1287		1489
1288	...	1490	=item initialised
1289	struct my_io w;
1290	ev_io_init (&w.io, my_cb, fd, EV_READ);
1291		1491
1292	And since your callback will be called with a pointer to the watcher, you	1492	Before a watcher can be registered with the event loop it has to be
1293	can cast it back to your own type:	1493	initialised. This can be done with a call to C<ev_TYPE_init>, or calls to
		1494	C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function.
1294		1495
1295	static void my_cb (struct ev_loop *loop, ev_io *w_, int revents)	1496	In this state it is simply some block of memory that is suitable for
1296	{	1497	use in an event loop. It can be moved around, freed, reused etc. at
1297	struct my_io *w = (struct my_io *)w_;	1498	will - as long as you either keep the memory contents intact, or call
1298	...	1499	C<ev_TYPE_init> again.
1299	}
1300		1500
1301	More interesting and less C-conformant ways of casting your callback type	1501	=item started/running/active
1302	instead have been omitted.
1303		1502
1304	Another common scenario is to use some data structure with multiple	1503	Once a watcher has been started with a call to C<ev_TYPE_start> it becomes
1305	embedded watchers:	1504	property of the event loop, and is actively waiting for events. While in
		1505	this state it cannot be accessed (except in a few documented ways), moved,
		1506	freed or anything else - the only legal thing is to keep a pointer to it,
		1507	and call libev functions on it that are documented to work on active watchers.
1306		1508
1307	struct my_biggy	1509	=item pending
1308	{
1309	int some_data;
1310	ev_timer t1;
1311	ev_timer t2;
1312	}
1313		1510
1314	In this case getting the pointer to C<my_biggy> is a bit more	1511	If a watcher is active and libev determines that an event it is interested
1315	complicated: Either you store the address of your C<my_biggy> struct	1512	in has occurred (such as a timer expiring), it will become pending. It will
1316	in the C<data> member of the watcher (for woozies), or you need to use	1513	stay in this pending state until either it is stopped or its callback is
1317	some pointer arithmetic using C<offsetof> inside your watchers (for real	1514	about to be invoked, so it is not normally pending inside the watcher
1318	programmers):	1515	callback.
1319		1516
1320	#include <stddef.h>	1517	The watcher might or might not be active while it is pending (for example,
		1518	an expired non-repeating timer can be pending but no longer active). If it
		1519	is stopped, it can be freely accessed (e.g. by calling C<ev_TYPE_set>),
		1520	but it is still property of the event loop at this time, so cannot be
		1521	moved, freed or reused. And if it is active the rules described in the
		1522	previous item still apply.
1321		1523
1322	static void	1524	It is also possible to feed an event on a watcher that is not active (e.g.
1323	t1_cb (EV_P_ ev_timer *w, int revents)	1525	via C<ev_feed_event>), in which case it becomes pending without being
1324	{	1526	active.
1325	struct my_biggy big = (struct my_biggy *)
1326	(((char *)w) - offsetof (struct my_biggy, t1));
1327	}
1328		1527
1329	static void	1528	=item stopped
1330	t2_cb (EV_P_ ev_timer *w, int revents)	1529
1331	{	1530	A watcher can be stopped implicitly by libev (in which case it might still
1332	struct my_biggy big = (struct my_biggy *)	1531	be pending), or explicitly by calling its C<ev_TYPE_stop> function. The
1333	(((char *)w) - offsetof (struct my_biggy, t2));	1532	latter will clear any pending state the watcher might be in, regardless
1334	}	1533	of whether it was active or not, so stopping a watcher explicitly before
		1534	freeing it is often a good idea.
		1535
		1536	While stopped (and not pending) the watcher is essentially in the
		1537	initialised state, that is, it can be reused, moved, modified in any way
		1538	you wish (but when you trash the memory block, you need to C<ev_TYPE_init>
		1539	it again).
		1540
		1541	=back
1335		1542
1336	=head2 WATCHER PRIORITY MODELS	1543	=head2 WATCHER PRIORITY MODELS
1337		1544
1338	Many event loops support I<watcher priorities>, which are usually small	1545	Many event loops support I<watcher priorities>, which are usually small
1339	integers that influence the ordering of event callback invocation	1546	integers that influence the ordering of event callback invocation
1340	between watchers in some way, all else being equal.	1547	between watchers in some way, all else being equal.
1341		1548
1342	In libev, Watcher priorities can be set using C<ev_set_priority>. See its	1549	In libev, watcher priorities can be set using C<ev_set_priority>. See its
1343	description for the more technical details such as the actual priority	1550	description for the more technical details such as the actual priority
1344	range.	1551	range.
1345		1552
1346	There are two common ways how these these priorities are being interpreted	1553	There are two common ways how these these priorities are being interpreted
1347	by event loops:	1554	by event loops:
…		…
1441		1648
1442	This section describes each watcher in detail, but will not repeat	1649	This section describes each watcher in detail, but will not repeat
1443	information given in the last section. Any initialisation/set macros,	1650	information given in the last section. Any initialisation/set macros,
1444	functions and members specific to the watcher type are explained.	1651	functions and members specific to the watcher type are explained.
1445		1652
1446	Members are additionally marked with either I<[read-only]>, meaning that,	1653	Most members are additionally marked with either I<[read-only]>, meaning
1447	while the watcher is active, you can look at the member and expect some	1654	that, while the watcher is active, you can look at the member and expect
1448	sensible content, but you must not modify it (you can modify it while the	1655	some sensible content, but you must not modify it (you can modify it while
1449	watcher is stopped to your hearts content), or I<[read-write]>, which	1656	the watcher is stopped to your hearts content), or I<[read-write]>, which
1450	means you can expect it to have some sensible content while the watcher	1657	means you can expect it to have some sensible content while the watcher
1451	is active, but you can also modify it. Modifying it may not do something	1658	is active, but you can also modify it. Modifying it may not do something
1452	sensible or take immediate effect (or do anything at all), but libev will	1659	sensible or take immediate effect (or do anything at all), but libev will
1453	not crash or malfunction in any way.	1660	not crash or malfunction in any way.
1454		1661
		1662	In any case, the documentation for each member will explain what the
		1663	effects are, and if there are any additional access restrictions.
1455		1664
1456	=head2 C<ev_io> - is this file descriptor readable or writable?	1665	=head2 C<ev_io> - is this file descriptor readable or writable?
1457		1666
1458	I/O watchers check whether a file descriptor is readable or writable	1667	I/O watchers check whether a file descriptor is readable or writable
1459	in each iteration of the event loop, or, more precisely, when reading	1668	in each iteration of the event loop, or, more precisely, when reading
…		…
1466	In general you can register as many read and/or write event watchers per	1675	In general you can register as many read and/or write event watchers per
1467	fd as you want (as long as you don't confuse yourself). Setting all file	1676	fd as you want (as long as you don't confuse yourself). Setting all file
1468	descriptors to non-blocking mode is also usually a good idea (but not	1677	descriptors to non-blocking mode is also usually a good idea (but not
1469	required if you know what you are doing).	1678	required if you know what you are doing).
1470		1679
1471	If you cannot use non-blocking mode, then force the use of a
1472	known-to-be-good backend (at the time of this writing, this includes only
1473	C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>). The same applies to file
1474	descriptors for which non-blocking operation makes no sense (such as
1475	files) - libev doesn't guarantee any specific behaviour in that case.
1476
1477	Another thing you have to watch out for is that it is quite easy to	1680	Another thing you have to watch out for is that it is quite easy to
1478	receive "spurious" readiness notifications, that is your callback might	1681	receive "spurious" readiness notifications, that is, your callback might
1479	be called with C<EV_READ> but a subsequent C<read>(2) will actually block	1682	be called with C<EV_READ> but a subsequent C<read>(2) will actually block
1480	because there is no data. Not only are some backends known to create a	1683	because there is no data. It is very easy to get into this situation even
1481	lot of those (for example Solaris ports), it is very easy to get into	1684	with a relatively standard program structure. Thus it is best to always
1482	this situation even with a relatively standard program structure. Thus	1685	use non-blocking I/O: An extra C<read>(2) returning C<EAGAIN> is far
1483	it is best to always use non-blocking I/O: An extra C<read>(2) returning
1484	C<EAGAIN> is far preferable to a program hanging until some data arrives.	1686	preferable to a program hanging until some data arrives.
1485		1687
1486	If you cannot run the fd in non-blocking mode (for example you should	1688	If you cannot run the fd in non-blocking mode (for example you should
1487	not play around with an Xlib connection), then you have to separately	1689	not play around with an Xlib connection), then you have to separately
1488	re-test whether a file descriptor is really ready with a known-to-be good	1690	re-test whether a file descriptor is really ready with a known-to-be good
1489	interface such as poll (fortunately in our Xlib example, Xlib already	1691	interface such as poll (fortunately in the case of Xlib, it already does
1490	does this on its own, so its quite safe to use). Some people additionally	1692	this on its own, so its quite safe to use). Some people additionally
1491	use C<SIGALRM> and an interval timer, just to be sure you won't block	1693	use C<SIGALRM> and an interval timer, just to be sure you won't block
1492	indefinitely.	1694	indefinitely.
1493		1695
1494	But really, best use non-blocking mode.	1696	But really, best use non-blocking mode.
1495		1697
1496	=head3 The special problem of disappearing file descriptors	1698	=head3 The special problem of disappearing file descriptors
1497		1699
1498	Some backends (e.g. kqueue, epoll) need to be told about closing a file	1700	Some backends (e.g. kqueue, epoll, linuxaio) need to be told about closing
1499	descriptor (either due to calling C<close> explicitly or any other means,	1701	a file descriptor (either due to calling C<close> explicitly or any other
1500	such as C<dup2>). The reason is that you register interest in some file	1702	means, such as C<dup2>). The reason is that you register interest in some
1501	descriptor, but when it goes away, the operating system will silently drop	1703	file descriptor, but when it goes away, the operating system will silently
1502	this interest. If another file descriptor with the same number then is	1704	drop this interest. If another file descriptor with the same number then
1503	registered with libev, there is no efficient way to see that this is, in	1705	is registered with libev, there is no efficient way to see that this is,
1504	fact, a different file descriptor.	1706	in fact, a different file descriptor.
1505		1707
1506	To avoid having to explicitly tell libev about such cases, libev follows	1708	To avoid having to explicitly tell libev about such cases, libev follows
1507	the following policy: Each time C<ev_io_set> is being called, libev	1709	the following policy: Each time C<ev_io_set> is being called, libev
1508	will assume that this is potentially a new file descriptor, otherwise	1710	will assume that this is potentially a new file descriptor, otherwise
1509	it is assumed that the file descriptor stays the same. That means that	1711	it is assumed that the file descriptor stays the same. That means that
…		…
1523		1725
1524	There is no workaround possible except not registering events	1726	There is no workaround possible except not registering events
1525	for potentially C<dup ()>'ed file descriptors, or to resort to	1727	for potentially C<dup ()>'ed file descriptors, or to resort to
1526	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.	1728	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1527		1729
		1730	=head3 The special problem of files
		1731
		1732	Many people try to use C<select> (or libev) on file descriptors
		1733	representing files, and expect it to become ready when their program
		1734	doesn't block on disk accesses (which can take a long time on their own).
		1735
		1736	However, this cannot ever work in the "expected" way - you get a readiness
		1737	notification as soon as the kernel knows whether and how much data is
		1738	there, and in the case of open files, that's always the case, so you
		1739	always get a readiness notification instantly, and your read (or possibly
		1740	write) will still block on the disk I/O.
		1741
		1742	Another way to view it is that in the case of sockets, pipes, character
		1743	devices and so on, there is another party (the sender) that delivers data
		1744	on its own, but in the case of files, there is no such thing: the disk
		1745	will not send data on its own, simply because it doesn't know what you
		1746	wish to read - you would first have to request some data.
		1747
		1748	Since files are typically not-so-well supported by advanced notification
		1749	mechanism, libev tries hard to emulate POSIX behaviour with respect
		1750	to files, even though you should not use it. The reason for this is
		1751	convenience: sometimes you want to watch STDIN or STDOUT, which is
		1752	usually a tty, often a pipe, but also sometimes files or special devices
		1753	(for example, C<epoll> on Linux works with F</dev/random> but not with
		1754	F</dev/urandom>), and even though the file might better be served with
		1755	asynchronous I/O instead of with non-blocking I/O, it is still useful when
		1756	it "just works" instead of freezing.
		1757
		1758	So avoid file descriptors pointing to files when you know it (e.g. use
		1759	libeio), but use them when it is convenient, e.g. for STDIN/STDOUT, or
		1760	when you rarely read from a file instead of from a socket, and want to
		1761	reuse the same code path.
		1762
1528	=head3 The special problem of fork	1763	=head3 The special problem of fork
1529		1764
1530	Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit	1765	Some backends (epoll, kqueue, linuxaio, iouring) do not support C<fork ()>
1531	useless behaviour. Libev fully supports fork, but needs to be told about	1766	at all or exhibit useless behaviour. Libev fully supports fork, but needs
1532	it in the child.	1767	to be told about it in the child if you want to continue to use it in the
		1768	child.
1533		1769
1534	To support fork in your programs, you either have to call	1770	To support fork in your child processes, you have to call C<ev_loop_fork
1535	C<ev_default_fork ()> or C<ev_loop_fork ()> after a fork in the child,	1771	()> after a fork in the child, enable C<EVFLAG_FORKCHECK>, or resort to
1536	enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or	1772	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1537	C<EVBACKEND_POLL>.
1538		1773
1539	=head3 The special problem of SIGPIPE	1774	=head3 The special problem of SIGPIPE
1540		1775
1541	While not really specific to libev, it is easy to forget about C<SIGPIPE>:	1776	While not really specific to libev, it is easy to forget about C<SIGPIPE>:
1542	when writing to a pipe whose other end has been closed, your program gets	1777	when writing to a pipe whose other end has been closed, your program gets
…		…
1596		1831
1597	Configures an C<ev_io> watcher. The C<fd> is the file descriptor to	1832	Configures an C<ev_io> watcher. The C<fd> is the file descriptor to
1598	receive events for and C<events> is either C<EV_READ>, C<EV_WRITE> or	1833	receive events for and C<events> is either C<EV_READ>, C<EV_WRITE> or
1599	C<EV_READ | EV_WRITE>, to express the desire to receive the given events.	1834	C<EV_READ | EV_WRITE>, to express the desire to receive the given events.
1600		1835
1601	=item int fd [read-only]	1836	=item ev_io_modify (ev_io *, int events)
1602		1837
1603	The file descriptor being watched.	1838	Similar to C<ev_io_set>, but only changes the event mask. Using this might
		1839	be faster with some backends, as libev can assume that the C<fd> still
		1840	refers to the same underlying file description, something it cannot do
		1841	when using C<ev_io_set>.
1604		1842
		1843	=item int fd [no-modify]
		1844
		1845	The file descriptor being watched. While it can be read at any time, you
		1846	must not modify this member even when the watcher is stopped - always use
		1847	C<ev_io_set> for that.
		1848
1605	=item int events [read-only]	1849	=item int events [no-modify]
1606		1850
1607	The events being watched.	1851	The set of events being watched, among other flags. This field is a
		1852	bit set - to test for C<EV_READ>, use C<< w->events & EV_READ >>, and
		1853	similarly for C<EV_WRITE>.
		1854
		1855	As with C<fd>, you must not modify this member even when the watcher is
		1856	stopped, always use C<ev_io_set> or C<ev_io_modify> for that.
1608		1857
1609	=back	1858	=back
1610		1859
1611	=head3 Examples	1860	=head3 Examples
1612		1861
…		…
1624	...	1873	...
1625	struct ev_loop *loop = ev_default_init (0);	1874	struct ev_loop *loop = ev_default_init (0);
1626	ev_io stdin_readable;	1875	ev_io stdin_readable;
1627	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);	1876	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);
1628	ev_io_start (loop, &stdin_readable);	1877	ev_io_start (loop, &stdin_readable);
1629	ev_loop (loop, 0);	1878	ev_run (loop, 0);
1630		1879
1631		1880
1632	=head2 C<ev_timer> - relative and optionally repeating timeouts	1881	=head2 C<ev_timer> - relative and optionally repeating timeouts
1633		1882
1634	Timer watchers are simple relative timers that generate an event after a	1883	Timer watchers are simple relative timers that generate an event after a
…		…
1640	detecting time jumps is hard, and some inaccuracies are unavoidable (the	1889	detecting time jumps is hard, and some inaccuracies are unavoidable (the
1641	monotonic clock option helps a lot here).	1890	monotonic clock option helps a lot here).
1642		1891
1643	The callback is guaranteed to be invoked only I<after> its timeout has	1892	The callback is guaranteed to be invoked only I<after> its timeout has
1644	passed (not I<at>, so on systems with very low-resolution clocks this	1893	passed (not I<at>, so on systems with very low-resolution clocks this
1645	might introduce a small delay). If multiple timers become ready during the	1894	might introduce a small delay, see "the special problem of being too
		1895	early", below). If multiple timers become ready during the same loop
1646	same loop iteration then the ones with earlier time-out values are invoked	1896	iteration then the ones with earlier time-out values are invoked before
1647	before ones of the same priority with later time-out values (but this is	1897	ones of the same priority with later time-out values (but this is no
1648	no longer true when a callback calls C<ev_loop> recursively).	1898	longer true when a callback calls C<ev_run> recursively).
1649		1899
1650	=head3 Be smart about timeouts	1900	=head3 Be smart about timeouts
1651		1901
1652	Many real-world problems involve some kind of timeout, usually for error	1902	Many real-world problems involve some kind of timeout, usually for error
1653	recovery. A typical example is an HTTP request - if the other side hangs,	1903	recovery. A typical example is an HTTP request - if the other side hangs,
…		…
1728		1978
1729	In this case, it would be more efficient to leave the C<ev_timer> alone,	1979	In this case, it would be more efficient to leave the C<ev_timer> alone,
1730	but remember the time of last activity, and check for a real timeout only	1980	but remember the time of last activity, and check for a real timeout only
1731	within the callback:	1981	within the callback:
1732		1982
		1983	ev_tstamp timeout = 60.;
1733	ev_tstamp last_activity; // time of last activity	1984	ev_tstamp last_activity; // time of last activity
		1985	ev_timer timer;
1734		1986
1735	static void	1987	static void
1736	callback (EV_P_ ev_timer *w, int revents)	1988	callback (EV_P_ ev_timer *w, int revents)
1737	{	1989	{
1738	ev_tstamp now = ev_now (EV_A);	1990	// calculate when the timeout would happen
1739	ev_tstamp timeout = last_activity + 60.;	1991	ev_tstamp after = last_activity - ev_now (EV_A) + timeout;
1740		1992
1741	// if last_activity + 60. is older than now, we did time out	1993	// if negative, it means we the timeout already occurred
1742	if (timeout < now)	1994	if (after < 0.)
1743	{	1995	{
1744	// timeout occurred, take action	1996	// timeout occurred, take action
1745	}	1997	}
1746	else	1998	else
1747	{	1999	{
1748	// callback was invoked, but there was some activity, re-arm	2000	// callback was invoked, but there was some recent
1749	// the watcher to fire in last_activity + 60, which is	2001	// activity. simply restart the timer to time out
1750	// guaranteed to be in the future, so "again" is positive:	2002	// after "after" seconds, which is the earliest time
1751	w->repeat = timeout - now;	2003	// the timeout can occur.
		2004	ev_timer_set (w, after, 0.);
1752	ev_timer_again (EV_A_ w);	2005	ev_timer_start (EV_A_ w);
1753	}	2006	}
1754	}	2007	}
1755		2008
1756	To summarise the callback: first calculate the real timeout (defined	2009	To summarise the callback: first calculate in how many seconds the
1757	as "60 seconds after the last activity"), then check if that time has	2010	timeout will occur (by calculating the absolute time when it would occur,
1758	been reached, which means something I<did>, in fact, time out. Otherwise	2011	C<last_activity + timeout>, and subtracting the current time, C<ev_now
1759	the callback was invoked too early (C<timeout> is in the future), so	2012	(EV_A)> from that).
1760	re-schedule the timer to fire at that future time, to see if maybe we have
1761	a timeout then.
1762		2013
1763	Note how C<ev_timer_again> is used, taking advantage of the	2014	If this value is negative, then we are already past the timeout, i.e. we
1764	C<ev_timer_again> optimisation when the timer is already running.	2015	timed out, and need to do whatever is needed in this case.
		2016
		2017	Otherwise, we now the earliest time at which the timeout would trigger,
		2018	and simply start the timer with this timeout value.
		2019
		2020	In other words, each time the callback is invoked it will check whether
		2021	the timeout occurred. If not, it will simply reschedule itself to check
		2022	again at the earliest time it could time out. Rinse. Repeat.
1765		2023
1766	This scheme causes more callback invocations (about one every 60 seconds	2024	This scheme causes more callback invocations (about one every 60 seconds
1767	minus half the average time between activity), but virtually no calls to	2025	minus half the average time between activity), but virtually no calls to
1768	libev to change the timeout.	2026	libev to change the timeout.
1769		2027
1770	To start the timer, simply initialise the watcher and set C<last_activity>	2028	To start the machinery, simply initialise the watcher and set
1771	to the current time (meaning we just have some activity :), then call the	2029	C<last_activity> to the current time (meaning there was some activity just
1772	callback, which will "do the right thing" and start the timer:	2030	now), then call the callback, which will "do the right thing" and start
		2031	the timer:
1773		2032
		2033	last_activity = ev_now (EV_A);
1774	ev_init (timer, callback);	2034	ev_init (&timer, callback);
1775	last_activity = ev_now (loop);	2035	callback (EV_A_ &timer, 0);
1776	callback (loop, timer, EV_TIMER);
1777		2036
1778	And when there is some activity, simply store the current time in	2037	When there is some activity, simply store the current time in
1779	C<last_activity>, no libev calls at all:	2038	C<last_activity>, no libev calls at all:
1780		2039
		2040	if (activity detected)
1781	last_activity = ev_now (loop);	2041	last_activity = ev_now (EV_A);
		2042
		2043	When your timeout value changes, then the timeout can be changed by simply
		2044	providing a new value, stopping the timer and calling the callback, which
		2045	will again do the right thing (for example, time out immediately :).
		2046
		2047	timeout = new_value;
		2048	ev_timer_stop (EV_A_ &timer);
		2049	callback (EV_A_ &timer, 0);
1782		2050
1783	This technique is slightly more complex, but in most cases where the	2051	This technique is slightly more complex, but in most cases where the
1784	time-out is unlikely to be triggered, much more efficient.	2052	time-out is unlikely to be triggered, much more efficient.
1785
1786	Changing the timeout is trivial as well (if it isn't hard-coded in the
1787	callback :) - just change the timeout and invoke the callback, which will
1788	fix things for you.
1789		2053
1790	=item 4. Wee, just use a double-linked list for your timeouts.	2054	=item 4. Wee, just use a double-linked list for your timeouts.
1791		2055
1792	If there is not one request, but many thousands (millions...), all	2056	If there is not one request, but many thousands (millions...), all
1793	employing some kind of timeout with the same timeout value, then one can	2057	employing some kind of timeout with the same timeout value, then one can
…		…
1820	Method #1 is almost always a bad idea, and buys you nothing. Method #4 is	2084	Method #1 is almost always a bad idea, and buys you nothing. Method #4 is
1821	rather complicated, but extremely efficient, something that really pays	2085	rather complicated, but extremely efficient, something that really pays
1822	off after the first million or so of active timers, i.e. it's usually	2086	off after the first million or so of active timers, i.e. it's usually
1823	overkill :)	2087	overkill :)
1824		2088
		2089	=head3 The special problem of being too early
		2090
		2091	If you ask a timer to call your callback after three seconds, then
		2092	you expect it to be invoked after three seconds - but of course, this
		2093	cannot be guaranteed to infinite precision. Less obviously, it cannot be
		2094	guaranteed to any precision by libev - imagine somebody suspending the
		2095	process with a STOP signal for a few hours for example.
		2096
		2097	So, libev tries to invoke your callback as soon as possible I<after> the
		2098	delay has occurred, but cannot guarantee this.
		2099
		2100	A less obvious failure mode is calling your callback too early: many event
		2101	loops compare timestamps with a "elapsed delay >= requested delay", but
		2102	this can cause your callback to be invoked much earlier than you would
		2103	expect.
		2104
		2105	To see why, imagine a system with a clock that only offers full second
		2106	resolution (think windows if you can't come up with a broken enough OS
		2107	yourself). If you schedule a one-second timer at the time 500.9, then the
		2108	event loop will schedule your timeout to elapse at a system time of 500
		2109	(500.9 truncated to the resolution) + 1, or 501.
		2110
		2111	If an event library looks at the timeout 0.1s later, it will see "501 >=
		2112	501" and invoke the callback 0.1s after it was started, even though a
		2113	one-second delay was requested - this is being "too early", despite best
		2114	intentions.
		2115
		2116	This is the reason why libev will never invoke the callback if the elapsed
		2117	delay equals the requested delay, but only when the elapsed delay is
		2118	larger than the requested delay. In the example above, libev would only invoke
		2119	the callback at system time 502, or 1.1s after the timer was started.
		2120
		2121	So, while libev cannot guarantee that your callback will be invoked
		2122	exactly when requested, it I<can> and I<does> guarantee that the requested
		2123	delay has actually elapsed, or in other words, it always errs on the "too
		2124	late" side of things.
		2125
1825	=head3 The special problem of time updates	2126	=head3 The special problem of time updates
1826		2127
1827	Establishing the current time is a costly operation (it usually takes at	2128	Establishing the current time is a costly operation (it usually takes
1828	least two system calls): EV therefore updates its idea of the current	2129	at least one system call): EV therefore updates its idea of the current
1829	time only before and after C<ev_loop> collects new events, which causes a	2130	time only before and after C<ev_run> collects new events, which causes a
1830	growing difference between C<ev_now ()> and C<ev_time ()> when handling	2131	growing difference between C<ev_now ()> and C<ev_time ()> when handling
1831	lots of events in one iteration.	2132	lots of events in one iteration.
1832		2133
1833	The relative timeouts are calculated relative to the C<ev_now ()>	2134	The relative timeouts are calculated relative to the C<ev_now ()>
1834	time. This is usually the right thing as this timestamp refers to the time	2135	time. This is usually the right thing as this timestamp refers to the time
1835	of the event triggering whatever timeout you are modifying/starting. If	2136	of the event triggering whatever timeout you are modifying/starting. If
1836	you suspect event processing to be delayed and you I<need> to base the	2137	you suspect event processing to be delayed and you I<need> to base the
1837	timeout on the current time, use something like this to adjust for this:	2138	timeout on the current time, use something like the following to adjust
		2139	for it:
1838		2140
1839	ev_timer_set (&timer, after + ev_now () - ev_time (), 0.);	2141	ev_timer_set (&timer, after + (ev_time () - ev_now ()), 0.);
1840		2142
1841	If the event loop is suspended for a long time, you can also force an	2143	If the event loop is suspended for a long time, you can also force an
1842	update of the time returned by C<ev_now ()> by calling C<ev_now_update	2144	update of the time returned by C<ev_now ()> by calling C<ev_now_update
1843	()>.	2145	()>, although that will push the event time of all outstanding events
		2146	further into the future.
		2147
		2148	=head3 The special problem of unsynchronised clocks
		2149
		2150	Modern systems have a variety of clocks - libev itself uses the normal
		2151	"wall clock" clock and, if available, the monotonic clock (to avoid time
		2152	jumps).
		2153
		2154	Neither of these clocks is synchronised with each other or any other clock
		2155	on the system, so C<ev_time ()> might return a considerably different time
		2156	than C<gettimeofday ()> or C<time ()>. On a GNU/Linux system, for example,
		2157	a call to C<gettimeofday> might return a second count that is one higher
		2158	than a directly following call to C<time>.
		2159
		2160	The moral of this is to only compare libev-related timestamps with
		2161	C<ev_time ()> and C<ev_now ()>, at least if you want better precision than
		2162	a second or so.
		2163
		2164	One more problem arises due to this lack of synchronisation: if libev uses
		2165	the system monotonic clock and you compare timestamps from C<ev_time>
		2166	or C<ev_now> from when you started your timer and when your callback is
		2167	invoked, you will find that sometimes the callback is a bit "early".
		2168
		2169	This is because C<ev_timer>s work in real time, not wall clock time, so
		2170	libev makes sure your callback is not invoked before the delay happened,
		2171	I<measured according to the real time>, not the system clock.
		2172
		2173	If your timeouts are based on a physical timescale (e.g. "time out this
		2174	connection after 100 seconds") then this shouldn't bother you as it is
		2175	exactly the right behaviour.
		2176
		2177	If you want to compare wall clock/system timestamps to your timers, then
		2178	you need to use C<ev_periodic>s, as these are based on the wall clock
		2179	time, where your comparisons will always generate correct results.
1844		2180
1845	=head3 The special problems of suspended animation	2181	=head3 The special problems of suspended animation
1846		2182
1847	When you leave the server world it is quite customary to hit machines that	2183	When you leave the server world it is quite customary to hit machines that
1848	can suspend/hibernate - what happens to the clocks during such a suspend?	2184	can suspend/hibernate - what happens to the clocks during such a suspend?
…		…
1878		2214
1879	=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)	2215	=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
1880		2216
1881	=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)	2217	=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)
1882		2218
1883	Configure the timer to trigger after C<after> seconds. If C<repeat>	2219	Configure the timer to trigger after C<after> seconds (fractional and
1884	is C<0.>, then it will automatically be stopped once the timeout is	2220	negative values are supported). If C<repeat> is C<0.>, then it will
1885	reached. If it is positive, then the timer will automatically be	2221	automatically be stopped once the timeout is reached. If it is positive,
1886	configured to trigger again C<repeat> seconds later, again, and again,	2222	then the timer will automatically be configured to trigger again C<repeat>
1887	until stopped manually.	2223	seconds later, again, and again, until stopped manually.
1888		2224
1889	The timer itself will do a best-effort at avoiding drift, that is, if	2225	The timer itself will do a best-effort at avoiding drift, that is, if
1890	you configure a timer to trigger every 10 seconds, then it will normally	2226	you configure a timer to trigger every 10 seconds, then it will normally
1891	trigger at exactly 10 second intervals. If, however, your program cannot	2227	trigger at exactly 10 second intervals. If, however, your program cannot
1892	keep up with the timer (because it takes longer than those 10 seconds to	2228	keep up with the timer (because it takes longer than those 10 seconds to
1893	do stuff) the timer will not fire more than once per event loop iteration.	2229	do stuff) the timer will not fire more than once per event loop iteration.
1894		2230
1895	=item ev_timer_again (loop, ev_timer *)	2231	=item ev_timer_again (loop, ev_timer *)
1896		2232
1897	This will act as if the timer timed out and restart it again if it is	2233	This will act as if the timer timed out, and restarts it again if it is
1898	repeating. The exact semantics are:	2234	repeating. It basically works like calling C<ev_timer_stop>, updating the
		2235	timeout to the C<repeat> value and calling C<ev_timer_start>.
1899		2236
		2237	The exact semantics are as in the following rules, all of which will be
		2238	applied to the watcher:
		2239
		2240	=over 4
		2241
1900	If the timer is pending, its pending status is cleared.	2242	=item If the timer is pending, the pending status is always cleared.
1901		2243
1902	If the timer is started but non-repeating, stop it (as if it timed out).	2244	=item If the timer is started but non-repeating, stop it (as if it timed
		2245	out, without invoking it).
1903		2246
1904	If the timer is repeating, either start it if necessary (with the	2247	=item If the timer is repeating, make the C<repeat> value the new timeout
1905	C<repeat> value), or reset the running timer to the C<repeat> value.	2248	and start the timer, if necessary.
1906		2249
		2250	=back
		2251
1907	This sounds a bit complicated, see L<Be smart about timeouts>, above, for a	2252	This sounds a bit complicated, see L</Be smart about timeouts>, above, for a
1908	usage example.	2253	usage example.
1909		2254
1910	=item ev_tstamp ev_timer_remaining (loop, ev_timer *)	2255	=item ev_tstamp ev_timer_remaining (loop, ev_timer *)
1911		2256
1912	Returns the remaining time until a timer fires. If the timer is active,	2257	Returns the remaining time until a timer fires. If the timer is active,
…		…
1951	}	2296	}
1952		2297
1953	ev_timer mytimer;	2298	ev_timer mytimer;
1954	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */	2299	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */
1955	ev_timer_again (&mytimer); /* start timer */	2300	ev_timer_again (&mytimer); /* start timer */
1956	ev_loop (loop, 0);	2301	ev_run (loop, 0);
1957		2302
1958	// and in some piece of code that gets executed on any "activity":	2303	// and in some piece of code that gets executed on any "activity":
1959	// reset the timeout to start ticking again at 10 seconds	2304	// reset the timeout to start ticking again at 10 seconds
1960	ev_timer_again (&mytimer);	2305	ev_timer_again (&mytimer);
1961		2306
…		…
1965	Periodic watchers are also timers of a kind, but they are very versatile	2310	Periodic watchers are also timers of a kind, but they are very versatile
1966	(and unfortunately a bit complex).	2311	(and unfortunately a bit complex).
1967		2312
1968	Unlike C<ev_timer>, periodic watchers are not based on real time (or	2313	Unlike C<ev_timer>, periodic watchers are not based on real time (or
1969	relative time, the physical time that passes) but on wall clock time	2314	relative time, the physical time that passes) but on wall clock time
1970	(absolute time, the thing you can read on your calender or clock). The	2315	(absolute time, the thing you can read on your calendar or clock). The
1971	difference is that wall clock time can run faster or slower than real	2316	difference is that wall clock time can run faster or slower than real
1972	time, and time jumps are not uncommon (e.g. when you adjust your	2317	time, and time jumps are not uncommon (e.g. when you adjust your
1973	wrist-watch).	2318	wrist-watch).
1974		2319
1975	You can tell a periodic watcher to trigger after some specific point	2320	You can tell a periodic watcher to trigger after some specific point
…		…
1980	C<ev_timer>, which would still trigger roughly 10 seconds after starting	2325	C<ev_timer>, which would still trigger roughly 10 seconds after starting
1981	it, as it uses a relative timeout).	2326	it, as it uses a relative timeout).
1982		2327
1983	C<ev_periodic> watchers can also be used to implement vastly more complex	2328	C<ev_periodic> watchers can also be used to implement vastly more complex
1984	timers, such as triggering an event on each "midnight, local time", or	2329	timers, such as triggering an event on each "midnight, local time", or
1985	other complicated rules. This cannot be done with C<ev_timer> watchers, as	2330	other complicated rules. This cannot easily be done with C<ev_timer>
1986	those cannot react to time jumps.	2331	watchers, as those cannot react to time jumps.
1987		2332
1988	As with timers, the callback is guaranteed to be invoked only when the	2333	As with timers, the callback is guaranteed to be invoked only when the
1989	point in time where it is supposed to trigger has passed. If multiple	2334	point in time where it is supposed to trigger has passed. If multiple
1990	timers become ready during the same loop iteration then the ones with	2335	timers become ready during the same loop iteration then the ones with
1991	earlier time-out values are invoked before ones with later time-out values	2336	earlier time-out values are invoked before ones with later time-out values
1992	(but this is no longer true when a callback calls C<ev_loop> recursively).	2337	(but this is no longer true when a callback calls C<ev_run> recursively).
1993		2338
1994	=head3 Watcher-Specific Functions and Data Members	2339	=head3 Watcher-Specific Functions and Data Members
1995		2340
1996	=over 4	2341	=over 4
1997		2342
…		…
2032		2377
2033	Another way to think about it (for the mathematically inclined) is that	2378	Another way to think about it (for the mathematically inclined) is that
2034	C<ev_periodic> will try to run the callback in this mode at the next possible	2379	C<ev_periodic> will try to run the callback in this mode at the next possible
2035	time where C<time = offset (mod interval)>, regardless of any time jumps.	2380	time where C<time = offset (mod interval)>, regardless of any time jumps.
2036		2381
2037	For numerical stability it is preferable that the C<offset> value is near	2382	The C<interval> I<MUST> be positive, and for numerical stability, the
2038	C<ev_now ()> (the current time), but there is no range requirement for	2383	interval value should be higher than C<1/8192> (which is around 100
2039	this value, and in fact is often specified as zero.	2384	microseconds) and C<offset> should be higher than C<0> and should have
		2385	at most a similar magnitude as the current time (say, within a factor of
		2386	ten). Typical values for offset are, in fact, C<0> or something between
		2387	C<0> and C<interval>, which is also the recommended range.
2040		2388
2041	Note also that there is an upper limit to how often a timer can fire (CPU	2389	Note also that there is an upper limit to how often a timer can fire (CPU
2042	speed for example), so if C<interval> is very small then timing stability	2390	speed for example), so if C<interval> is very small then timing stability
2043	will of course deteriorate. Libev itself tries to be exact to be about one	2391	will of course deteriorate. Libev itself tries to be exact to be about one
2044	millisecond (if the OS supports it and the machine is fast enough).	2392	millisecond (if the OS supports it and the machine is fast enough).
…		…
2074		2422
2075	NOTE: I<< This callback must always return a time that is higher than or	2423	NOTE: I<< This callback must always return a time that is higher than or
2076	equal to the passed C<now> value >>.	2424	equal to the passed C<now> value >>.
2077		2425
2078	This can be used to create very complex timers, such as a timer that	2426	This can be used to create very complex timers, such as a timer that
2079	triggers on "next midnight, local time". To do this, you would calculate the	2427	triggers on "next midnight, local time". To do this, you would calculate
2080	next midnight after C<now> and return the timestamp value for this. How	2428	the next midnight after C<now> and return the timestamp value for
2081	you do this is, again, up to you (but it is not trivial, which is the main	2429	this. Here is a (completely untested, no error checking) example on how to
2082	reason I omitted it as an example).	2430	do this:
		2431
		2432	#include <time.h>
		2433
		2434	static ev_tstamp
		2435	my_rescheduler (ev_periodic *w, ev_tstamp now)
		2436	{
		2437	time_t tnow = (time_t)now;
		2438	struct tm tm;
		2439	localtime_r (&tnow, &tm);
		2440
		2441	tm.tm_sec = tm.tm_min = tm.tm_hour = 0; // midnight current day
		2442	++tm.tm_mday; // midnight next day
		2443
		2444	return mktime (&tm);
		2445	}
		2446
		2447	Note: this code might run into trouble on days that have more then two
		2448	midnights (beginning and end).
2083		2449
2084	=back	2450	=back
2085		2451
2086	=item ev_periodic_again (loop, ev_periodic *)	2452	=item ev_periodic_again (loop, ev_periodic *)
2087		2453
…		…
2152		2518
2153	ev_periodic hourly_tick;	2519	ev_periodic hourly_tick;
2154	ev_periodic_init (&hourly_tick, clock_cb,	2520	ev_periodic_init (&hourly_tick, clock_cb,
2155	fmod (ev_now (loop), 3600.), 3600., 0);	2521	fmod (ev_now (loop), 3600.), 3600., 0);
2156	ev_periodic_start (loop, &hourly_tick);	2522	ev_periodic_start (loop, &hourly_tick);
2157		2523
2158		2524
2159	=head2 C<ev_signal> - signal me when a signal gets signalled!	2525	=head2 C<ev_signal> - signal me when a signal gets signalled!
2160		2526
2161	Signal watchers will trigger an event when the process receives a specific	2527	Signal watchers will trigger an event when the process receives a specific
2162	signal one or more times. Even though signals are very asynchronous, libev	2528	signal one or more times. Even though signals are very asynchronous, libev
2163	will try it's best to deliver signals synchronously, i.e. as part of the	2529	will try its best to deliver signals synchronously, i.e. as part of the
2164	normal event processing, like any other event.	2530	normal event processing, like any other event.
2165		2531
2166	If you want signals to be delivered truly asynchronously, just use	2532	If you want signals to be delivered truly asynchronously, just use
2167	C<sigaction> as you would do without libev and forget about sharing	2533	C<sigaction> as you would do without libev and forget about sharing
2168	the signal. You can even use C<ev_async> from a signal handler to	2534	the signal. You can even use C<ev_async> from a signal handler to
…		…
2172	only within the same loop, i.e. you can watch for C<SIGINT> in your	2538	only within the same loop, i.e. you can watch for C<SIGINT> in your
2173	default loop and for C<SIGIO> in another loop, but you cannot watch for	2539	default loop and for C<SIGIO> in another loop, but you cannot watch for
2174	C<SIGINT> in both the default loop and another loop at the same time. At	2540	C<SIGINT> in both the default loop and another loop at the same time. At
2175	the moment, C<SIGCHLD> is permanently tied to the default loop.	2541	the moment, C<SIGCHLD> is permanently tied to the default loop.
2176		2542
2177	When the first watcher gets started will libev actually register something	2543	Only after the first watcher for a signal is started will libev actually
2178	with the kernel (thus it coexists with your own signal handlers as long as	2544	register something with the kernel. It thus coexists with your own signal
2179	you don't register any with libev for the same signal).	2545	handlers as long as you don't register any with libev for the same signal.
2180		2546
2181	If possible and supported, libev will install its handlers with	2547	If possible and supported, libev will install its handlers with
2182	C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should	2548	C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should
2183	not be unduly interrupted. If you have a problem with system calls getting	2549	not be unduly interrupted. If you have a problem with system calls getting
2184	interrupted by signals you can block all signals in an C<ev_check> watcher	2550	interrupted by signals you can block all signals in an C<ev_check> watcher
…		…
2187	=head3 The special problem of inheritance over fork/execve/pthread_create	2553	=head3 The special problem of inheritance over fork/execve/pthread_create
2188		2554
2189	Both the signal mask (C<sigprocmask>) and the signal disposition	2555	Both the signal mask (C<sigprocmask>) and the signal disposition
2190	(C<sigaction>) are unspecified after starting a signal watcher (and after	2556	(C<sigaction>) are unspecified after starting a signal watcher (and after
2191	stopping it again), that is, libev might or might not block the signal,	2557	stopping it again), that is, libev might or might not block the signal,
2192	and might or might not set or restore the installed signal handler.	2558	and might or might not set or restore the installed signal handler (but
		2559	see C<EVFLAG_NOSIGMASK>).
2193		2560
2194	While this does not matter for the signal disposition (libev never	2561	While this does not matter for the signal disposition (libev never
2195	sets signals to C<SIG_IGN>, so handlers will be reset to C<SIG_DFL> on	2562	sets signals to C<SIG_IGN>, so handlers will be reset to C<SIG_DFL> on
2196	C<execve>), this matters for the signal mask: many programs do not expect	2563	C<execve>), this matters for the signal mask: many programs do not expect
2197	certain signals to be blocked.	2564	certain signals to be blocked.
…		…
2211		2578
2212	So I can't stress this enough: I<If you do not reset your signal mask when	2579	So I can't stress this enough: I<If you do not reset your signal mask when
2213	you expect it to be empty, you have a race condition in your code>. This	2580	you expect it to be empty, you have a race condition in your code>. This
2214	is not a libev-specific thing, this is true for most event libraries.	2581	is not a libev-specific thing, this is true for most event libraries.
2215		2582
		2583	=head3 The special problem of threads signal handling
		2584
		2585	POSIX threads has problematic signal handling semantics, specifically,
		2586	a lot of functionality (sigfd, sigwait etc.) only really works if all
		2587	threads in a process block signals, which is hard to achieve.
		2588
		2589	When you want to use sigwait (or mix libev signal handling with your own
		2590	for the same signals), you can tackle this problem by globally blocking
		2591	all signals before creating any threads (or creating them with a fully set
		2592	sigprocmask) and also specifying the C<EVFLAG_NOSIGMASK> when creating
		2593	loops. Then designate one thread as "signal receiver thread" which handles
		2594	these signals. You can pass on any signals that libev might be interested
		2595	in by calling C<ev_feed_signal>.
		2596
2216	=head3 Watcher-Specific Functions and Data Members	2597	=head3 Watcher-Specific Functions and Data Members
2217		2598
2218	=over 4	2599	=over 4
2219		2600
2220	=item ev_signal_init (ev_signal *, callback, int signum)	2601	=item ev_signal_init (ev_signal *, callback, int signum)
…		…
2235	Example: Try to exit cleanly on SIGINT.	2616	Example: Try to exit cleanly on SIGINT.
2236		2617
2237	static void	2618	static void
2238	sigint_cb (struct ev_loop *loop, ev_signal *w, int revents)	2619	sigint_cb (struct ev_loop *loop, ev_signal *w, int revents)
2239	{	2620	{
2240	ev_unloop (loop, EVUNLOOP_ALL);	2621	ev_break (loop, EVBREAK_ALL);
2241	}	2622	}
2242		2623
2243	ev_signal signal_watcher;	2624	ev_signal signal_watcher;
2244	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);	2625	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
2245	ev_signal_start (loop, &signal_watcher);	2626	ev_signal_start (loop, &signal_watcher);
…		…
2354		2735
2355	=head2 C<ev_stat> - did the file attributes just change?	2736	=head2 C<ev_stat> - did the file attributes just change?
2356		2737
2357	This watches a file system path for attribute changes. That is, it calls	2738	This watches a file system path for attribute changes. That is, it calls
2358	C<stat> on that path in regular intervals (or when the OS says it changed)	2739	C<stat> on that path in regular intervals (or when the OS says it changed)
2359	and sees if it changed compared to the last time, invoking the callback if	2740	and sees if it changed compared to the last time, invoking the callback
2360	it did.	2741	if it did. Starting the watcher C<stat>'s the file, so only changes that
		2742	happen after the watcher has been started will be reported.
2361		2743
2362	The path does not need to exist: changing from "path exists" to "path does	2744	The path does not need to exist: changing from "path exists" to "path does
2363	not exist" is a status change like any other. The condition "path does not	2745	not exist" is a status change like any other. The condition "path does not
2364	exist" (or more correctly "path cannot be stat'ed") is signified by the	2746	exist" (or more correctly "path cannot be stat'ed") is signified by the
2365	C<st_nlink> field being zero (which is otherwise always forced to be at	2747	C<st_nlink> field being zero (which is otherwise always forced to be at
…		…
2595	Apart from keeping your process non-blocking (which is a useful	2977	Apart from keeping your process non-blocking (which is a useful
2596	effect on its own sometimes), idle watchers are a good place to do	2978	effect on its own sometimes), idle watchers are a good place to do
2597	"pseudo-background processing", or delay processing stuff to after the	2979	"pseudo-background processing", or delay processing stuff to after the
2598	event loop has handled all outstanding events.	2980	event loop has handled all outstanding events.
2599		2981
		2982	=head3 Abusing an C<ev_idle> watcher for its side-effect
		2983
		2984	As long as there is at least one active idle watcher, libev will never
		2985	sleep unnecessarily. Or in other words, it will loop as fast as possible.
		2986	For this to work, the idle watcher doesn't need to be invoked at all - the
		2987	lowest priority will do.
		2988
		2989	This mode of operation can be useful together with an C<ev_check> watcher,
		2990	to do something on each event loop iteration - for example to balance load
		2991	between different connections.
		2992
		2993	See L</Abusing an ev_check watcher for its side-effect> for a longer
		2994	example.
		2995
2600	=head3 Watcher-Specific Functions and Data Members	2996	=head3 Watcher-Specific Functions and Data Members
2601		2997
2602	=over 4	2998	=over 4
2603		2999
2604	=item ev_idle_init (ev_idle *, callback)	3000	=item ev_idle_init (ev_idle *, callback)
…		…
2615	callback, free it. Also, use no error checking, as usual.	3011	callback, free it. Also, use no error checking, as usual.
2616		3012
2617	static void	3013	static void
2618	idle_cb (struct ev_loop *loop, ev_idle *w, int revents)	3014	idle_cb (struct ev_loop *loop, ev_idle *w, int revents)
2619	{	3015	{
		3016	// stop the watcher
		3017	ev_idle_stop (loop, w);
		3018
		3019	// now we can free it
2620	free (w);	3020	free (w);
		3021
2621	// now do something you wanted to do when the program has	3022	// now do something you wanted to do when the program has
2622	// no longer anything immediate to do.	3023	// no longer anything immediate to do.
2623	}	3024	}
2624		3025
2625	ev_idle *idle_watcher = malloc (sizeof (ev_idle));	3026	ev_idle *idle_watcher = malloc (sizeof (ev_idle));
…		…
2627	ev_idle_start (loop, idle_watcher);	3028	ev_idle_start (loop, idle_watcher);
2628		3029
2629		3030
2630	=head2 C<ev_prepare> and C<ev_check> - customise your event loop!	3031	=head2 C<ev_prepare> and C<ev_check> - customise your event loop!
2631		3032
2632	Prepare and check watchers are usually (but not always) used in pairs:	3033	Prepare and check watchers are often (but not always) used in pairs:
2633	prepare watchers get invoked before the process blocks and check watchers	3034	prepare watchers get invoked before the process blocks and check watchers
2634	afterwards.	3035	afterwards.
2635		3036
2636	You I<must not> call C<ev_loop> or similar functions that enter	3037	You I<must not> call C<ev_run> (or similar functions that enter the
2637	the current event loop from either C<ev_prepare> or C<ev_check>	3038	current event loop) or C<ev_loop_fork> from either C<ev_prepare> or
2638	watchers. Other loops than the current one are fine, however. The	3039	C<ev_check> watchers. Other loops than the current one are fine,
2639	rationale behind this is that you do not need to check for recursion in	3040	however. The rationale behind this is that you do not need to check
2640	those watchers, i.e. the sequence will always be C<ev_prepare>, blocking,	3041	for recursion in those watchers, i.e. the sequence will always be
2641	C<ev_check> so if you have one watcher of each kind they will always be	3042	C<ev_prepare>, blocking, C<ev_check> so if you have one watcher of each
2642	called in pairs bracketing the blocking call.	3043	kind they will always be called in pairs bracketing the blocking call.
2643		3044
2644	Their main purpose is to integrate other event mechanisms into libev and	3045	Their main purpose is to integrate other event mechanisms into libev and
2645	their use is somewhat advanced. They could be used, for example, to track	3046	their use is somewhat advanced. They could be used, for example, to track
2646	variable changes, implement your own watchers, integrate net-snmp or a	3047	variable changes, implement your own watchers, integrate net-snmp or a
2647	coroutine library and lots more. They are also occasionally useful if	3048	coroutine library and lots more. They are also occasionally useful if
…		…
2665	with priority higher than or equal to the event loop and one coroutine	3066	with priority higher than or equal to the event loop and one coroutine
2666	of lower priority, but only once, using idle watchers to keep the event	3067	of lower priority, but only once, using idle watchers to keep the event
2667	loop from blocking if lower-priority coroutines are active, thus mapping	3068	loop from blocking if lower-priority coroutines are active, thus mapping
2668	low-priority coroutines to idle/background tasks).	3069	low-priority coroutines to idle/background tasks).
2669		3070
2670	It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>)	3071	When used for this purpose, it is recommended to give C<ev_check> watchers
2671	priority, to ensure that they are being run before any other watchers	3072	highest (C<EV_MAXPRI>) priority, to ensure that they are being run before
2672	after the poll (this doesn't matter for C<ev_prepare> watchers).	3073	any other watchers after the poll (this doesn't matter for C<ev_prepare>
		3074	watchers).
2673		3075
2674	Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not	3076	Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not
2675	activate ("feed") events into libev. While libev fully supports this, they	3077	activate ("feed") events into libev. While libev fully supports this, they
2676	might get executed before other C<ev_check> watchers did their job. As	3078	might get executed before other C<ev_check> watchers did their job. As
2677	C<ev_check> watchers are often used to embed other (non-libev) event	3079	C<ev_check> watchers are often used to embed other (non-libev) event
2678	loops those other event loops might be in an unusable state until their	3080	loops those other event loops might be in an unusable state until their
2679	C<ev_check> watcher ran (always remind yourself to coexist peacefully with	3081	C<ev_check> watcher ran (always remind yourself to coexist peacefully with
2680	others).	3082	others).
		3083
		3084	=head3 Abusing an C<ev_check> watcher for its side-effect
		3085
		3086	C<ev_check> (and less often also C<ev_prepare>) watchers can also be
		3087	useful because they are called once per event loop iteration. For
		3088	example, if you want to handle a large number of connections fairly, you
		3089	normally only do a bit of work for each active connection, and if there
		3090	is more work to do, you wait for the next event loop iteration, so other
		3091	connections have a chance of making progress.
		3092
		3093	Using an C<ev_check> watcher is almost enough: it will be called on the
		3094	next event loop iteration. However, that isn't as soon as possible -
		3095	without external events, your C<ev_check> watcher will not be invoked.
		3096
		3097	This is where C<ev_idle> watchers come in handy - all you need is a
		3098	single global idle watcher that is active as long as you have one active
		3099	C<ev_check> watcher. The C<ev_idle> watcher makes sure the event loop
		3100	will not sleep, and the C<ev_check> watcher makes sure a callback gets
		3101	invoked. Neither watcher alone can do that.
2681		3102
2682	=head3 Watcher-Specific Functions and Data Members	3103	=head3 Watcher-Specific Functions and Data Members
2683		3104
2684	=over 4	3105	=over 4
2685		3106
…		…
2809		3230
2810	if (timeout >= 0)	3231	if (timeout >= 0)
2811	// create/start timer	3232	// create/start timer
2812		3233
2813	// poll	3234	// poll
2814	ev_loop (EV_A_ 0);	3235	ev_run (EV_A_ 0);
2815		3236
2816	// stop timer again	3237	// stop timer again
2817	if (timeout >= 0)	3238	if (timeout >= 0)
2818	ev_timer_stop (EV_A_ &to);	3239	ev_timer_stop (EV_A_ &to);
2819		3240
…		…
2886		3307
2887	=over 4	3308	=over 4
2888		3309
2889	=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)	3310	=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)
2890		3311
2891	=item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)	3312	=item ev_embed_set (ev_embed *, struct ev_loop *embedded_loop)
2892		3313
2893	Configures the watcher to embed the given loop, which must be	3314	Configures the watcher to embed the given loop, which must be
2894	embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be	3315	embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be
2895	invoked automatically, otherwise it is the responsibility of the callback	3316	invoked automatically, otherwise it is the responsibility of the callback
2896	to invoke it (it will continue to be called until the sweep has been done,	3317	to invoke it (it will continue to be called until the sweep has been done,
2897	if you do not want that, you need to temporarily stop the embed watcher).	3318	if you do not want that, you need to temporarily stop the embed watcher).
2898		3319
2899	=item ev_embed_sweep (loop, ev_embed *)	3320	=item ev_embed_sweep (loop, ev_embed *)
2900		3321
2901	Make a single, non-blocking sweep over the embedded loop. This works	3322	Make a single, non-blocking sweep over the embedded loop. This works
2902	similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most	3323	similarly to C<ev_run (embedded_loop, EVRUN_NOWAIT)>, but in the most
2903	appropriate way for embedded loops.	3324	appropriate way for embedded loops.
2904		3325
2905	=item struct ev_loop *other [read-only]	3326	=item struct ev_loop *other [read-only]
2906		3327
2907	The embedded event loop.	3328	The embedded event loop.
…		…
2917	used).	3338	used).
2918		3339
2919	struct ev_loop *loop_hi = ev_default_init (0);	3340	struct ev_loop *loop_hi = ev_default_init (0);
2920	struct ev_loop *loop_lo = 0;	3341	struct ev_loop *loop_lo = 0;
2921	ev_embed embed;	3342	ev_embed embed;
2922		3343
2923	// see if there is a chance of getting one that works	3344	// see if there is a chance of getting one that works
2924	// (remember that a flags value of 0 means autodetection)	3345	// (remember that a flags value of 0 means autodetection)
2925	loop_lo = ev_embeddable_backends () & ev_recommended_backends ()	3346	loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
2926	? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())	3347	? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
2927	: 0;	3348	: 0;
…		…
2941	C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).	3362	C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).
2942		3363
2943	struct ev_loop *loop = ev_default_init (0);	3364	struct ev_loop *loop = ev_default_init (0);
2944	struct ev_loop *loop_socket = 0;	3365	struct ev_loop *loop_socket = 0;
2945	ev_embed embed;	3366	ev_embed embed;
2946		3367
2947	if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)	3368	if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
2948	if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))	3369	if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
2949	{	3370	{
2950	ev_embed_init (&embed, 0, loop_socket);	3371	ev_embed_init (&embed, 0, loop_socket);
2951	ev_embed_start (loop, &embed);	3372	ev_embed_start (loop, &embed);
…		…
2959		3380
2960	=head2 C<ev_fork> - the audacity to resume the event loop after a fork	3381	=head2 C<ev_fork> - the audacity to resume the event loop after a fork
2961		3382
2962	Fork watchers are called when a C<fork ()> was detected (usually because	3383	Fork watchers are called when a C<fork ()> was detected (usually because
2963	whoever is a good citizen cared to tell libev about it by calling	3384	whoever is a good citizen cared to tell libev about it by calling
2964	C<ev_default_fork> or C<ev_loop_fork>). The invocation is done before the	3385	C<ev_loop_fork>). The invocation is done before the event loop blocks next
2965	event loop blocks next and before C<ev_check> watchers are being called,	3386	and before C<ev_check> watchers are being called, and only in the child
2966	and only in the child after the fork. If whoever good citizen calling	3387	after the fork. If whoever good citizen calling C<ev_default_fork> cheats
2967	C<ev_default_fork> cheats and calls it in the wrong process, the fork	3388	and calls it in the wrong process, the fork handlers will be invoked, too,
2968	handlers will be invoked, too, of course.	3389	of course.
2969		3390
2970	=head3 The special problem of life after fork - how is it possible?	3391	=head3 The special problem of life after fork - how is it possible?
2971		3392
2972	Most uses of C<fork()> consist of forking, then some simple calls to set	3393	Most uses of C<fork ()> consist of forking, then some simple calls to set
2973	up/change the process environment, followed by a call to C<exec()>. This	3394	up/change the process environment, followed by a call to C<exec()>. This
2974	sequence should be handled by libev without any problems.	3395	sequence should be handled by libev without any problems.
2975		3396
2976	This changes when the application actually wants to do event handling	3397	This changes when the application actually wants to do event handling
2977	in the child, or both parent in child, in effect "continuing" after the	3398	in the child, or both parent in child, in effect "continuing" after the
…		…
2993	disadvantage of having to use multiple event loops (which do not support	3414	disadvantage of having to use multiple event loops (which do not support
2994	signal watchers).	3415	signal watchers).
2995		3416
2996	When this is not possible, or you want to use the default loop for	3417	When this is not possible, or you want to use the default loop for
2997	other reasons, then in the process that wants to start "fresh", call	3418	other reasons, then in the process that wants to start "fresh", call
2998	C<ev_default_destroy ()> followed by C<ev_default_loop (...)>. Destroying	3419	C<ev_loop_destroy (EV_DEFAULT)> followed by C<ev_default_loop (...)>.
2999	the default loop will "orphan" (not stop) all registered watchers, so you	3420	Destroying the default loop will "orphan" (not stop) all registered
3000	have to be careful not to execute code that modifies those watchers. Note	3421	watchers, so you have to be careful not to execute code that modifies
3001	also that in that case, you have to re-register any signal watchers.	3422	those watchers. Note also that in that case, you have to re-register any
		3423	signal watchers.
3002		3424
3003	=head3 Watcher-Specific Functions and Data Members	3425	=head3 Watcher-Specific Functions and Data Members
3004		3426
3005	=over 4	3427	=over 4
3006		3428
3007	=item ev_fork_init (ev_signal *, callback)	3429	=item ev_fork_init (ev_fork *, callback)
3008		3430
3009	Initialises and configures the fork watcher - it has no parameters of any	3431	Initialises and configures the fork watcher - it has no parameters of any
3010	kind. There is a C<ev_fork_set> macro, but using it is utterly pointless,	3432	kind. There is a C<ev_fork_set> macro, but using it is utterly pointless,
3011	believe me.	3433	really.
3012		3434
3013	=back	3435	=back
		3436
		3437
		3438	=head2 C<ev_cleanup> - even the best things end
		3439
		3440	Cleanup watchers are called just before the event loop is being destroyed
		3441	by a call to C<ev_loop_destroy>.
		3442
		3443	While there is no guarantee that the event loop gets destroyed, cleanup
		3444	watchers provide a convenient method to install cleanup hooks for your
		3445	program, worker threads and so on - you just to make sure to destroy the
		3446	loop when you want them to be invoked.
		3447
		3448	Cleanup watchers are invoked in the same way as any other watcher. Unlike
		3449	all other watchers, they do not keep a reference to the event loop (which
		3450	makes a lot of sense if you think about it). Like all other watchers, you
		3451	can call libev functions in the callback, except C<ev_cleanup_start>.
		3452
		3453	=head3 Watcher-Specific Functions and Data Members
		3454
		3455	=over 4
		3456
		3457	=item ev_cleanup_init (ev_cleanup *, callback)
		3458
		3459	Initialises and configures the cleanup watcher - it has no parameters of
		3460	any kind. There is a C<ev_cleanup_set> macro, but using it is utterly
		3461	pointless, I assure you.
		3462
		3463	=back
		3464
		3465	Example: Register an atexit handler to destroy the default loop, so any
		3466	cleanup functions are called.
		3467
		3468	static void
		3469	program_exits (void)
		3470	{
		3471	ev_loop_destroy (EV_DEFAULT_UC);
		3472	}
		3473
		3474	...
		3475	atexit (program_exits);
3014		3476
3015		3477
3016	=head2 C<ev_async> - how to wake up an event loop	3478	=head2 C<ev_async> - how to wake up an event loop
3017		3479
3018	In general, you cannot use an C<ev_loop> from multiple threads or other	3480	In general, you cannot use an C<ev_loop> from multiple threads or other
…		…
3025	it by calling C<ev_async_send>, which is thread- and signal safe.	3487	it by calling C<ev_async_send>, which is thread- and signal safe.
3026		3488
3027	This functionality is very similar to C<ev_signal> watchers, as signals,	3489	This functionality is very similar to C<ev_signal> watchers, as signals,
3028	too, are asynchronous in nature, and signals, too, will be compressed	3490	too, are asynchronous in nature, and signals, too, will be compressed
3029	(i.e. the number of callback invocations may be less than the number of	3491	(i.e. the number of callback invocations may be less than the number of
3030	C<ev_async_sent> calls).	3492	C<ev_async_send> calls). In fact, you could use signal watchers as a kind
3031		3493	of "global async watchers" by using a watcher on an otherwise unused
3032	Unlike C<ev_signal> watchers, C<ev_async> works with any event loop, not	3494	signal, and C<ev_feed_signal> to signal this watcher from another thread,
3033	just the default loop.	3495	even without knowing which loop owns the signal.
3034		3496
3035	=head3 Queueing	3497	=head3 Queueing
3036		3498
3037	C<ev_async> does not support queueing of data in any way. The reason	3499	C<ev_async> does not support queueing of data in any way. The reason
3038	is that the author does not know of a simple (or any) algorithm for a	3500	is that the author does not know of a simple (or any) algorithm for a
…		…
3130	trust me.	3592	trust me.
3131		3593
3132	=item ev_async_send (loop, ev_async *)	3594	=item ev_async_send (loop, ev_async *)
3133		3595
3134	Sends/signals/activates the given C<ev_async> watcher, that is, feeds	3596	Sends/signals/activates the given C<ev_async> watcher, that is, feeds
3135	an C<EV_ASYNC> event on the watcher into the event loop. Unlike	3597	an C<EV_ASYNC> event on the watcher into the event loop, and instantly
		3598	returns.
		3599
3136	C<ev_feed_event>, this call is safe to do from other threads, signal or	3600	Unlike C<ev_feed_event>, this call is safe to do from other threads,
3137	similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding	3601	signal or similar contexts (see the discussion of C<EV_ATOMIC_T> in the
3138	section below on what exactly this means).	3602	embedding section below on what exactly this means).
3139		3603
3140	Note that, as with other watchers in libev, multiple events might get	3604	Note that, as with other watchers in libev, multiple events might get
3141	compressed into a single callback invocation (another way to look at this	3605	compressed into a single callback invocation (another way to look at
3142	is that C<ev_async> watchers are level-triggered, set on C<ev_async_send>,	3606	this is that C<ev_async> watchers are level-triggered: they are set on
3143	reset when the event loop detects that).	3607	C<ev_async_send>, reset when the event loop detects that).
3144		3608
3145	This call incurs the overhead of a system call only once per event loop	3609	This call incurs the overhead of at most one extra system call per event
3146	iteration, so while the overhead might be noticeable, it doesn't apply to	3610	loop iteration, if the event loop is blocked, and no syscall at all if
3147	repeated calls to C<ev_async_send> for the same event loop.	3611	the event loop (or your program) is processing events. That means that
		3612	repeated calls are basically free (there is no need to avoid calls for
		3613	performance reasons) and that the overhead becomes smaller (typically
		3614	zero) under load.
3148		3615
3149	=item bool = ev_async_pending (ev_async *)	3616	=item bool = ev_async_pending (ev_async *)
3150		3617
3151	Returns a non-zero value when C<ev_async_send> has been called on the	3618	Returns a non-zero value when C<ev_async_send> has been called on the
3152	watcher but the event has not yet been processed (or even noted) by the	3619	watcher but the event has not yet been processed (or even noted) by the
…		…
3169		3636
3170	There are some other functions of possible interest. Described. Here. Now.	3637	There are some other functions of possible interest. Described. Here. Now.
3171		3638
3172	=over 4	3639	=over 4
3173		3640
3174	=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback)	3641	=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback, arg)
3175		3642
3176	This function combines a simple timer and an I/O watcher, calls your	3643	This function combines a simple timer and an I/O watcher, calls your
3177	callback on whichever event happens first and automatically stops both	3644	callback on whichever event happens first and automatically stops both
3178	watchers. This is useful if you want to wait for a single event on an fd	3645	watchers. This is useful if you want to wait for a single event on an fd
3179	or timeout without having to allocate/configure/start/stop/free one or	3646	or timeout without having to allocate/configure/start/stop/free one or
…		…
3207	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);	3674	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
3208		3675
3209	=item ev_feed_fd_event (loop, int fd, int revents)	3676	=item ev_feed_fd_event (loop, int fd, int revents)
3210		3677
3211	Feed an event on the given fd, as if a file descriptor backend detected	3678	Feed an event on the given fd, as if a file descriptor backend detected
3212	the given events it.	3679	the given events.
3213		3680
3214	=item ev_feed_signal_event (loop, int signum)	3681	=item ev_feed_signal_event (loop, int signum)
3215		3682
3216	Feed an event as if the given signal occurred (C<loop> must be the default	3683	Feed an event as if the given signal occurred. See also C<ev_feed_signal>,
3217	loop!).	3684	which is async-safe.
3218		3685
3219	=back	3686	=back
		3687
		3688
		3689	=head1 COMMON OR USEFUL IDIOMS (OR BOTH)
		3690
		3691	This section explains some common idioms that are not immediately
		3692	obvious. Note that examples are sprinkled over the whole manual, and this
		3693	section only contains stuff that wouldn't fit anywhere else.
		3694
		3695	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
		3696
		3697	Each watcher has, by default, a C<void *data> member that you can read
		3698	or modify at any time: libev will completely ignore it. This can be used
		3699	to associate arbitrary data with your watcher. If you need more data and
		3700	don't want to allocate memory separately and store a pointer to it in that
		3701	data member, you can also "subclass" the watcher type and provide your own
		3702	data:
		3703
		3704	struct my_io
		3705	{
		3706	ev_io io;
		3707	int otherfd;
		3708	void *somedata;
		3709	struct whatever *mostinteresting;
		3710	};
		3711
		3712	...
		3713	struct my_io w;
		3714	ev_io_init (&w.io, my_cb, fd, EV_READ);
		3715
		3716	And since your callback will be called with a pointer to the watcher, you
		3717	can cast it back to your own type:
		3718
		3719	static void my_cb (struct ev_loop *loop, ev_io *w_, int revents)
		3720	{
		3721	struct my_io *w = (struct my_io *)w_;
		3722	...
		3723	}
		3724
		3725	More interesting and less C-conformant ways of casting your callback
		3726	function type instead have been omitted.
		3727
		3728	=head2 BUILDING YOUR OWN COMPOSITE WATCHERS
		3729
		3730	Another common scenario is to use some data structure with multiple
		3731	embedded watchers, in effect creating your own watcher that combines
		3732	multiple libev event sources into one "super-watcher":
		3733
		3734	struct my_biggy
		3735	{
		3736	int some_data;
		3737	ev_timer t1;
		3738	ev_timer t2;
		3739	}
		3740
		3741	In this case getting the pointer to C<my_biggy> is a bit more
		3742	complicated: Either you store the address of your C<my_biggy> struct in
		3743	the C<data> member of the watcher (for woozies or C++ coders), or you need
		3744	to use some pointer arithmetic using C<offsetof> inside your watchers (for
		3745	real programmers):
		3746
		3747	#include <stddef.h>
		3748
		3749	static void
		3750	t1_cb (EV_P_ ev_timer *w, int revents)
		3751	{
		3752	struct my_biggy big = (struct my_biggy *)
		3753	(((char *)w) - offsetof (struct my_biggy, t1));
		3754	}
		3755
		3756	static void
		3757	t2_cb (EV_P_ ev_timer *w, int revents)
		3758	{
		3759	struct my_biggy big = (struct my_biggy *)
		3760	(((char *)w) - offsetof (struct my_biggy, t2));
		3761	}
		3762
		3763	=head2 AVOIDING FINISHING BEFORE RETURNING
		3764
		3765	Often you have structures like this in event-based programs:
		3766
		3767	callback ()
		3768	{
		3769	free (request);
		3770	}
		3771
		3772	request = start_new_request (..., callback);
		3773
		3774	The intent is to start some "lengthy" operation. The C<request> could be
		3775	used to cancel the operation, or do other things with it.
		3776
		3777	It's not uncommon to have code paths in C<start_new_request> that
		3778	immediately invoke the callback, for example, to report errors. Or you add
		3779	some caching layer that finds that it can skip the lengthy aspects of the
		3780	operation and simply invoke the callback with the result.
		3781
		3782	The problem here is that this will happen I<before> C<start_new_request>
		3783	has returned, so C<request> is not set.
		3784
		3785	Even if you pass the request by some safer means to the callback, you
		3786	might want to do something to the request after starting it, such as
		3787	canceling it, which probably isn't working so well when the callback has
		3788	already been invoked.
		3789
		3790	A common way around all these issues is to make sure that
		3791	C<start_new_request> I<always> returns before the callback is invoked. If
		3792	C<start_new_request> immediately knows the result, it can artificially
		3793	delay invoking the callback by using a C<prepare> or C<idle> watcher for
		3794	example, or more sneakily, by reusing an existing (stopped) watcher and
		3795	pushing it into the pending queue:
		3796
		3797	ev_set_cb (watcher, callback);
		3798	ev_feed_event (EV_A_ watcher, 0);
		3799
		3800	This way, C<start_new_request> can safely return before the callback is
		3801	invoked, while not delaying callback invocation too much.
		3802
		3803	=head2 MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS
		3804
		3805	Often (especially in GUI toolkits) there are places where you have
		3806	I<modal> interaction, which is most easily implemented by recursively
		3807	invoking C<ev_run>.
		3808
		3809	This brings the problem of exiting - a callback might want to finish the
		3810	main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but
		3811	a modal "Are you sure?" dialog is still waiting), or just the nested one
		3812	and not the main one (e.g. user clocked "Ok" in a modal dialog), or some
		3813	other combination: In these cases, a simple C<ev_break> will not work.
		3814
		3815	The solution is to maintain "break this loop" variable for each C<ev_run>
		3816	invocation, and use a loop around C<ev_run> until the condition is
		3817	triggered, using C<EVRUN_ONCE>:
		3818
		3819	// main loop
		3820	int exit_main_loop = 0;
		3821
		3822	while (!exit_main_loop)
		3823	ev_run (EV_DEFAULT_ EVRUN_ONCE);
		3824
		3825	// in a modal watcher
		3826	int exit_nested_loop = 0;
		3827
		3828	while (!exit_nested_loop)
		3829	ev_run (EV_A_ EVRUN_ONCE);
		3830
		3831	To exit from any of these loops, just set the corresponding exit variable:
		3832
		3833	// exit modal loop
		3834	exit_nested_loop = 1;
		3835
		3836	// exit main program, after modal loop is finished
		3837	exit_main_loop = 1;
		3838
		3839	// exit both
		3840	exit_main_loop = exit_nested_loop = 1;
		3841
		3842	=head2 THREAD LOCKING EXAMPLE
		3843
		3844	Here is a fictitious example of how to run an event loop in a different
		3845	thread from where callbacks are being invoked and watchers are
		3846	created/added/removed.
		3847
		3848	For a real-world example, see the C<EV::Loop::Async> perl module,
		3849	which uses exactly this technique (which is suited for many high-level
		3850	languages).
		3851
		3852	The example uses a pthread mutex to protect the loop data, a condition
		3853	variable to wait for callback invocations, an async watcher to notify the
		3854	event loop thread and an unspecified mechanism to wake up the main thread.
		3855
		3856	First, you need to associate some data with the event loop:
		3857
		3858	typedef struct {
		3859	mutex_t lock; /* global loop lock */
		3860	ev_async async_w;
		3861	thread_t tid;
		3862	cond_t invoke_cv;
		3863	} userdata;
		3864
		3865	void prepare_loop (EV_P)
		3866	{
		3867	// for simplicity, we use a static userdata struct.
		3868	static userdata u;
		3869
		3870	ev_async_init (&u->async_w, async_cb);
		3871	ev_async_start (EV_A_ &u->async_w);
		3872
		3873	pthread_mutex_init (&u->lock, 0);
		3874	pthread_cond_init (&u->invoke_cv, 0);
		3875
		3876	// now associate this with the loop
		3877	ev_set_userdata (EV_A_ u);
		3878	ev_set_invoke_pending_cb (EV_A_ l_invoke);
		3879	ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
		3880
		3881	// then create the thread running ev_run
		3882	pthread_create (&u->tid, 0, l_run, EV_A);
		3883	}
		3884
		3885	The callback for the C<ev_async> watcher does nothing: the watcher is used
		3886	solely to wake up the event loop so it takes notice of any new watchers
		3887	that might have been added:
		3888
		3889	static void
		3890	async_cb (EV_P_ ev_async *w, int revents)
		3891	{
		3892	// just used for the side effects
		3893	}
		3894
		3895	The C<l_release> and C<l_acquire> callbacks simply unlock/lock the mutex
		3896	protecting the loop data, respectively.
		3897
		3898	static void
		3899	l_release (EV_P)
		3900	{
		3901	userdata *u = ev_userdata (EV_A);
		3902	pthread_mutex_unlock (&u->lock);
		3903	}
		3904
		3905	static void
		3906	l_acquire (EV_P)
		3907	{
		3908	userdata *u = ev_userdata (EV_A);
		3909	pthread_mutex_lock (&u->lock);
		3910	}
		3911
		3912	The event loop thread first acquires the mutex, and then jumps straight
		3913	into C<ev_run>:
		3914
		3915	void *
		3916	l_run (void *thr_arg)
		3917	{
		3918	struct ev_loop *loop = (struct ev_loop *)thr_arg;
		3919
		3920	l_acquire (EV_A);
		3921	pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
		3922	ev_run (EV_A_ 0);
		3923	l_release (EV_A);
		3924
		3925	return 0;
		3926	}
		3927
		3928	Instead of invoking all pending watchers, the C<l_invoke> callback will
		3929	signal the main thread via some unspecified mechanism (signals? pipe
		3930	writes? C<Async::Interrupt>?) and then waits until all pending watchers
		3931	have been called (in a while loop because a) spurious wakeups are possible
		3932	and b) skipping inter-thread-communication when there are no pending
		3933	watchers is very beneficial):
		3934
		3935	static void
		3936	l_invoke (EV_P)
		3937	{
		3938	userdata *u = ev_userdata (EV_A);
		3939
		3940	while (ev_pending_count (EV_A))
		3941	{
		3942	wake_up_other_thread_in_some_magic_or_not_so_magic_way ();
		3943	pthread_cond_wait (&u->invoke_cv, &u->lock);
		3944	}
		3945	}
		3946
		3947	Now, whenever the main thread gets told to invoke pending watchers, it
		3948	will grab the lock, call C<ev_invoke_pending> and then signal the loop
		3949	thread to continue:
		3950
		3951	static void
		3952	real_invoke_pending (EV_P)
		3953	{
		3954	userdata *u = ev_userdata (EV_A);
		3955
		3956	pthread_mutex_lock (&u->lock);
		3957	ev_invoke_pending (EV_A);
		3958	pthread_cond_signal (&u->invoke_cv);
		3959	pthread_mutex_unlock (&u->lock);
		3960	}
		3961
		3962	Whenever you want to start/stop a watcher or do other modifications to an
		3963	event loop, you will now have to lock:
		3964
		3965	ev_timer timeout_watcher;
		3966	userdata *u = ev_userdata (EV_A);
		3967
		3968	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
		3969
		3970	pthread_mutex_lock (&u->lock);
		3971	ev_timer_start (EV_A_ &timeout_watcher);
		3972	ev_async_send (EV_A_ &u->async_w);
		3973	pthread_mutex_unlock (&u->lock);
		3974
		3975	Note that sending the C<ev_async> watcher is required because otherwise
		3976	an event loop currently blocking in the kernel will have no knowledge
		3977	about the newly added timer. By waking up the loop it will pick up any new
		3978	watchers in the next event loop iteration.
		3979
		3980	=head2 THREADS, COROUTINES, CONTINUATIONS, QUEUES... INSTEAD OF CALLBACKS
		3981
		3982	While the overhead of a callback that e.g. schedules a thread is small, it
		3983	is still an overhead. If you embed libev, and your main usage is with some
		3984	kind of threads or coroutines, you might want to customise libev so that
		3985	doesn't need callbacks anymore.
		3986
		3987	Imagine you have coroutines that you can switch to using a function
		3988	C<switch_to (coro)>, that libev runs in a coroutine called C<libev_coro>
		3989	and that due to some magic, the currently active coroutine is stored in a
		3990	global called C<current_coro>. Then you can build your own "wait for libev
		3991	event" primitive by changing C<EV_CB_DECLARE> and C<EV_CB_INVOKE> (note
		3992	the differing C<;> conventions):
		3993
		3994	#define EV_CB_DECLARE(type) struct my_coro *cb;
		3995	#define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb)
		3996
		3997	That means instead of having a C callback function, you store the
		3998	coroutine to switch to in each watcher, and instead of having libev call
		3999	your callback, you instead have it switch to that coroutine.
		4000
		4001	A coroutine might now wait for an event with a function called
		4002	C<wait_for_event>. (the watcher needs to be started, as always, but it doesn't
		4003	matter when, or whether the watcher is active or not when this function is
		4004	called):
		4005
		4006	void
		4007	wait_for_event (ev_watcher *w)
		4008	{
		4009	ev_set_cb (w, current_coro);
		4010	switch_to (libev_coro);
		4011	}
		4012
		4013	That basically suspends the coroutine inside C<wait_for_event> and
		4014	continues the libev coroutine, which, when appropriate, switches back to
		4015	this or any other coroutine.
		4016
		4017	You can do similar tricks if you have, say, threads with an event queue -
		4018	instead of storing a coroutine, you store the queue object and instead of
		4019	switching to a coroutine, you push the watcher onto the queue and notify
		4020	any waiters.
		4021
		4022	To embed libev, see L</EMBEDDING>, but in short, it's easiest to create two
		4023	files, F<my_ev.h> and F<my_ev.c> that include the respective libev files:
		4024
		4025	// my_ev.h
		4026	#define EV_CB_DECLARE(type) struct my_coro *cb;
		4027	#define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb)
		4028	#include "../libev/ev.h"
		4029
		4030	// my_ev.c
		4031	#define EV_H "my_ev.h"
		4032	#include "../libev/ev.c"
		4033
		4034	And then use F<my_ev.h> when you would normally use F<ev.h>, and compile
		4035	F<my_ev.c> into your project. When properly specifying include paths, you
		4036	can even use F<ev.h> as header file name directly.
3220		4037
3221		4038
3222	=head1 LIBEVENT EMULATION	4039	=head1 LIBEVENT EMULATION
3223		4040
3224	Libev offers a compatibility emulation layer for libevent. It cannot	4041	Libev offers a compatibility emulation layer for libevent. It cannot
3225	emulate the internals of libevent, so here are some usage hints:	4042	emulate the internals of libevent, so here are some usage hints:
3226		4043
3227	=over 4	4044	=over 4
		4045
		4046	=item * Only the libevent-1.4.1-beta API is being emulated.
		4047
		4048	This was the newest libevent version available when libev was implemented,
		4049	and is still mostly unchanged in 2010.
3228		4050
3229	=item * Use it by including <event.h>, as usual.	4051	=item * Use it by including <event.h>, as usual.
3230		4052
3231	=item * The following members are fully supported: ev_base, ev_callback,	4053	=item * The following members are fully supported: ev_base, ev_callback,
3232	ev_arg, ev_fd, ev_res, ev_events.	4054	ev_arg, ev_fd, ev_res, ev_events.
…		…
3238	=item * Priorities are not currently supported. Initialising priorities	4060	=item * Priorities are not currently supported. Initialising priorities
3239	will fail and all watchers will have the same priority, even though there	4061	will fail and all watchers will have the same priority, even though there
3240	is an ev_pri field.	4062	is an ev_pri field.
3241		4063
3242	=item * In libevent, the last base created gets the signals, in libev, the	4064	=item * In libevent, the last base created gets the signals, in libev, the
3243	first base created (== the default loop) gets the signals.	4065	base that registered the signal gets the signals.
3244		4066
3245	=item * Other members are not supported.	4067	=item * Other members are not supported.
3246		4068
3247	=item * The libev emulation is I<not> ABI compatible to libevent, you need	4069	=item * The libev emulation is I<not> ABI compatible to libevent, you need
3248	to use the libev header file and library.	4070	to use the libev header file and library.
3249		4071
3250	=back	4072	=back
3251		4073
3252	=head1 C++ SUPPORT	4074	=head1 C++ SUPPORT
		4075
		4076	=head2 C API
		4077
		4078	The normal C API should work fine when used from C++: both ev.h and the
		4079	libev sources can be compiled as C++. Therefore, code that uses the C API
		4080	will work fine.
		4081
		4082	Proper exception specifications might have to be added to callbacks passed
		4083	to libev: exceptions may be thrown only from watcher callbacks, all other
		4084	callbacks (allocator, syserr, loop acquire/release and periodic reschedule
		4085	callbacks) must not throw exceptions, and might need a C<noexcept>
		4086	specification. If you have code that needs to be compiled as both C and
		4087	C++ you can use the C<EV_NOEXCEPT> macro for this:
		4088
		4089	static void
		4090	fatal_error (const char *msg) EV_NOEXCEPT
		4091	{
		4092	perror (msg);
		4093	abort ();
		4094	}
		4095
		4096	...
		4097	ev_set_syserr_cb (fatal_error);
		4098
		4099	The only API functions that can currently throw exceptions are C<ev_run>,
		4100	C<ev_invoke>, C<ev_invoke_pending> and C<ev_loop_destroy> (the latter
		4101	because it runs cleanup watchers).
		4102
		4103	Throwing exceptions in watcher callbacks is only supported if libev itself
		4104	is compiled with a C++ compiler or your C and C++ environments allow
		4105	throwing exceptions through C libraries (most do).
		4106
		4107	=head2 C++ API
3253		4108
3254	Libev comes with some simplistic wrapper classes for C++ that mainly allow	4109	Libev comes with some simplistic wrapper classes for C++ that mainly allow
3255	you to use some convenience methods to start/stop watchers and also change	4110	you to use some convenience methods to start/stop watchers and also change
3256	the callback model to a model using method callbacks on objects.	4111	the callback model to a model using method callbacks on objects.
3257		4112
3258	To use it,	4113	To use it,
3259		4114
3260	#include <ev++.h>	4115	#include <ev++.h>
3261		4116
3262	This automatically includes F<ev.h> and puts all of its definitions (many	4117	This automatically includes F<ev.h> and puts all of its definitions (many
3263	of them macros) into the global namespace. All C++ specific things are	4118	of them macros) into the global namespace. All C++ specific things are
3264	put into the C<ev> namespace. It should support all the same embedding	4119	put into the C<ev> namespace. It should support all the same embedding
…		…
3267	Care has been taken to keep the overhead low. The only data member the C++	4122	Care has been taken to keep the overhead low. The only data member the C++
3268	classes add (compared to plain C-style watchers) is the event loop pointer	4123	classes add (compared to plain C-style watchers) is the event loop pointer
3269	that the watcher is associated with (or no additional members at all if	4124	that the watcher is associated with (or no additional members at all if
3270	you disable C<EV_MULTIPLICITY> when embedding libev).	4125	you disable C<EV_MULTIPLICITY> when embedding libev).
3271		4126
3272	Currently, functions, and static and non-static member functions can be	4127	Currently, functions, static and non-static member functions and classes
3273	used as callbacks. Other types should be easy to add as long as they only	4128	with C<operator ()> can be used as callbacks. Other types should be easy
3274	need one additional pointer for context. If you need support for other	4129	to add as long as they only need one additional pointer for context. If
3275	types of functors please contact the author (preferably after implementing	4130	you need support for other types of functors please contact the author
3276	it).	4131	(preferably after implementing it).
		4132
		4133	For all this to work, your C++ compiler either has to use the same calling
		4134	conventions as your C compiler (for static member functions), or you have
		4135	to embed libev and compile libev itself as C++.
3277		4136
3278	Here is a list of things available in the C<ev> namespace:	4137	Here is a list of things available in the C<ev> namespace:
3279		4138
3280	=over 4	4139	=over 4
3281		4140
…		…
3291	=item C<ev::io>, C<ev::timer>, C<ev::periodic>, C<ev::idle>, C<ev::sig> etc.	4150	=item C<ev::io>, C<ev::timer>, C<ev::periodic>, C<ev::idle>, C<ev::sig> etc.
3292		4151
3293	For each C<ev_TYPE> watcher in F<ev.h> there is a corresponding class of	4152	For each C<ev_TYPE> watcher in F<ev.h> there is a corresponding class of
3294	the same name in the C<ev> namespace, with the exception of C<ev_signal>	4153	the same name in the C<ev> namespace, with the exception of C<ev_signal>
3295	which is called C<ev::sig> to avoid clashes with the C<signal> macro	4154	which is called C<ev::sig> to avoid clashes with the C<signal> macro
3296	defines by many implementations.	4155	defined by many implementations.
3297		4156
3298	All of those classes have these methods:	4157	All of those classes have these methods:
3299		4158
3300	=over 4	4159	=over 4
3301		4160
…		…
3363	void operator() (ev::io &w, int revents)	4222	void operator() (ev::io &w, int revents)
3364	{	4223	{
3365	...	4224	...
3366	}	4225	}
3367	}	4226	}
3368		4227
3369	myfunctor f;	4228	myfunctor f;
3370		4229
3371	ev::io w;	4230	ev::io w;
3372	w.set (&f);	4231	w.set (&f);
3373		4232
…		…
3391	Associates a different C<struct ev_loop> with this watcher. You can only	4250	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).	4251	do this when the watcher is inactive (and not pending either).
3393		4252
3394	=item w->set ([arguments])	4253	=item w->set ([arguments])
3395		4254
3396	Basically the same as C<ev_TYPE_set>, with the same arguments. Either this	4255	Basically the same as C<ev_TYPE_set> (except for C<ev::embed> watchers>),
3397	method or a suitable start method must be called at least once. Unlike the	4256	with the same arguments. Either this method or a suitable start method
3398	C counterpart, an active watcher gets automatically stopped and restarted	4257	must be called at least once. Unlike the C counterpart, an active watcher
3399	when reconfiguring it with this method.	4258	gets automatically stopped and restarted when reconfiguring it with this
		4259	method.
		4260
		4261	For C<ev::embed> watchers this method is called C<set_embed>, to avoid
		4262	clashing with the C<set (loop)> method.
3400		4263
3401	=item w->start ()	4264	=item w->start ()
3402		4265
3403	Starts the watcher. Note that there is no C<loop> argument, as the	4266	Starts the watcher. Note that there is no C<loop> argument, as the
3404	constructor already stores the event loop.	4267	constructor already stores the event loop.
…		…
3434	watchers in the constructor.	4297	watchers in the constructor.
3435		4298
3436	class myclass	4299	class myclass
3437	{	4300	{
3438	ev::io io ; void io_cb (ev::io &w, int revents);	4301	ev::io io ; void io_cb (ev::io &w, int revents);
3439	ev::io2 io2 ; void io2_cb (ev::io &w, int revents);	4302	ev::io io2 ; void io2_cb (ev::io &w, int revents);
3440	ev::idle idle; void idle_cb (ev::idle &w, int revents);	4303	ev::idle idle; void idle_cb (ev::idle &w, int revents);
3441		4304
3442	myclass (int fd)	4305	myclass (int fd)
3443	{	4306	{
3444	io .set <myclass, &myclass::io_cb > (this);	4307	io .set <myclass, &myclass::io_cb > (this);
…		…
3495	L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>.	4358	L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>.
3496		4359
3497	=item D	4360	=item D
3498		4361
3499	Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to	4362	Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to
3500	be found at L<http://proj.llucax.com.ar/wiki/evd>.	4363	be found at L<http://www.llucax.com.ar/proj/ev.d/index.html>.
3501		4364
3502	=item Ocaml	4365	=item Ocaml
3503		4366
3504	Erkki Seppala has written Ocaml bindings for libev, to be found at	4367	Erkki Seppala has written Ocaml bindings for libev, to be found at
3505	L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.	4368	L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.
…		…
3508		4371
3509	Brian Maher has written a partial interface to libev for lua (at the	4372	Brian Maher has written a partial interface to libev for lua (at the
3510	time of this writing, only C<ev_io> and C<ev_timer>), to be found at	4373	time of this writing, only C<ev_io> and C<ev_timer>), to be found at
3511	L<http://github.com/brimworks/lua-ev>.	4374	L<http://github.com/brimworks/lua-ev>.
3512		4375
		4376	=item Javascript
		4377
		4378	Node.js (L<http://nodejs.org>) uses libev as the underlying event library.
		4379
		4380	=item Others
		4381
		4382	There are others, and I stopped counting.
		4383
3513	=back	4384	=back
3514		4385
3515		4386
3516	=head1 MACRO MAGIC	4387	=head1 MACRO MAGIC
3517		4388
…		…
3530	loop argument"). The C<EV_A> form is used when this is the sole argument,	4401	loop argument"). The C<EV_A> form is used when this is the sole argument,
3531	C<EV_A_> is used when other arguments are following. Example:	4402	C<EV_A_> is used when other arguments are following. Example:
3532		4403
3533	ev_unref (EV_A);	4404	ev_unref (EV_A);
3534	ev_timer_add (EV_A_ watcher);	4405	ev_timer_add (EV_A_ watcher);
3535	ev_loop (EV_A_ 0);	4406	ev_run (EV_A_ 0);
3536		4407
3537	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,	4408	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,
3538	which is often provided by the following macro.	4409	which is often provided by the following macro.
3539		4410
3540	=item C<EV_P>, C<EV_P_>	4411	=item C<EV_P>, C<EV_P_>
…		…
3553	suitable for use with C<EV_A>.	4424	suitable for use with C<EV_A>.
3554		4425
3555	=item C<EV_DEFAULT>, C<EV_DEFAULT_>	4426	=item C<EV_DEFAULT>, C<EV_DEFAULT_>
3556		4427
3557	Similar to the other two macros, this gives you the value of the default	4428	Similar to the other two macros, this gives you the value of the default
3558	loop, if multiple loops are supported ("ev loop default").	4429	loop, if multiple loops are supported ("ev loop default"). The default loop
		4430	will be initialised if it isn't already initialised.
		4431
		4432	For non-multiplicity builds, these macros do nothing, so you always have
		4433	to initialise the loop somewhere.
3559		4434
3560	=item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_>	4435	=item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_>
3561		4436
3562	Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the	4437	Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the
3563	default loop has been initialised (C<UC> == unchecked). Their behaviour	4438	default loop has been initialised (C<UC> == unchecked). Their behaviour
…		…
3580	}	4455	}
3581		4456
3582	ev_check check;	4457	ev_check check;
3583	ev_check_init (&check, check_cb);	4458	ev_check_init (&check, check_cb);
3584	ev_check_start (EV_DEFAULT_ &check);	4459	ev_check_start (EV_DEFAULT_ &check);
3585	ev_loop (EV_DEFAULT_ 0);	4460	ev_run (EV_DEFAULT_ 0);
3586		4461
3587	=head1 EMBEDDING	4462	=head1 EMBEDDING
3588		4463
3589	Libev can (and often is) directly embedded into host	4464	Libev can (and often is) directly embedded into host
3590	applications. Examples of applications that embed it include the Deliantra	4465	applications. Examples of applications that embed it include the Deliantra
…		…
3630	ev_vars.h	4505	ev_vars.h
3631	ev_wrap.h	4506	ev_wrap.h
3632		4507
3633	ev_win32.c required on win32 platforms only	4508	ev_win32.c required on win32 platforms only
3634		4509
3635	ev_select.c only when select backend is enabled (which is enabled by default)	4510	ev_select.c only when select backend is enabled
3636	ev_poll.c only when poll backend is enabled (disabled by default)	4511	ev_poll.c only when poll backend is enabled
3637	ev_epoll.c only when the epoll backend is enabled (disabled by default)	4512	ev_epoll.c only when the epoll backend is enabled
		4513	ev_linuxaio.c only when the linux aio backend is enabled
		4514	ev_iouring.c only when the linux io_uring backend is enabled
3638	ev_kqueue.c only when the kqueue backend is enabled (disabled by default)	4515	ev_kqueue.c only when the kqueue backend is enabled
3639	ev_port.c only when the solaris port backend is enabled (disabled by default)	4516	ev_port.c only when the solaris port backend is enabled
3640		4517
3641	F<ev.c> includes the backend files directly when enabled, so you only need	4518	F<ev.c> includes the backend files directly when enabled, so you only need
3642	to compile this single file.	4519	to compile this single file.
3643		4520
3644	=head3 LIBEVENT COMPATIBILITY API	4521	=head3 LIBEVENT COMPATIBILITY API
…		…
3682	users of libev and the libev code itself must be compiled with compatible	4559	users of libev and the libev code itself must be compiled with compatible
3683	settings.	4560	settings.
3684		4561
3685	=over 4	4562	=over 4
3686		4563
		4564	=item EV_COMPAT3 (h)
		4565
		4566	Backwards compatibility is a major concern for libev. This is why this
		4567	release of libev comes with wrappers for the functions and symbols that
		4568	have been renamed between libev version 3 and 4.
		4569
		4570	You can disable these wrappers (to test compatibility with future
		4571	versions) by defining C<EV_COMPAT3> to C<0> when compiling your
		4572	sources. This has the additional advantage that you can drop the C<struct>
		4573	from C<struct ev_loop> declarations, as libev will provide an C<ev_loop>
		4574	typedef in that case.
		4575
		4576	In some future version, the default for C<EV_COMPAT3> will become C<0>,
		4577	and in some even more future version the compatibility code will be
		4578	removed completely.
		4579
3687	=item EV_STANDALONE (h)	4580	=item EV_STANDALONE (h)
3688		4581
3689	Must always be C<1> if you do not use autoconf configuration, which	4582	Must always be C<1> if you do not use autoconf configuration, which
3690	keeps libev from including F<config.h>, and it also defines dummy	4583	keeps libev from including F<config.h>, and it also defines dummy
3691	implementations for some libevent functions (such as logging, which is not	4584	implementations for some libevent functions (such as logging, which is not
3692	supported). It will also not define any of the structs usually found in	4585	supported). It will also not define any of the structs usually found in
3693	F<event.h> that are not directly supported by the libev core alone.	4586	F<event.h> that are not directly supported by the libev core alone.
3694		4587
3695	In standalone mode, libev will still try to automatically deduce the	4588	In standalone mode, libev will still try to automatically deduce the
3696	configuration, but has to be more conservative.	4589	configuration, but has to be more conservative.
		4590
		4591	=item EV_USE_FLOOR
		4592
		4593	If defined to be C<1>, libev will use the C<floor ()> function for its
		4594	periodic reschedule calculations, otherwise libev will fall back on a
		4595	portable (slower) implementation. If you enable this, you usually have to
		4596	link against libm or something equivalent. Enabling this when the C<floor>
		4597	function is not available will fail, so the safe default is to not enable
		4598	this.
3697		4599
3698	=item EV_USE_MONOTONIC	4600	=item EV_USE_MONOTONIC
3699		4601
3700	If defined to be C<1>, libev will try to detect the availability of the	4602	If defined to be C<1>, libev will try to detect the availability of the
3701	monotonic clock option at both compile time and runtime. Otherwise no	4603	monotonic clock option at both compile time and runtime. Otherwise no
…		…
3738	available and will probe for kernel support at runtime. This will improve	4640	available and will probe for kernel support at runtime. This will improve
3739	C<ev_signal> and C<ev_async> performance and reduce resource consumption.	4641	C<ev_signal> and C<ev_async> performance and reduce resource consumption.
3740	If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc	4642	If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
3741	2.7 or newer, otherwise disabled.	4643	2.7 or newer, otherwise disabled.
3742		4644
		4645	=item EV_USE_SIGNALFD
		4646
		4647	If defined to be C<1>, then libev will assume that C<signalfd ()> is
		4648	available and will probe for kernel support at runtime. This enables
		4649	the use of EVFLAG_SIGNALFD for faster and simpler signal handling. If
		4650	undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
		4651	2.7 or newer, otherwise disabled.
		4652
		4653	=item EV_USE_TIMERFD
		4654
		4655	If defined to be C<1>, then libev will assume that C<timerfd ()> is
		4656	available and will probe for kernel support at runtime. This allows
		4657	libev to detect time jumps accurately. If undefined, it will be enabled
		4658	if the headers indicate GNU/Linux + Glibc 2.8 or newer and define
		4659	C<TFD_TIMER_CANCEL_ON_SET>, otherwise disabled.
		4660
		4661	=item EV_USE_EVENTFD
		4662
		4663	If defined to be C<1>, then libev will assume that C<eventfd ()> is
		4664	available and will probe for kernel support at runtime. This will improve
		4665	C<ev_signal> and C<ev_async> performance and reduce resource consumption.
		4666	If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
		4667	2.7 or newer, otherwise disabled.
		4668
3743	=item EV_USE_SELECT	4669	=item EV_USE_SELECT
3744		4670
3745	If undefined or defined to be C<1>, libev will compile in support for the	4671	If undefined or defined to be C<1>, libev will compile in support for the
3746	C<select>(2) backend. No attempt at auto-detection will be done: if no	4672	C<select>(2) backend. No attempt at auto-detection will be done: if no
3747	other method takes over, select will be it. Otherwise the select backend	4673	other method takes over, select will be it. Otherwise the select backend
…		…
3787	If programs implement their own fd to handle mapping on win32, then this	4713	If programs implement their own fd to handle mapping on win32, then this
3788	macro can be used to override the C<close> function, useful to unregister	4714	macro can be used to override the C<close> function, useful to unregister
3789	file descriptors again. Note that the replacement function has to close	4715	file descriptors again. Note that the replacement function has to close
3790	the underlying OS handle.	4716	the underlying OS handle.
3791		4717
		4718	=item EV_USE_WSASOCKET
		4719
		4720	If defined to be C<1>, libev will use C<WSASocket> to create its internal
		4721	communication socket, which works better in some environments. Otherwise,
		4722	the normal C<socket> function will be used, which works better in other
		4723	environments.
		4724
3792	=item EV_USE_POLL	4725	=item EV_USE_POLL
3793		4726
3794	If defined to be C<1>, libev will compile in support for the C<poll>(2)	4727	If defined to be C<1>, libev will compile in support for the C<poll>(2)
3795	backend. Otherwise it will be enabled on non-win32 platforms. It	4728	backend. Otherwise it will be enabled on non-win32 platforms. It
3796	takes precedence over select.	4729	takes precedence over select.
…		…
3800	If defined to be C<1>, libev will compile in support for the Linux	4733	If defined to be C<1>, libev will compile in support for the Linux
3801	C<epoll>(7) backend. Its availability will be detected at runtime,	4734	C<epoll>(7) backend. Its availability will be detected at runtime,
3802	otherwise another method will be used as fallback. This is the preferred	4735	otherwise another method will be used as fallback. This is the preferred
3803	backend for GNU/Linux systems. If undefined, it will be enabled if the	4736	backend for GNU/Linux systems. If undefined, it will be enabled if the
3804	headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.	4737	headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
		4738
		4739	=item EV_USE_LINUXAIO
		4740
		4741	If defined to be C<1>, libev will compile in support for the Linux aio
		4742	backend (C<EV_USE_EPOLL> must also be enabled). If undefined, it will be
		4743	enabled on linux, otherwise disabled.
		4744
		4745	=item EV_USE_IOURING
		4746
		4747	If defined to be C<1>, libev will compile in support for the Linux
		4748	io_uring backend (C<EV_USE_EPOLL> must also be enabled). Due to it's
		4749	current limitations it has to be requested explicitly. If undefined, it
		4750	will be enabled on linux, otherwise disabled.
3805		4751
3806	=item EV_USE_KQUEUE	4752	=item EV_USE_KQUEUE
3807		4753
3808	If defined to be C<1>, libev will compile in support for the BSD style	4754	If defined to be C<1>, libev will compile in support for the BSD style
3809	C<kqueue>(2) backend. Its actual availability will be detected at runtime,	4755	C<kqueue>(2) backend. Its actual availability will be detected at runtime,
…		…
3831	If defined to be C<1>, libev will compile in support for the Linux inotify	4777	If defined to be C<1>, libev will compile in support for the Linux inotify
3832	interface to speed up C<ev_stat> watchers. Its actual availability will	4778	interface to speed up C<ev_stat> watchers. Its actual availability will
3833	be detected at runtime. If undefined, it will be enabled if the headers	4779	be detected at runtime. If undefined, it will be enabled if the headers
3834	indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.	4780	indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
3835		4781
		4782	=item EV_NO_SMP
		4783
		4784	If defined to be C<1>, libev will assume that memory is always coherent
		4785	between threads, that is, threads can be used, but threads never run on
		4786	different cpus (or different cpu cores). This reduces dependencies
		4787	and makes libev faster.
		4788
		4789	=item EV_NO_THREADS
		4790
		4791	If defined to be C<1>, libev will assume that it will never be called from
		4792	different threads (that includes signal handlers), which is a stronger
		4793	assumption than C<EV_NO_SMP>, above. This reduces dependencies and makes
		4794	libev faster.
		4795
3836	=item EV_ATOMIC_T	4796	=item EV_ATOMIC_T
3837		4797
3838	Libev requires an integer type (suitable for storing C<0> or C<1>) whose	4798	Libev requires an integer type (suitable for storing C<0> or C<1>) whose
3839	access is atomic with respect to other threads or signal contexts. No such	4799	access is atomic with respect to other threads or signal contexts. No
3840	type is easily found in the C language, so you can provide your own type	4800	such type is easily found in the C language, so you can provide your own
3841	that you know is safe for your purposes. It is used both for signal handler "locking"	4801	type that you know is safe for your purposes. It is used both for signal
3842	as well as for signal and thread safety in C<ev_async> watchers.	4802	handler "locking" as well as for signal and thread safety in C<ev_async>
		4803	watchers.
3843		4804
3844	In the absence of this define, libev will use C<sig_atomic_t volatile>	4805	In the absence of this define, libev will use C<sig_atomic_t volatile>
3845	(from F<signal.h>), which is usually good enough on most platforms.	4806	(from F<signal.h>), which is usually good enough on most platforms.
3846		4807
3847	=item EV_H (h)	4808	=item EV_H (h)
…		…
3874	will have the C<struct ev_loop *> as first argument, and you can create	4835	will have the C<struct ev_loop *> as first argument, and you can create
3875	additional independent event loops. Otherwise there will be no support	4836	additional independent event loops. Otherwise there will be no support
3876	for multiple event loops and there is no first event loop pointer	4837	for multiple event loops and there is no first event loop pointer
3877	argument. Instead, all functions act on the single default loop.	4838	argument. Instead, all functions act on the single default loop.
3878		4839
		4840	Note that C<EV_DEFAULT> and C<EV_DEFAULT_> will no longer provide a
		4841	default loop when multiplicity is switched off - you always have to
		4842	initialise the loop manually in this case.
		4843
3879	=item EV_MINPRI	4844	=item EV_MINPRI
3880		4845
3881	=item EV_MAXPRI	4846	=item EV_MAXPRI
3882		4847
3883	The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to	4848	The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to
…		…
3919	#define EV_USE_POLL 1	4884	#define EV_USE_POLL 1
3920	#define EV_CHILD_ENABLE 1	4885	#define EV_CHILD_ENABLE 1
3921	#define EV_ASYNC_ENABLE 1	4886	#define EV_ASYNC_ENABLE 1
3922		4887
3923	The actual value is a bitset, it can be a combination of the following	4888	The actual value is a bitset, it can be a combination of the following
3924	values:	4889	values (by default, all of these are enabled):
3925		4890
3926	=over 4	4891	=over 4
3927		4892
3928	=item C<1> - faster/larger code	4893	=item C<1> - faster/larger code
3929		4894
…		…
3933	code size by roughly 30% on amd64).	4898	code size by roughly 30% on amd64).
3934		4899
3935	When optimising for size, use of compiler flags such as C<-Os> with	4900	When optimising for size, use of compiler flags such as C<-Os> with
3936	gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of	4901	gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of
3937	assertions.	4902	assertions.
		4903
		4904	The default is off when C<__OPTIMIZE_SIZE__> is defined by your compiler
		4905	(e.g. gcc with C<-Os>).
3938		4906
3939	=item C<2> - faster/larger data structures	4907	=item C<2> - faster/larger data structures
3940		4908
3941	Replaces the small 2-heap for timer management by a faster 4-heap, larger	4909	Replaces the small 2-heap for timer management by a faster 4-heap, larger
3942	hash table sizes and so on. This will usually further increase code size	4910	hash table sizes and so on. This will usually further increase code size
3943	and can additionally have an effect on the size of data structures at	4911	and can additionally have an effect on the size of data structures at
3944	runtime.	4912	runtime.
3945		4913
		4914	The default is off when C<__OPTIMIZE_SIZE__> is defined by your compiler
		4915	(e.g. gcc with C<-Os>).
		4916
3946	=item C<4> - full API configuration	4917	=item C<4> - full API configuration
3947		4918
3948	This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and	4919	This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and
3949	enables multiplicity (C<EV_MULTIPLICITY>=1).	4920	enables multiplicity (C<EV_MULTIPLICITY>=1).
3950		4921
…		…
3980		4951
3981	With an intelligent-enough linker (gcc+binutils are intelligent enough	4952	With an intelligent-enough linker (gcc+binutils are intelligent enough
3982	when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by	4953	when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by
3983	your program might be left out as well - a binary starting a timer and an	4954	your program might be left out as well - a binary starting a timer and an
3984	I/O watcher then might come out at only 5Kb.	4955	I/O watcher then might come out at only 5Kb.
		4956
		4957	=item EV_API_STATIC
		4958
		4959	If this symbol is defined (by default it is not), then all identifiers
		4960	will have static linkage. This means that libev will not export any
		4961	identifiers, and you cannot link against libev anymore. This can be useful
		4962	when you embed libev, only want to use libev functions in a single file,
		4963	and do not want its identifiers to be visible.
		4964
		4965	To use this, define C<EV_API_STATIC> and include F<ev.c> in the file that
		4966	wants to use libev.
		4967
		4968	This option only works when libev is compiled with a C compiler, as C++
		4969	doesn't support the required declaration syntax.
3985		4970
3986	=item EV_AVOID_STDIO	4971	=item EV_AVOID_STDIO
3987		4972
3988	If this is set to C<1> at compiletime, then libev will avoid using stdio	4973	If this is set to C<1> at compiletime, then libev will avoid using stdio
3989	functions (printf, scanf, perror etc.). This will increase the code size	4974	functions (printf, scanf, perror etc.). This will increase the code size
…		…
4040	The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it	5025	The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
4041	will be C<0>.	5026	will be C<0>.
4042		5027
4043	=item EV_VERIFY	5028	=item EV_VERIFY
4044		5029
4045	Controls how much internal verification (see C<ev_loop_verify ()>) will	5030	Controls how much internal verification (see C<ev_verify ()>) will
4046	be done: If set to C<0>, no internal verification code will be compiled	5031	be done: If set to C<0>, no internal verification code will be compiled
4047	in. If set to C<1>, then verification code will be compiled in, but not	5032	in. If set to C<1>, then verification code will be compiled in, but not
4048	called. If set to C<2>, then the internal verification code will be	5033	called. If set to C<2>, then the internal verification code will be
4049	called once per loop, which can slow down libev. If set to C<3>, then the	5034	called once per loop, which can slow down libev. If set to C<3>, then the
4050	verification code will be called very frequently, which will slow down	5035	verification code will be called very frequently, which will slow down
4051	libev considerably.	5036	libev considerably.
		5037
		5038	Verification errors are reported via C's C<assert> mechanism, so if you
		5039	disable that (e.g. by defining C<NDEBUG>) then no errors will be reported.
4052		5040
4053	The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it	5041	The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
4054	will be C<0>.	5042	will be C<0>.
4055		5043
4056	=item EV_COMMON	5044	=item EV_COMMON
…		…
4133	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:	5121	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
4134		5122
4135	#include "ev_cpp.h"	5123	#include "ev_cpp.h"
4136	#include "ev.c"	5124	#include "ev.c"
4137		5125
4138	=head1 INTERACTION WITH OTHER PROGRAMS OR LIBRARIES	5126	=head1 INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT
4139		5127
4140	=head2 THREADS AND COROUTINES	5128	=head2 THREADS AND COROUTINES
4141		5129
4142	=head3 THREADS	5130	=head3 THREADS
4143		5131
…		…
4194	default loop and triggering an C<ev_async> watcher from the default loop	5182	default loop and triggering an C<ev_async> watcher from the default loop
4195	watcher callback into the event loop interested in the signal.	5183	watcher callback into the event loop interested in the signal.
4196		5184
4197	=back	5185	=back
4198		5186
4199	=head4 THREAD LOCKING EXAMPLE	5187	See also L</THREAD LOCKING EXAMPLE>.
4200
4201	Here is a fictitious example of how to run an event loop in a different
4202	thread than where callbacks are being invoked and watchers are
4203	created/added/removed.
4204
4205	For a real-world example, see the C<EV::Loop::Async> perl module,
4206	which uses exactly this technique (which is suited for many high-level
4207	languages).
4208
4209	The example uses a pthread mutex to protect the loop data, a condition
4210	variable to wait for callback invocations, an async watcher to notify the
4211	event loop thread and an unspecified mechanism to wake up the main thread.
4212
4213	First, you need to associate some data with the event loop:
4214
4215	typedef struct {
4216	mutex_t lock; /* global loop lock */
4217	ev_async async_w;
4218	thread_t tid;
4219	cond_t invoke_cv;
4220	} userdata;
4221
4222	void prepare_loop (EV_P)
4223	{
4224	// for simplicity, we use a static userdata struct.
4225	static userdata u;
4226
4227	ev_async_init (&u->async_w, async_cb);
4228	ev_async_start (EV_A_ &u->async_w);
4229
4230	pthread_mutex_init (&u->lock, 0);
4231	pthread_cond_init (&u->invoke_cv, 0);
4232
4233	// now associate this with the loop
4234	ev_set_userdata (EV_A_ u);
4235	ev_set_invoke_pending_cb (EV_A_ l_invoke);
4236	ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
4237
4238	// then create the thread running ev_loop
4239	pthread_create (&u->tid, 0, l_run, EV_A);
4240	}
4241
4242	The callback for the C<ev_async> watcher does nothing: the watcher is used
4243	solely to wake up the event loop so it takes notice of any new watchers
4244	that might have been added:
4245
4246	static void
4247	async_cb (EV_P_ ev_async *w, int revents)
4248	{
4249	// just used for the side effects
4250	}
4251
4252	The C<l_release> and C<l_acquire> callbacks simply unlock/lock the mutex
4253	protecting the loop data, respectively.
4254
4255	static void
4256	l_release (EV_P)
4257	{
4258	userdata *u = ev_userdata (EV_A);
4259	pthread_mutex_unlock (&u->lock);
4260	}
4261
4262	static void
4263	l_acquire (EV_P)
4264	{
4265	userdata *u = ev_userdata (EV_A);
4266	pthread_mutex_lock (&u->lock);
4267	}
4268
4269	The event loop thread first acquires the mutex, and then jumps straight
4270	into C<ev_loop>:
4271
4272	void *
4273	l_run (void *thr_arg)
4274	{
4275	struct ev_loop *loop = (struct ev_loop *)thr_arg;
4276
4277	l_acquire (EV_A);
4278	pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
4279	ev_loop (EV_A_ 0);
4280	l_release (EV_A);
4281
4282	return 0;
4283	}
4284
4285	Instead of invoking all pending watchers, the C<l_invoke> callback will
4286	signal the main thread via some unspecified mechanism (signals? pipe
4287	writes? C<Async::Interrupt>?) and then waits until all pending watchers
4288	have been called (in a while loop because a) spurious wakeups are possible
4289	and b) skipping inter-thread-communication when there are no pending
4290	watchers is very beneficial):
4291
4292	static void
4293	l_invoke (EV_P)
4294	{
4295	userdata *u = ev_userdata (EV_A);
4296
4297	while (ev_pending_count (EV_A))
4298	{
4299	wake_up_other_thread_in_some_magic_or_not_so_magic_way ();
4300	pthread_cond_wait (&u->invoke_cv, &u->lock);
4301	}
4302	}
4303
4304	Now, whenever the main thread gets told to invoke pending watchers, it
4305	will grab the lock, call C<ev_invoke_pending> and then signal the loop
4306	thread to continue:
4307
4308	static void
4309	real_invoke_pending (EV_P)
4310	{
4311	userdata *u = ev_userdata (EV_A);
4312
4313	pthread_mutex_lock (&u->lock);
4314	ev_invoke_pending (EV_A);
4315	pthread_cond_signal (&u->invoke_cv);
4316	pthread_mutex_unlock (&u->lock);
4317	}
4318
4319	Whenever you want to start/stop a watcher or do other modifications to an
4320	event loop, you will now have to lock:
4321
4322	ev_timer timeout_watcher;
4323	userdata *u = ev_userdata (EV_A);
4324
4325	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
4326
4327	pthread_mutex_lock (&u->lock);
4328	ev_timer_start (EV_A_ &timeout_watcher);
4329	ev_async_send (EV_A_ &u->async_w);
4330	pthread_mutex_unlock (&u->lock);
4331
4332	Note that sending the C<ev_async> watcher is required because otherwise
4333	an event loop currently blocking in the kernel will have no knowledge
4334	about the newly added timer. By waking up the loop it will pick up any new
4335	watchers in the next event loop iteration.
4336		5188
4337	=head3 COROUTINES	5189	=head3 COROUTINES
4338		5190
4339	Libev is very accommodating to coroutines ("cooperative threads"):	5191	Libev is very accommodating to coroutines ("cooperative threads"):
4340	libev fully supports nesting calls to its functions from different	5192	libev fully supports nesting calls to its functions from different
4341	coroutines (e.g. you can call C<ev_loop> on the same loop from two	5193	coroutines (e.g. you can call C<ev_run> on the same loop from two
4342	different coroutines, and switch freely between both coroutines running	5194	different coroutines, and switch freely between both coroutines running
4343	the loop, as long as you don't confuse yourself). The only exception is	5195	the loop, as long as you don't confuse yourself). The only exception is
4344	that you must not do this from C<ev_periodic> reschedule callbacks.	5196	that you must not do this from C<ev_periodic> reschedule callbacks.
4345		5197
4346	Care has been taken to ensure that libev does not keep local state inside	5198	Care has been taken to ensure that libev does not keep local state inside
4347	C<ev_loop>, and other calls do not usually allow for coroutine switches as	5199	C<ev_run>, and other calls do not usually allow for coroutine switches as
4348	they do not call any callbacks.	5200	they do not call any callbacks.
4349		5201
4350	=head2 COMPILER WARNINGS	5202	=head2 COMPILER WARNINGS
4351		5203
4352	Depending on your compiler and compiler settings, you might get no or a	5204	Depending on your compiler and compiler settings, you might get no or a
…		…
4436	=head3 C<kqueue> is buggy	5288	=head3 C<kqueue> is buggy
4437		5289
4438	The kqueue syscall is broken in all known versions - most versions support	5290	The kqueue syscall is broken in all known versions - most versions support
4439	only sockets, many support pipes.	5291	only sockets, many support pipes.
4440		5292
4441	Libev tries to work around this by not using C<kqueue> by default on	5293	Libev tries to work around this by not using C<kqueue> by default on this
4442	this rotten platform, but of course you can still ask for it when creating	5294	rotten platform, but of course you can still ask for it when creating a
4443	a loop.	5295	loop - embedding a socket-only kqueue loop into a select-based one is
		5296	probably going to work well.
4444		5297
4445	=head3 C<poll> is buggy	5298	=head3 C<poll> is buggy
4446		5299
4447	Instead of fixing C<kqueue>, Apple replaced their (working) C<poll>	5300	Instead of fixing C<kqueue>, Apple replaced their (working) C<poll>
4448	implementation by something calling C<kqueue> internally around the 10.5.6	5301	implementation by something calling C<kqueue> internally around the 10.5.6
…		…
4467		5320
4468	=head3 C<errno> reentrancy	5321	=head3 C<errno> reentrancy
4469		5322
4470	The default compile environment on Solaris is unfortunately so	5323	The default compile environment on Solaris is unfortunately so
4471	thread-unsafe that you can't even use components/libraries compiled	5324	thread-unsafe that you can't even use components/libraries compiled
4472	without C<-D_REENTRANT> (as long as they use C<errno>), which, of course,	5325	without C<-D_REENTRANT> in a threaded program, which, of course, isn't
4473	isn't defined by default.	5326	defined by default. A valid, if stupid, implementation choice.
4474		5327
4475	If you want to use libev in threaded environments you have to make sure	5328	If you want to use libev in threaded environments you have to make sure
4476	it's compiled with C<_REENTRANT> defined.	5329	it's compiled with C<_REENTRANT> defined.
4477		5330
4478	=head3 Event port backend	5331	=head3 Event port backend
4479		5332
4480	The scalable event interface for Solaris is called "event ports". Unfortunately,	5333	The scalable event interface for Solaris is called "event
4481	this mechanism is very buggy. If you run into high CPU usage, your program	5334	ports". Unfortunately, this mechanism is very buggy in all major
		5335	releases. If you run into high CPU usage, your program freezes or you get
4482	freezes or you get a large number of spurious wakeups, make sure you have	5336	a large number of spurious wakeups, make sure you have all the relevant
4483	all the relevant and latest kernel patches applied. No, I don't know which	5337	and latest kernel patches applied. No, I don't know which ones, but there
4484	ones, but there are multiple ones.	5338	are multiple ones to apply, and afterwards, event ports actually work
		5339	great.
4485		5340
4486	If you can't get it to work, you can try running the program by setting	5341	If you can't get it to work, you can try running the program by setting
4487	the environment variable C<LIBEV_FLAGS=3> to only allow C<poll> and	5342	the environment variable C<LIBEV_FLAGS=3> to only allow C<poll> and
4488	C<select> backends.	5343	C<select> backends.
4489		5344
4490	=head2 AIX POLL BUG	5345	=head2 AIX POLL BUG
4491		5346
4492	AIX unfortunately has a broken C<poll.h> header. Libev works around	5347	AIX unfortunately has a broken C<poll.h> header. Libev works around
4493	this by trying to avoid the poll backend altogether (i.e. it's not even	5348	this by trying to avoid the poll backend altogether (i.e. it's not even
4494	compiled in), which normally isn't a big problem as C<select> works fine	5349	compiled in), which normally isn't a big problem as C<select> works fine
4495	with large bitsets, and AIX is dead anyway.	5350	with large bitsets on AIX, and AIX is dead anyway.
4496		5351
4497	=head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS	5352	=head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS
4498		5353
4499	=head3 General issues	5354	=head3 General issues
4500		5355
…		…
4502	requires, and its I/O model is fundamentally incompatible with the POSIX	5357	requires, and its I/O model is fundamentally incompatible with the POSIX
4503	model. Libev still offers limited functionality on this platform in	5358	model. Libev still offers limited functionality on this platform in
4504	the form of the C<EVBACKEND_SELECT> backend, and only supports socket	5359	the form of the C<EVBACKEND_SELECT> backend, and only supports socket
4505	descriptors. This only applies when using Win32 natively, not when using	5360	descriptors. This only applies when using Win32 natively, not when using
4506	e.g. cygwin. Actually, it only applies to the microsofts own compilers,	5361	e.g. cygwin. Actually, it only applies to the microsofts own compilers,
4507	as every compielr comes with a slightly differently broken/incompatible	5362	as every compiler comes with a slightly differently broken/incompatible
4508	environment.	5363	environment.
4509		5364
4510	Lifting these limitations would basically require the full	5365	Lifting these limitations would basically require the full
4511	re-implementation of the I/O system. If you are into this kind of thing,	5366	re-implementation of the I/O system. If you are into this kind of thing,
4512	then note that glib does exactly that for you in a very portable way (note	5367	then note that glib does exactly that for you in a very portable way (note
…		…
4606	structure (guaranteed by POSIX but not by ISO C for example), but it also	5461	structure (guaranteed by POSIX but not by ISO C for example), but it also
4607	assumes that the same (machine) code can be used to call any watcher	5462	assumes that the same (machine) code can be used to call any watcher
4608	callback: The watcher callbacks have different type signatures, but libev	5463	callback: The watcher callbacks have different type signatures, but libev
4609	calls them using an C<ev_watcher *> internally.	5464	calls them using an C<ev_watcher *> internally.
4610		5465
		5466	=item null pointers and integer zero are represented by 0 bytes
		5467
		5468	Libev uses C<memset> to initialise structs and arrays to C<0> bytes, and
		5469	relies on this setting pointers and integers to null.
		5470
		5471	=item pointer accesses must be thread-atomic
		5472
		5473	Accessing a pointer value must be atomic, it must both be readable and
		5474	writable in one piece - this is the case on all current architectures.
		5475
4611	=item C<sig_atomic_t volatile> must be thread-atomic as well	5476	=item C<sig_atomic_t volatile> must be thread-atomic as well
4612		5477
4613	The type C<sig_atomic_t volatile> (or whatever is defined as	5478	The type C<sig_atomic_t volatile> (or whatever is defined as
4614	C<EV_ATOMIC_T>) must be atomic with respect to accesses from different	5479	C<EV_ATOMIC_T>) must be atomic with respect to accesses from different
4615	threads. This is not part of the specification for C<sig_atomic_t>, but is	5480	threads. This is not part of the specification for C<sig_atomic_t>, but is
…		…
4623	thread" or will block signals process-wide, both behaviours would	5488	thread" or will block signals process-wide, both behaviours would
4624	be compatible with libev. Interaction between C<sigprocmask> and	5489	be compatible with libev. Interaction between C<sigprocmask> and
4625	C<pthread_sigmask> could complicate things, however.	5490	C<pthread_sigmask> could complicate things, however.
4626		5491
4627	The most portable way to handle signals is to block signals in all threads	5492	The most portable way to handle signals is to block signals in all threads
4628	except the initial one, and run the default loop in the initial thread as	5493	except the initial one, and run the signal handling loop in the initial
4629	well.	5494	thread as well.
4630		5495
4631	=item C<long> must be large enough for common memory allocation sizes	5496	=item C<long> must be large enough for common memory allocation sizes
4632		5497
4633	To improve portability and simplify its API, libev uses C<long> internally	5498	To improve portability and simplify its API, libev uses C<long> internally
4634	instead of C<size_t> when allocating its data structures. On non-POSIX	5499	instead of C<size_t> when allocating its data structures. On non-POSIX
…		…
4640		5505
4641	The type C<double> is used to represent timestamps. It is required to	5506	The type C<double> is used to represent timestamps. It is required to
4642	have at least 51 bits of mantissa (and 9 bits of exponent), which is	5507	have at least 51 bits of mantissa (and 9 bits of exponent), which is
4643	good enough for at least into the year 4000 with millisecond accuracy	5508	good enough for at least into the year 4000 with millisecond accuracy
4644	(the design goal for libev). This requirement is overfulfilled by	5509	(the design goal for libev). This requirement is overfulfilled by
4645	implementations using IEEE 754, which is basically all existing ones. With	5510	implementations using IEEE 754, which is basically all existing ones.
		5511
4646	IEEE 754 doubles, you get microsecond accuracy until at least 2200.	5512	With IEEE 754 doubles, you get microsecond accuracy until at least the
		5513	year 2255 (and millisecond accuracy till the year 287396 - by then, libev
		5514	is either obsolete or somebody patched it to use C<long double> or
		5515	something like that, just kidding).
4647		5516
4648	=back	5517	=back
4649		5518
4650	If you know of other additional requirements drop me a note.	5519	If you know of other additional requirements drop me a note.
4651		5520
…		…
4713	=item Processing ev_async_send: O(number_of_async_watchers)	5582	=item Processing ev_async_send: O(number_of_async_watchers)
4714		5583
4715	=item Processing signals: O(max_signal_number)	5584	=item Processing signals: O(max_signal_number)
4716		5585
4717	Sending involves a system call I<iff> there were no other C<ev_async_send>	5586	Sending involves a system call I<iff> there were no other C<ev_async_send>
4718	calls in the current loop iteration. Checking for async and signal events	5587	calls in the current loop iteration and the loop is currently
		5588	blocked. Checking for async and signal events involves iterating over all
4719	involves iterating over all running async watchers or all signal numbers.	5589	running async watchers or all signal numbers.
4720		5590
4721	=back	5591	=back
4722		5592
4723		5593
4724	=head1 PORTING FROM LIBEV 3.X TO 4.X	5594	=head1 PORTING FROM LIBEV 3.X TO 4.X
4725		5595
4726	The major version 4 introduced some minor incompatible changes to the API.	5596	The major version 4 introduced some incompatible changes to the API.
4727		5597
4728	At the moment, the C<ev.h> header file tries to implement superficial	5598	At the moment, the C<ev.h> header file provides compatibility definitions
4729	compatibility, so most programs should still compile. Those might be	5599	for all changes, so most programs should still compile. The compatibility
4730	removed in later versions of libev, so better update early than late.	5600	layer might be removed in later versions of libev, so better update to the
		5601	new API early than late.
4731		5602
4732	=over 4	5603	=over 4
4733		5604
4734	=item C<ev_loop_count> renamed to C<ev_iteration>	5605	=item C<EV_COMPAT3> backwards compatibility mechanism
4735		5606
4736	=item C<ev_loop_depth> renamed to C<ev_depth>	5607	The backward compatibility mechanism can be controlled by
		5608	C<EV_COMPAT3>. See L</"PREPROCESSOR SYMBOLS/MACROS"> in the L</EMBEDDING>
		5609	section.
4737		5610
4738	=item C<ev_loop_verify> renamed to C<ev_verify>	5611	=item C<ev_default_destroy> and C<ev_default_fork> have been removed
		5612
		5613	These calls can be replaced easily by their C<ev_loop_xxx> counterparts:
		5614
		5615	ev_loop_destroy (EV_DEFAULT_UC);
		5616	ev_loop_fork (EV_DEFAULT);
		5617
		5618	=item function/symbol renames
		5619
		5620	A number of functions and symbols have been renamed:
		5621
		5622	ev_loop => ev_run
		5623	EVLOOP_NONBLOCK => EVRUN_NOWAIT
		5624	EVLOOP_ONESHOT => EVRUN_ONCE
		5625
		5626	ev_unloop => ev_break
		5627	EVUNLOOP_CANCEL => EVBREAK_CANCEL
		5628	EVUNLOOP_ONE => EVBREAK_ONE
		5629	EVUNLOOP_ALL => EVBREAK_ALL
		5630
		5631	EV_TIMEOUT => EV_TIMER
		5632
		5633	ev_loop_count => ev_iteration
		5634	ev_loop_depth => ev_depth
		5635	ev_loop_verify => ev_verify
4739		5636
4740	Most functions working on C<struct ev_loop> objects don't have an	5637	Most functions working on C<struct ev_loop> objects don't have an
4741	C<ev_loop_> prefix, so it was removed. Note that C<ev_loop_fork> is	5638	C<ev_loop_> prefix, so it was removed; C<ev_loop>, C<ev_unloop> and
		5639	associated constants have been renamed to not collide with the C<struct
		5640	ev_loop> anymore and C<EV_TIMER> now follows the same naming scheme
		5641	as all other watcher types. Note that C<ev_loop_fork> is still called
4742	still called C<ev_loop_fork> because it would otherwise clash with the	5642	C<ev_loop_fork> because it would otherwise clash with the C<ev_fork>
4743	C<ev_fork> typedef.	5643	typedef.
4744
4745	=item C<EV_TIMEOUT> renamed to C<EV_TIMER> in C<revents>
4746
4747	This is a simple rename - all other watcher types use their name
4748	as revents flag, and now C<ev_timer> does, too.
4749
4750	Both C<EV_TIMER> and C<EV_TIMEOUT> symbols were present in 3.x versions
4751	and continue to be present for the foreseeable future, so this is mostly a
4752	documentation change.
4753		5644
4754	=item C<EV_MINIMAL> mechanism replaced by C<EV_FEATURES>	5645	=item C<EV_MINIMAL> mechanism replaced by C<EV_FEATURES>
4755		5646
4756	The preprocessor symbol C<EV_MINIMAL> has been replaced by a different	5647	The preprocessor symbol C<EV_MINIMAL> has been replaced by a different
4757	mechanism, C<EV_FEATURES>. Programs using C<EV_MINIMAL> usually compile	5648	mechanism, C<EV_FEATURES>. Programs using C<EV_MINIMAL> usually compile
…		…
4764		5655
4765	=over 4	5656	=over 4
4766		5657
4767	=item active	5658	=item active
4768		5659
4769	A watcher is active as long as it has been started (has been attached to	5660	A watcher is active as long as it has been started and not yet stopped.
4770	an event loop) but not yet stopped (disassociated from the event loop).	5661	See L</WATCHER STATES> for details.
4771		5662
4772	=item application	5663	=item application
4773		5664
4774	In this document, an application is whatever is using libev.	5665	In this document, an application is whatever is using libev.
		5666
		5667	=item backend
		5668
		5669	The part of the code dealing with the operating system interfaces.
4775		5670
4776	=item callback	5671	=item callback
4777		5672
4778	The address of a function that is called when some event has been	5673	The address of a function that is called when some event has been
4779	detected. Callbacks are being passed the event loop, the watcher that	5674	detected. Callbacks are being passed the event loop, the watcher that
4780	received the event, and the actual event bitset.	5675	received the event, and the actual event bitset.
4781		5676
4782	=item callback invocation	5677	=item callback/watcher invocation
4783		5678
4784	The act of calling the callback associated with a watcher.	5679	The act of calling the callback associated with a watcher.
4785		5680
4786	=item event	5681	=item event
4787		5682
…		…
4806	The model used to describe how an event loop handles and processes	5701	The model used to describe how an event loop handles and processes
4807	watchers and events.	5702	watchers and events.
4808		5703
4809	=item pending	5704	=item pending
4810		5705
4811	A watcher is pending as soon as the corresponding event has been detected,	5706	A watcher is pending as soon as the corresponding event has been
4812	and stops being pending as soon as the watcher will be invoked or its	5707	detected. See L</WATCHER STATES> for details.
4813	pending status is explicitly cleared by the application.
4814
4815	A watcher can be pending, but not active. Stopping a watcher also clears
4816	its pending status.
4817		5708
4818	=item real time	5709	=item real time
4819		5710
4820	The physical time that is observed. It is apparently strictly monotonic :)	5711	The physical time that is observed. It is apparently strictly monotonic :)
4821		5712
4822	=item wall-clock time	5713	=item wall-clock time
4823		5714
4824	The time and date as shown on clocks. Unlike real time, it can actually	5715	The time and date as shown on clocks. Unlike real time, it can actually
4825	be wrong and jump forwards and backwards, e.g. when the you adjust your	5716	be wrong and jump forwards and backwards, e.g. when you adjust your
4826	clock.	5717	clock.
4827		5718
4828	=item watcher	5719	=item watcher
4829		5720
4830	A data structure that describes interest in certain events. Watchers need	5721	A data structure that describes interest in certain events. Watchers need
4831	to be started (attached to an event loop) before they can receive events.	5722	to be started (attached to an event loop) before they can receive events.
4832		5723
4833	=item watcher invocation
4834
4835	The act of calling the callback associated with a watcher.
4836
4837	=back	5724	=back
4838		5725
4839	=head1 AUTHOR	5726	=head1 AUTHOR
4840		5727
4841	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson.	5728	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael
		5729	Magnusson and Emanuele Giaquinta, and minor corrections by many others.
4842		5730

Diff Legend

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