ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.351 by root, Mon Jan 10 14:24:26 2011 UTC vs.
Revision 1.460 by root, Wed Jan 22 02:00:13 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
…		…
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_run (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
…		…
82		84
83	=head1 WHAT TO READ WHEN IN A HURRY	85	=head1 WHAT TO READ WHEN IN A HURRY
84		86
85	This manual tries to be very detailed, but unfortunately, this also makes	87	This manual tries to be very detailed, but unfortunately, this also makes
86	it very long. If you just want to know the basics of libev, I suggest	88	it very long. If you just want to know the basics of libev, I suggest
87	reading L<ANATOMY OF A WATCHER>, then the L<EXAMPLE PROGRAM> above and	89	reading L</ANATOMY OF A WATCHER>, then the L</EXAMPLE PROGRAM> above and
88	look up the missing functions in L<GLOBAL FUNCTIONS> and the C<ev_io> and	90	look up the missing functions in L</GLOBAL FUNCTIONS> and the C<ev_io> and
89	C<ev_timer> sections in L<WATCHER TYPES>.	91	C<ev_timer> sections in L</WATCHER TYPES>.
90		92
91	=head1 ABOUT LIBEV	93	=head1 ABOUT LIBEV
92		94
93	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
94	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
…		…
103	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
104	watcher.	106	watcher.
105		107
106	=head2 FEATURES	108	=head2 FEATURES
107		109
108	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>
109	BSD-specific C<kqueue> and the Solaris-specific event port mechanisms	111	interfaces, the BSD-specific C<kqueue> and the Solaris-specific event port
110	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>
111	(for C<ev_stat>), Linux eventfd/signalfd (for faster and cleaner	113	interface (for C<ev_stat>), Linux eventfd/signalfd (for faster and cleaner
112	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
113	timers (C<ev_timer>), absolute timers with customised rescheduling	115	timers (C<ev_timer>), absolute timers with customised rescheduling
114	(C<ev_periodic>), synchronous signals (C<ev_signal>), process status	116	(C<ev_periodic>), synchronous signals (C<ev_signal>), process status
115	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
116	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
…		…
157	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
158	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,
159	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
160	the libev caller and need to be fixed there.	162	the libev caller and need to be fixed there.
161		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
162	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
163	extensive consistency checking code. These do not trigger under normal
164	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.
165		171
166		172
167	=head1 GLOBAL FUNCTIONS	173	=head1 GLOBAL FUNCTIONS
168		174
169	These functions can be called anytime, even before initialising the	175	These functions can be called anytime, even before initialising the
…		…
174	=item ev_tstamp ev_time ()	180	=item ev_tstamp ev_time ()
175		181
176	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
177	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
178	you actually want to know. Also interesting is the combination of	184	you actually want to know. Also interesting is the combination of
179	C<ev_update_now> and C<ev_now>.	185	C<ev_now_update> and C<ev_now>.
180		186
181	=item ev_sleep (ev_tstamp interval)	187	=item ev_sleep (ev_tstamp interval)
182		188
183	Sleep for the given interval: The current thread will be blocked until	189	Sleep for the given interval: The current thread will be blocked
184	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
185	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 >>).
186		198
187	=item int ev_version_major ()	199	=item int ev_version_major ()
188		200
189	=item int ev_version_minor ()	201	=item int ev_version_minor ()
190		202
…		…
241	the current system, you would need to look at C<ev_embeddable_backends ()	253	the current system, you would need to look at C<ev_embeddable_backends ()
242	& ev_supported_backends ()>, likewise for recommended ones.	254	& ev_supported_backends ()>, likewise for recommended ones.
243		255
244	See the description of C<ev_embed> watchers for more info.	256	See the description of C<ev_embed> watchers for more info.
245		257
246	=item ev_set_allocator (void *(*cb)(void *ptr, long size))	258	=item ev_set_allocator (void *(*cb)(void *ptr, long size) throw ())
247		259
248	Sets the allocation function to use (the prototype is similar - the	260	Sets the allocation function to use (the prototype is similar - the
249	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
250	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
251	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
…		…
257		269
258	You could override this function in high-availability programs to, say,	270	You could override this function in high-availability programs to, say,
259	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,
260	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.
261		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
262	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
263	retries (example requires a standards-compliant C<realloc>).	289	retries.
264		290
265	static void *	291	static void *
266	persistent_realloc (void *ptr, size_t size)	292	persistent_realloc (void *ptr, size_t size)
267	{	293	{
		294	if (!size)
		295	{
		296	free (ptr);
		297	return 0;
		298	}
		299
268	for (;;)	300	for (;;)
269	{	301	{
270	void *newptr = realloc (ptr, size);	302	void *newptr = realloc (ptr, size);
271		303
272	if (newptr)	304	if (newptr)
…		…
277	}	309	}
278		310
279	...	311	...
280	ev_set_allocator (persistent_realloc);	312	ev_set_allocator (persistent_realloc);
281		313
282	=item ev_set_syserr_cb (void (*cb)(const char *msg))	314	=item ev_set_syserr_cb (void (*cb)(const char *msg) throw ())
283		315
284	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
285	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
286	indicating the system call or subsystem causing the problem. If this	318	indicating the system call or subsystem causing the problem. If this
287	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
…		…
390		422
391	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
392	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
393	C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will	425	C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will
394	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
395	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
396	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).
397		431
398	=item C<EVFLAG_FORKCHECK>	432	=item C<EVFLAG_FORKCHECK>
399		433
400	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
401	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.
402		436
403	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,
404	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
405	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
406	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
407	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
408	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).
409		444
410	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
411	forget about forgetting to tell libev about forking) when you use this	446	forget about forgetting to tell libev about forking, although you still
412	flag.	447	have to ignore C<SIGPIPE>) when you use this flag.
413		448
414	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>
415	environment variable.	450	environment variable.
416		451
417	=item C<EVFLAG_NOINOTIFY>	452	=item C<EVFLAG_NOINOTIFY>
…		…
435	example) that can't properly initialise their signal masks.	470	example) that can't properly initialise their signal masks.
436		471
437	=item C<EVFLAG_NOSIGMASK>	472	=item C<EVFLAG_NOSIGMASK>
438		473
439	When this flag is specified, then libev will avoid to modify the signal	474	When this flag is specified, then libev will avoid to modify the signal
440	mask. Specifically, this means you ahve to make sure signals are unblocked	475	mask. Specifically, this means you have to make sure signals are unblocked
441	when you want to receive them.	476	when you want to receive them.
442		477
443	This behaviour is useful when you want to do your own signal handling, or	478	This behaviour is useful when you want to do your own signal handling, or
444	want to handle signals only in specific threads and want to avoid libev	479	want to handle signals only in specific threads and want to avoid libev
445	unblocking the signals.	480	unblocking the signals.
446		481
447	This flag's behaviour will become the default in future versions of libev.	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.
448		495
449	=item C<EVBACKEND_SELECT> (value 1, portable select backend)	496	=item C<EVBACKEND_SELECT> (value 1, portable select backend)
450		497
451	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
452	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,
…		…
477	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
478	C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>.	525	C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>.
479		526
480	=item C<EVBACKEND_EPOLL> (value 4, Linux)	527	=item C<EVBACKEND_EPOLL> (value 4, Linux)
481		528
482	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
483	kernels).	530	kernels).
484		531
485	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
486	but it scales phenomenally better. While poll and select usually scale	533	it scales phenomenally better. While poll and select usually scale like
487	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
488	epoll scales either O(1) or O(active_fds).	535	fd), epoll scales either O(1) or O(active_fds).
489		536
490	The epoll mechanism deserves honorable mention as the most misdesigned	537	The epoll mechanism deserves honorable mention as the most misdesigned
491	of the more advanced event mechanisms: mere annoyances include silently	538	of the more advanced event mechanisms: mere annoyances include silently
492	dropping file descriptors, requiring a system call per change per file	539	dropping file descriptors, requiring a system call per change per file
493	descriptor (and unnecessary guessing of parameters), problems with dup,	540	descriptor (and unnecessary guessing of parameters), problems with dup,
…		…
496	0.1ms) and so on. The biggest issue is fork races, however - if a program	543	0.1ms) and so on. The biggest issue is fork races, however - if a program
497	forks then I<both> parent and child process have to recreate the epoll	544	forks then I<both> parent and child process have to recreate the epoll
498	set, which can take considerable time (one syscall per file descriptor)	545	set, which can take considerable time (one syscall per file descriptor)
499	and is of course hard to detect.	546	and is of course hard to detect.
500		547
501	Epoll is also notoriously buggy - embedding epoll fds I<should> work, but	548	Epoll is also notoriously buggy - embedding epoll fds I<should> work,
502	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
503	I<different> file descriptors (even already closed ones, so one cannot	550	totally I<different> file descriptors (even already closed ones, so
504	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
505	on SMP systems). Libev tries to counter these spurious notifications by	552	(especially on SMP systems). Libev tries to counter these spurious
506	employing an additional generation counter and comparing that against the	553	notifications by employing an additional generation counter and comparing
507	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
508	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
509	perfectly fine with C<select> (files, many character devices...).	559	perfectly fine with C<select> (files, many character devices...).
510		560
511	Epoll is truly the train wreck analog among event poll mechanisms.	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...
512		564
513	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
514	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
515	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
516	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
…		…
528	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
529	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
530	the usage. So sad.	582	the usage. So sad.
531		583
532	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
533	all kernel versions tested so far.	585	a lot of kernel revisions, but probably(!) works in current versions.
534		586
535	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
536	C<EVBACKEND_POLL>.	588	C<EVBACKEND_POLL>.
537		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
538	=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)	634	=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)
539		635
540	Kqueue deserves special mention, as at the time of this writing, it	636	Kqueue deserves special mention, as at the time this backend was
541	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
542	with anything but sockets and pipes, except on Darwin, where of course	638	work reliably with anything but sockets and pipes, except on Darwin,
543	it's completely useless). Unlike epoll, however, whose brokenness	639	where of course it's completely useless). Unlike epoll, however, whose
544	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)
545	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
546	"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
547	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
548	system like NetBSD.	644	known-to-be-good (-enough) system like NetBSD.
549		645
550	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
551	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
552	the target platform). See C<ev_embed> watchers for more info.	648	the target platform). See C<ev_embed> watchers for more info.
553		649
554	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
555	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
556	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
557	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
558	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
559	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
560	cases	656	drops fds silently in similarly hard-to-detect cases.
561		657
562	This backend usually performs well under most conditions.	658	This backend usually performs well under most conditions.
563		659
564	While nominally embeddable in other event loops, this doesn't work	660	While nominally embeddable in other event loops, this doesn't work
565	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
…		…
592	On the positive side, this backend actually performed fully to	688	On the positive side, this backend actually performed fully to
593	specification in all tests and is fully embeddable, which is a rare feat	689	specification in all tests and is fully embeddable, which is a rare feat
594	among the OS-specific backends (I vastly prefer correctness over speed	690	among the OS-specific backends (I vastly prefer correctness over speed
595	hacks).	691	hacks).
596		692
597	On the negative side, the interface is I<bizarre>, with the event polling	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
598	function sometimes returning events to the caller even though an error	695	function sometimes returns events to the caller even though an error
599	occured, but with no indication whether it has done so or not (yes, it's	696	occurred, but with no indication whether it has done so or not (yes, it's
600	even documented that way) - deadly for edge-triggered interfaces, but	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
601	fortunately libev seems to be able to work around it.	701	Fortunately libev seems to be able to work around these idiocies.
602		702
603	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
604	C<EVBACKEND_POLL>.	704	C<EVBACKEND_POLL>.
605		705
606	=item C<EVBACKEND_ALL>	706	=item C<EVBACKEND_ALL>
…		…
634		734
635	Example: Use whatever libev has to offer, but make sure that kqueue is	735	Example: Use whatever libev has to offer, but make sure that kqueue is
636	used if available.	736	used if available.
637		737
638	struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE);	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);
639		745
640	=item ev_loop_destroy (loop)	746	=item ev_loop_destroy (loop)
641		747
642	Destroys an event loop object (frees all memory and kernel state	748	Destroys an event loop object (frees all memory and kernel state
643	etc.). None of the active event watchers will be stopped in the normal	749	etc.). None of the active event watchers will be stopped in the normal
…		…
660	If you need dynamically allocated loops it is better to use C<ev_loop_new>	766	If you need dynamically allocated loops it is better to use C<ev_loop_new>
661	and C<ev_loop_destroy>.	767	and C<ev_loop_destroy>.
662		768
663	=item ev_loop_fork (loop)	769	=item ev_loop_fork (loop)
664		770
665	This function sets a flag that causes subsequent C<ev_run> iterations to	771	This function sets a flag that causes subsequent C<ev_run> iterations
666	reinitialise the kernel state for backends that have one. Despite the	772	to reinitialise the kernel state for backends that have one. Despite
667	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
668	the child process. You I<must> call it (or use C<EVFLAG_FORKCHECK>) in the	774	watchers (except inside an C<ev_prepare> callback), but it makes most
		775	sense after forking, in the child process. You I<must> call it (or use
669	child before resuming or calling C<ev_run>.	776	C<EVFLAG_FORKCHECK>) in the child before resuming or calling C<ev_run>.
670		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
671	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
672	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
673	because some kernel interfaces *cough* I<kqueue> *cough* do funny things	783	because some kernel interfaces *cough* I<kqueue> *cough* do funny things
674	during fork.	784	during fork.
675		785
676	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
…		…
746		856
747	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
748	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
749	the current time is a good idea.	859	the current time is a good idea.
750		860
751	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.
752		862
753	=item ev_suspend (loop)	863	=item ev_suspend (loop)
754		864
755	=item ev_resume (loop)	865	=item ev_resume (loop)
756		866
…		…
774	without a previous call to C<ev_suspend>.	884	without a previous call to C<ev_suspend>.
775		885
776	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
777	event loop time (see C<ev_now_update>).	887	event loop time (see C<ev_now_update>).
778		888
779	=item ev_run (loop, int flags)	889	=item bool ev_run (loop, int flags)
780		890
781	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
782	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
783	handling events. It will ask the operating system for any new events, call	893	handling events. It will ask the operating system for any new events, call
784	the watcher callbacks, an then repeat the whole process indefinitely: This	894	the watcher callbacks, and then repeat the whole process indefinitely: This
785	is why event loops are called I<loops>.	895	is why event loops are called I<loops>.
786		896
787	If the flags argument is specified as C<0>, it will keep handling events	897	If the flags argument is specified as C<0>, it will keep handling events
788	until either no event watchers are active anymore or C<ev_break> was	898	until either no event watchers are active anymore or C<ev_break> was
789	called.	899	called.
		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").
790		904
791	Please note that an explicit C<ev_break> is usually better than	905	Please note that an explicit C<ev_break> is usually better than
792	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
793	finished (especially in interactive programs), but having a program	907	finished (especially in interactive programs), but having a program
794	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
795	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
796	beauty.	910	beauty.
797		911
798	This function is also I<mostly> exception-safe - you can break out of	912	This function is I<mostly> exception-safe - you can break out of a
799	a C<ev_run> call by calling C<longjmp> in a callback, throwing a C++	913	C<ev_run> call by calling C<longjmp> in a callback, throwing a C++
800	exception and so on. This does not decrement the C<ev_depth> value, nor	914	exception and so on. This does not decrement the C<ev_depth> value, nor
801	will it clear any outstanding C<EVBREAK_ONE> breaks.	915	will it clear any outstanding C<EVBREAK_ONE> breaks.
802		916
803	A flags value of C<EVRUN_NOWAIT> will look for new events, will handle	917	A flags value of C<EVRUN_NOWAIT> will look for new events, will handle
804	those events and any already outstanding ones, but will not wait and	918	those events and any already outstanding ones, but will not wait and
…		…
816	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
817	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
818	own C<ev_run>"). 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
819	usually a better approach for this kind of thing.	933	usually a better approach for this kind of thing.
820		934
821	Here are the gory details of what C<ev_run> 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):
822		938
823	- Increment loop depth.	939	- Increment loop depth.
824	- Reset the ev_break status.	940	- Reset the ev_break status.
825	- Before the first iteration, call any pending watchers.	941	- Before the first iteration, call any pending watchers.
826	LOOP:	942	LOOP:
…		…
859	anymore.	975	anymore.
860		976
861	... queue jobs here, make sure they register event watchers as long	977	... queue jobs here, make sure they register event watchers as long
862	... 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..)
863	ev_run (my_loop, 0);	979	ev_run (my_loop, 0);
864	... jobs done or somebody called unloop. yeah!	980	... jobs done or somebody called break. yeah!
865		981
866	=item ev_break (loop, how)	982	=item ev_break (loop, how)
867		983
868	Can be used to make a call to C<ev_run> return early (but only after it	984	Can be used to make a call to C<ev_run> return early (but only after it
869	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
…		…
932	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.
933		1049
934	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
935	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,
936	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
937	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
938	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
939	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
940	once per this interval, on average.	1056	once per this interval, on average (as long as the host time resolution is
		1057	good enough).
941		1058
942	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
943	to spend more time collecting timeouts, at the expense of increased	1060	to spend more time collecting timeouts, at the expense of increased
944	latency/jitter/inexactness (the watcher callback will be called	1061	latency/jitter/inexactness (the watcher callback will be called
945	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
…		…
991	invoke the actual watchers inside another context (another thread etc.).	1108	invoke the actual watchers inside another context (another thread etc.).
992		1109
993	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
994	callback.	1111	callback.
995		1112
996	=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 ())
997		1114
998	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
999	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
1000	each call to a libev function.	1117	each call to a libev function.
1001		1118
1002	However, C<ev_run> can run an indefinite time, so it is not feasible	1119	However, C<ev_run> can run an indefinite time, so it is not feasible
1003	to wait for it to return. One way around this is to wake up the event	1120	to wait for it to return. One way around this is to wake up the event
1004	loop via C<ev_break> and C<av_async_send>, another way is to set these	1121	loop via C<ev_break> and C<ev_async_send>, another way is to set these
1005	I<release> and I<acquire> callbacks on the loop.	1122	I<release> and I<acquire> callbacks on the loop.
1006		1123
1007	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
1008	suspended waiting for new events, and C<acquire> is called just	1125	suspended waiting for new events, and C<acquire> is called just
1009	afterwards.	1126	afterwards.
…		…
1101	with a watcher-specific start function (C<< ev_TYPE_start (loop, watcher	1218	with a watcher-specific start function (C<< ev_TYPE_start (loop, watcher
1102	*) >>), and you can stop watching for events at any time by calling the	1219	*) >>), and you can stop watching for events at any time by calling the
1103	corresponding stop function (C<< ev_TYPE_stop (loop, watcher *) >>.	1220	corresponding stop function (C<< ev_TYPE_stop (loop, watcher *) >>.
1104		1221
1105	As long as your watcher is active (has been started but not stopped) you	1222	As long as your watcher is active (has been started but not stopped) you
1106	must not touch the values stored in it. Most specifically you must never	1223	must not touch the values stored in it except when explicitly documented
1107	reinitialise it or call its C<ev_TYPE_set> macro.	1224	otherwise. Most specifically you must never reinitialise it or call its
		1225	C<ev_TYPE_set> macro.
1108		1226
1109	Each and every callback receives the event loop pointer as first, the	1227	Each and every callback receives the event loop pointer as first, the
1110	registered watcher structure as second, and a bitset of received events as	1228	registered watcher structure as second, and a bitset of received events as
1111	third argument.	1229	third argument.
1112		1230
…		…
1149		1267
1150	=item C<EV_PREPARE>	1268	=item C<EV_PREPARE>
1151		1269
1152	=item C<EV_CHECK>	1270	=item C<EV_CHECK>
1153		1271
1154	All C<ev_prepare> watchers are invoked just I<before> C<ev_run> starts	1272	All C<ev_prepare> watchers are invoked just I<before> C<ev_run> starts to
1155	to gather new events, and all C<ev_check> watchers are invoked just after	1273	gather new events, and all C<ev_check> watchers are queued (not invoked)
1156	C<ev_run> has gathered them, but before it invokes any callbacks for any	1274	just after C<ev_run> has gathered them, but before it queues any callbacks
		1275	for any received events. That means C<ev_prepare> watchers are the last
		1276	watchers invoked before the event loop sleeps or polls for new events, and
		1277	C<ev_check> watchers will be invoked before any other watchers of the same
		1278	or lower priority within an event loop iteration.
		1279
1157	received events. Callbacks of both watcher types can start and stop as	1280	Callbacks of both watcher types can start and stop as many watchers as
1158	many watchers as they want, and all of them will be taken into account	1281	they want, and all of them will be taken into account (for example, a
1159	(for example, a C<ev_prepare> watcher might start an idle watcher to keep	1282	C<ev_prepare> watcher might start an idle watcher to keep C<ev_run> from
1160	C<ev_run> from blocking).	1283	blocking).
1161		1284
1162	=item C<EV_EMBED>	1285	=item C<EV_EMBED>
1163		1286
1164	The embedded event loop specified in the C<ev_embed> watcher needs attention.	1287	The embedded event loop specified in the C<ev_embed> watcher needs attention.
1165		1288
…		…
1288		1411
1289	=item callback ev_cb (ev_TYPE *watcher)	1412	=item callback ev_cb (ev_TYPE *watcher)
1290		1413
1291	Returns the callback currently set on the watcher.	1414	Returns the callback currently set on the watcher.
1292		1415
1293	=item ev_cb_set (ev_TYPE *watcher, callback)	1416	=item ev_set_cb (ev_TYPE *watcher, callback)
1294		1417
1295	Change the callback. You can change the callback at virtually any time	1418	Change the callback. You can change the callback at virtually any time
1296	(modulo threads).	1419	(modulo threads).
1297		1420
1298	=item ev_set_priority (ev_TYPE *watcher, int priority)	1421	=item ev_set_priority (ev_TYPE *watcher, int priority)
…		…
1316	or might not have been clamped to the valid range.	1439	or might not have been clamped to the valid range.
1317		1440
1318	The default priority used by watchers when no priority has been set is	1441	The default priority used by watchers when no priority has been set is
1319	always C<0>, which is supposed to not be too high and not be too low :).	1442	always C<0>, which is supposed to not be too high and not be too low :).
1320		1443
1321	See L<WATCHER PRIORITY MODELS>, below, for a more thorough treatment of	1444	See L</WATCHER PRIORITY MODELS>, below, for a more thorough treatment of
1322	priorities.	1445	priorities.
1323		1446
1324	=item ev_invoke (loop, ev_TYPE *watcher, int revents)	1447	=item ev_invoke (loop, ev_TYPE *watcher, int revents)
1325		1448
1326	Invoke the C<watcher> with the given C<loop> and C<revents>. Neither	1449	Invoke the C<watcher> with the given C<loop> and C<revents>. Neither
…		…
1351	See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related	1474	See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related
1352	functions that do not need a watcher.	1475	functions that do not need a watcher.
1353		1476
1354	=back	1477	=back
1355		1478
1356	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER	1479	See also the L</ASSOCIATING CUSTOM DATA WITH A WATCHER> and L</BUILDING YOUR
1357		1480	OWN COMPOSITE WATCHERS> idioms.
1358	Each watcher has, by default, a member C<void *data> that you can change
1359	and read at any time: libev will completely ignore it. This can be used
1360	to associate arbitrary data with your watcher. If you need more data and
1361	don't want to allocate memory and store a pointer to it in that data
1362	member, you can also "subclass" the watcher type and provide your own
1363	data:
1364
1365	struct my_io
1366	{
1367	ev_io io;
1368	int otherfd;
1369	void *somedata;
1370	struct whatever *mostinteresting;
1371	};
1372
1373	...
1374	struct my_io w;
1375	ev_io_init (&w.io, my_cb, fd, EV_READ);
1376
1377	And since your callback will be called with a pointer to the watcher, you
1378	can cast it back to your own type:
1379
1380	static void my_cb (struct ev_loop *loop, ev_io *w_, int revents)
1381	{
1382	struct my_io *w = (struct my_io *)w_;
1383	...
1384	}
1385
1386	More interesting and less C-conformant ways of casting your callback type
1387	instead have been omitted.
1388
1389	Another common scenario is to use some data structure with multiple
1390	embedded watchers:
1391
1392	struct my_biggy
1393	{
1394	int some_data;
1395	ev_timer t1;
1396	ev_timer t2;
1397	}
1398
1399	In this case getting the pointer to C<my_biggy> is a bit more
1400	complicated: Either you store the address of your C<my_biggy> struct
1401	in the C<data> member of the watcher (for woozies), or you need to use
1402	some pointer arithmetic using C<offsetof> inside your watchers (for real
1403	programmers):
1404
1405	#include <stddef.h>
1406
1407	static void
1408	t1_cb (EV_P_ ev_timer *w, int revents)
1409	{
1410	struct my_biggy big = (struct my_biggy *)
1411	(((char *)w) - offsetof (struct my_biggy, t1));
1412	}
1413
1414	static void
1415	t2_cb (EV_P_ ev_timer *w, int revents)
1416	{
1417	struct my_biggy big = (struct my_biggy *)
1418	(((char *)w) - offsetof (struct my_biggy, t2));
1419	}
1420		1481
1421	=head2 WATCHER STATES	1482	=head2 WATCHER STATES
1422		1483
1423	There are various watcher states mentioned throughout this manual -	1484	There are various watcher states mentioned throughout this manual -
1424	active, pending and so on. In this section these states and the rules to	1485	active, pending and so on. In this section these states and the rules to
1425	transition between them will be described in more detail - and while these	1486	transition between them will be described in more detail - and while these
1426	rules might look complicated, they usually do "the right thing".	1487	rules might look complicated, they usually do "the right thing".
1427		1488
1428	=over 4	1489	=over 4
1429		1490
1430	=item initialiased	1491	=item initialised
1431		1492
1432	Before a watcher can be registered with the event looop it has to be	1493	Before a watcher can be registered with the event loop it has to be
1433	initialised. This can be done with a call to C<ev_TYPE_init>, or calls to	1494	initialised. This can be done with a call to C<ev_TYPE_init>, or calls to
1434	C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function.	1495	C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function.
1435		1496
1436	In this state it is simply some block of memory that is suitable for use	1497	In this state it is simply some block of memory that is suitable for
1437	in an event loop. It can be moved around, freed, reused etc. at will.	1498	use in an event loop. It can be moved around, freed, reused etc. at
		1499	will - as long as you either keep the memory contents intact, or call
		1500	C<ev_TYPE_init> again.
1438		1501
1439	=item started/running/active	1502	=item started/running/active
1440		1503
1441	Once a watcher has been started with a call to C<ev_TYPE_start> it becomes	1504	Once a watcher has been started with a call to C<ev_TYPE_start> it becomes
1442	property of the event loop, and is actively waiting for events. While in	1505	property of the event loop, and is actively waiting for events. While in
…		…
1470	latter will clear any pending state the watcher might be in, regardless	1533	latter will clear any pending state the watcher might be in, regardless
1471	of whether it was active or not, so stopping a watcher explicitly before	1534	of whether it was active or not, so stopping a watcher explicitly before
1472	freeing it is often a good idea.	1535	freeing it is often a good idea.
1473		1536
1474	While stopped (and not pending) the watcher is essentially in the	1537	While stopped (and not pending) the watcher is essentially in the
1475	initialised state, that is it can be reused, moved, modified in any way	1538	initialised state, that is, it can be reused, moved, modified in any way
1476	you wish.	1539	you wish (but when you trash the memory block, you need to C<ev_TYPE_init>
		1540	it again).
1477		1541
1478	=back	1542	=back
1479		1543
1480	=head2 WATCHER PRIORITY MODELS	1544	=head2 WATCHER PRIORITY MODELS
1481		1545
1482	Many event loops support I<watcher priorities>, which are usually small	1546	Many event loops support I<watcher priorities>, which are usually small
1483	integers that influence the ordering of event callback invocation	1547	integers that influence the ordering of event callback invocation
1484	between watchers in some way, all else being equal.	1548	between watchers in some way, all else being equal.
1485		1549
1486	In libev, Watcher priorities can be set using C<ev_set_priority>. See its	1550	In libev, watcher priorities can be set using C<ev_set_priority>. See its
1487	description for the more technical details such as the actual priority	1551	description for the more technical details such as the actual priority
1488	range.	1552	range.
1489		1553
1490	There are two common ways how these these priorities are being interpreted	1554	There are two common ways how these these priorities are being interpreted
1491	by event loops:	1555	by event loops:
…		…
1585		1649
1586	This section describes each watcher in detail, but will not repeat	1650	This section describes each watcher in detail, but will not repeat
1587	information given in the last section. Any initialisation/set macros,	1651	information given in the last section. Any initialisation/set macros,
1588	functions and members specific to the watcher type are explained.	1652	functions and members specific to the watcher type are explained.
1589		1653
1590	Members are additionally marked with either I<[read-only]>, meaning that,	1654	Most members are additionally marked with either I<[read-only]>, meaning
1591	while the watcher is active, you can look at the member and expect some	1655	that, while the watcher is active, you can look at the member and expect
1592	sensible content, but you must not modify it (you can modify it while the	1656	some sensible content, but you must not modify it (you can modify it while
1593	watcher is stopped to your hearts content), or I<[read-write]>, which	1657	the watcher is stopped to your hearts content), or I<[read-write]>, which
1594	means you can expect it to have some sensible content while the watcher	1658	means you can expect it to have some sensible content while the watcher
1595	is active, but you can also modify it. Modifying it may not do something	1659	is active, but you can also modify it. Modifying it may not do something
1596	sensible or take immediate effect (or do anything at all), but libev will	1660	sensible or take immediate effect (or do anything at all), but libev will
1597	not crash or malfunction in any way.	1661	not crash or malfunction in any way.
1598		1662
		1663	In any case, the documentation for each member will explain what the
		1664	effects are, and if there are any additional access restrictions.
1599		1665
1600	=head2 C<ev_io> - is this file descriptor readable or writable?	1666	=head2 C<ev_io> - is this file descriptor readable or writable?
1601		1667
1602	I/O watchers check whether a file descriptor is readable or writable	1668	I/O watchers check whether a file descriptor is readable or writable
1603	in each iteration of the event loop, or, more precisely, when reading	1669	in each iteration of the event loop, or, more precisely, when reading
…		…
1610	In general you can register as many read and/or write event watchers per	1676	In general you can register as many read and/or write event watchers per
1611	fd as you want (as long as you don't confuse yourself). Setting all file	1677	fd as you want (as long as you don't confuse yourself). Setting all file
1612	descriptors to non-blocking mode is also usually a good idea (but not	1678	descriptors to non-blocking mode is also usually a good idea (but not
1613	required if you know what you are doing).	1679	required if you know what you are doing).
1614		1680
1615	If you cannot use non-blocking mode, then force the use of a
1616	known-to-be-good backend (at the time of this writing, this includes only
1617	C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>). The same applies to file
1618	descriptors for which non-blocking operation makes no sense (such as
1619	files) - libev doesn't guarantee any specific behaviour in that case.
1620
1621	Another thing you have to watch out for is that it is quite easy to	1681	Another thing you have to watch out for is that it is quite easy to
1622	receive "spurious" readiness notifications, that is your callback might	1682	receive "spurious" readiness notifications, that is, your callback might
1623	be called with C<EV_READ> but a subsequent C<read>(2) will actually block	1683	be called with C<EV_READ> but a subsequent C<read>(2) will actually block
1624	because there is no data. Not only are some backends known to create a	1684	because there is no data. It is very easy to get into this situation even
1625	lot of those (for example Solaris ports), it is very easy to get into	1685	with a relatively standard program structure. Thus it is best to always
1626	this situation even with a relatively standard program structure. Thus	1686	use non-blocking I/O: An extra C<read>(2) returning C<EAGAIN> is far
1627	it is best to always use non-blocking I/O: An extra C<read>(2) returning
1628	C<EAGAIN> is far preferable to a program hanging until some data arrives.	1687	preferable to a program hanging until some data arrives.
1629		1688
1630	If you cannot run the fd in non-blocking mode (for example you should	1689	If you cannot run the fd in non-blocking mode (for example you should
1631	not play around with an Xlib connection), then you have to separately	1690	not play around with an Xlib connection), then you have to separately
1632	re-test whether a file descriptor is really ready with a known-to-be good	1691	re-test whether a file descriptor is really ready with a known-to-be good
1633	interface such as poll (fortunately in our Xlib example, Xlib already	1692	interface such as poll (fortunately in the case of Xlib, it already does
1634	does this on its own, so its quite safe to use). Some people additionally	1693	this on its own, so its quite safe to use). Some people additionally
1635	use C<SIGALRM> and an interval timer, just to be sure you won't block	1694	use C<SIGALRM> and an interval timer, just to be sure you won't block
1636	indefinitely.	1695	indefinitely.
1637		1696
1638	But really, best use non-blocking mode.	1697	But really, best use non-blocking mode.
1639		1698
1640	=head3 The special problem of disappearing file descriptors	1699	=head3 The special problem of disappearing file descriptors
1641		1700
1642	Some backends (e.g. kqueue, epoll) need to be told about closing a file	1701	Some backends (e.g. kqueue, epoll, linuxaio) need to be told about closing
1643	descriptor (either due to calling C<close> explicitly or any other means,	1702	a file descriptor (either due to calling C<close> explicitly or any other
1644	such as C<dup2>). The reason is that you register interest in some file	1703	means, such as C<dup2>). The reason is that you register interest in some
1645	descriptor, but when it goes away, the operating system will silently drop	1704	file descriptor, but when it goes away, the operating system will silently
1646	this interest. If another file descriptor with the same number then is	1705	drop this interest. If another file descriptor with the same number then
1647	registered with libev, there is no efficient way to see that this is, in	1706	is registered with libev, there is no efficient way to see that this is,
1648	fact, a different file descriptor.	1707	in fact, a different file descriptor.
1649		1708
1650	To avoid having to explicitly tell libev about such cases, libev follows	1709	To avoid having to explicitly tell libev about such cases, libev follows
1651	the following policy: Each time C<ev_io_set> is being called, libev	1710	the following policy: Each time C<ev_io_set> is being called, libev
1652	will assume that this is potentially a new file descriptor, otherwise	1711	will assume that this is potentially a new file descriptor, otherwise
1653	it is assumed that the file descriptor stays the same. That means that	1712	it is assumed that the file descriptor stays the same. That means that
…		…
1667		1726
1668	There is no workaround possible except not registering events	1727	There is no workaround possible except not registering events
1669	for potentially C<dup ()>'ed file descriptors, or to resort to	1728	for potentially C<dup ()>'ed file descriptors, or to resort to
1670	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.	1729	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1671		1730
		1731	=head3 The special problem of files
		1732
		1733	Many people try to use C<select> (or libev) on file descriptors
		1734	representing files, and expect it to become ready when their program
		1735	doesn't block on disk accesses (which can take a long time on their own).
		1736
		1737	However, this cannot ever work in the "expected" way - you get a readiness
		1738	notification as soon as the kernel knows whether and how much data is
		1739	there, and in the case of open files, that's always the case, so you
		1740	always get a readiness notification instantly, and your read (or possibly
		1741	write) will still block on the disk I/O.
		1742
		1743	Another way to view it is that in the case of sockets, pipes, character
		1744	devices and so on, there is another party (the sender) that delivers data
		1745	on its own, but in the case of files, there is no such thing: the disk
		1746	will not send data on its own, simply because it doesn't know what you
		1747	wish to read - you would first have to request some data.
		1748
		1749	Since files are typically not-so-well supported by advanced notification
		1750	mechanism, libev tries hard to emulate POSIX behaviour with respect
		1751	to files, even though you should not use it. The reason for this is
		1752	convenience: sometimes you want to watch STDIN or STDOUT, which is
		1753	usually a tty, often a pipe, but also sometimes files or special devices
		1754	(for example, C<epoll> on Linux works with F</dev/random> but not with
		1755	F</dev/urandom>), and even though the file might better be served with
		1756	asynchronous I/O instead of with non-blocking I/O, it is still useful when
		1757	it "just works" instead of freezing.
		1758
		1759	So avoid file descriptors pointing to files when you know it (e.g. use
		1760	libeio), but use them when it is convenient, e.g. for STDIN/STDOUT, or
		1761	when you rarely read from a file instead of from a socket, and want to
		1762	reuse the same code path.
		1763
1672	=head3 The special problem of fork	1764	=head3 The special problem of fork
1673		1765
1674	Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit	1766	Some backends (epoll, kqueue, linuxaio, iouring) do not support C<fork ()>
1675	useless behaviour. Libev fully supports fork, but needs to be told about	1767	at all or exhibit useless behaviour. Libev fully supports fork, but needs
1676	it in the child.	1768	to be told about it in the child if you want to continue to use it in the
		1769	child.
1677		1770
1678	To support fork in your programs, you either have to call	1771	To support fork in your child processes, you have to call C<ev_loop_fork
1679	C<ev_default_fork ()> or C<ev_loop_fork ()> after a fork in the child,	1772	()> after a fork in the child, enable C<EVFLAG_FORKCHECK>, or resort to
1680	enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or	1773	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1681	C<EVBACKEND_POLL>.
1682		1774
1683	=head3 The special problem of SIGPIPE	1775	=head3 The special problem of SIGPIPE
1684		1776
1685	While not really specific to libev, it is easy to forget about C<SIGPIPE>:	1777	While not really specific to libev, it is easy to forget about C<SIGPIPE>:
1686	when writing to a pipe whose other end has been closed, your program gets	1778	when writing to a pipe whose other end has been closed, your program gets
…		…
1740		1832
1741	Configures an C<ev_io> watcher. The C<fd> is the file descriptor to	1833	Configures an C<ev_io> watcher. The C<fd> is the file descriptor to
1742	receive events for and C<events> is either C<EV_READ>, C<EV_WRITE> or	1834	receive events for and C<events> is either C<EV_READ>, C<EV_WRITE> or
1743	C<EV_READ | EV_WRITE>, to express the desire to receive the given events.	1835	C<EV_READ | EV_WRITE>, to express the desire to receive the given events.
1744		1836
1745	=item int fd [read-only]	1837	=item ev_io_modify (ev_io *, int events)
1746		1838
1747	The file descriptor being watched.	1839	Similar to C<ev_io_set>, but only changes the event mask. Using this might
		1840	be faster with some backends, as libev can assume that the C<fd> still
		1841	refers to the same underlying file description, something it cannot do
		1842	when using C<ev_io_set>.
1748		1843
		1844	=item int fd [no-modify]
		1845
		1846	The file descriptor being watched. While it can be read at any time, you
		1847	must not modify this member even when the watcher is stopped - always use
		1848	C<ev_io_set> for that.
		1849
1749	=item int events [read-only]	1850	=item int events [no-modify]
1750		1851
1751	The events being watched.	1852	The set of events the fd is being watched for, among other flags. Remember
		1853	that this is a bit set - to test for C<EV_READ>, use C<< w->events &
		1854	EV_READ >>, and similarly for C<EV_WRITE>.
		1855
		1856	As with C<fd>, you must not modify this member even when the watcher is
		1857	stopped, always use C<ev_io_set> or C<ev_io_modify> for that.
1752		1858
1753	=back	1859	=back
1754		1860
1755	=head3 Examples	1861	=head3 Examples
1756		1862
…		…
1784	detecting time jumps is hard, and some inaccuracies are unavoidable (the	1890	detecting time jumps is hard, and some inaccuracies are unavoidable (the
1785	monotonic clock option helps a lot here).	1891	monotonic clock option helps a lot here).
1786		1892
1787	The callback is guaranteed to be invoked only I<after> its timeout has	1893	The callback is guaranteed to be invoked only I<after> its timeout has
1788	passed (not I<at>, so on systems with very low-resolution clocks this	1894	passed (not I<at>, so on systems with very low-resolution clocks this
1789	might introduce a small delay). If multiple timers become ready during the	1895	might introduce a small delay, see "the special problem of being too
		1896	early", below). If multiple timers become ready during the same loop
1790	same loop iteration then the ones with earlier time-out values are invoked	1897	iteration then the ones with earlier time-out values are invoked before
1791	before ones of the same priority with later time-out values (but this is	1898	ones of the same priority with later time-out values (but this is no
1792	no longer true when a callback calls C<ev_run> recursively).	1899	longer true when a callback calls C<ev_run> recursively).
1793		1900
1794	=head3 Be smart about timeouts	1901	=head3 Be smart about timeouts
1795		1902
1796	Many real-world problems involve some kind of timeout, usually for error	1903	Many real-world problems involve some kind of timeout, usually for error
1797	recovery. A typical example is an HTTP request - if the other side hangs,	1904	recovery. A typical example is an HTTP request - if the other side hangs,
…		…
1872		1979
1873	In this case, it would be more efficient to leave the C<ev_timer> alone,	1980	In this case, it would be more efficient to leave the C<ev_timer> alone,
1874	but remember the time of last activity, and check for a real timeout only	1981	but remember the time of last activity, and check for a real timeout only
1875	within the callback:	1982	within the callback:
1876		1983
		1984	ev_tstamp timeout = 60.;
1877	ev_tstamp last_activity; // time of last activity	1985	ev_tstamp last_activity; // time of last activity
		1986	ev_timer timer;
1878		1987
1879	static void	1988	static void
1880	callback (EV_P_ ev_timer *w, int revents)	1989	callback (EV_P_ ev_timer *w, int revents)
1881	{	1990	{
1882	ev_tstamp now = ev_now (EV_A);	1991	// calculate when the timeout would happen
1883	ev_tstamp timeout = last_activity + 60.;	1992	ev_tstamp after = last_activity - ev_now (EV_A) + timeout;
1884		1993
1885	// if last_activity + 60. is older than now, we did time out	1994	// if negative, it means we the timeout already occurred
1886	if (timeout < now)	1995	if (after < 0.)
1887	{	1996	{
1888	// timeout occurred, take action	1997	// timeout occurred, take action
1889	}	1998	}
1890	else	1999	else
1891	{	2000	{
1892	// callback was invoked, but there was some activity, re-arm	2001	// callback was invoked, but there was some recent
1893	// the watcher to fire in last_activity + 60, which is	2002	// activity. simply restart the timer to time out
1894	// guaranteed to be in the future, so "again" is positive:	2003	// after "after" seconds, which is the earliest time
1895	w->repeat = timeout - now;	2004	// the timeout can occur.
		2005	ev_timer_set (w, after, 0.);
1896	ev_timer_again (EV_A_ w);	2006	ev_timer_start (EV_A_ w);
1897	}	2007	}
1898	}	2008	}
1899		2009
1900	To summarise the callback: first calculate the real timeout (defined	2010	To summarise the callback: first calculate in how many seconds the
1901	as "60 seconds after the last activity"), then check if that time has	2011	timeout will occur (by calculating the absolute time when it would occur,
1902	been reached, which means something I<did>, in fact, time out. Otherwise	2012	C<last_activity + timeout>, and subtracting the current time, C<ev_now
1903	the callback was invoked too early (C<timeout> is in the future), so	2013	(EV_A)> from that).
1904	re-schedule the timer to fire at that future time, to see if maybe we have
1905	a timeout then.
1906		2014
1907	Note how C<ev_timer_again> is used, taking advantage of the	2015	If this value is negative, then we are already past the timeout, i.e. we
1908	C<ev_timer_again> optimisation when the timer is already running.	2016	timed out, and need to do whatever is needed in this case.
		2017
		2018	Otherwise, we now the earliest time at which the timeout would trigger,
		2019	and simply start the timer with this timeout value.
		2020
		2021	In other words, each time the callback is invoked it will check whether
		2022	the timeout occurred. If not, it will simply reschedule itself to check
		2023	again at the earliest time it could time out. Rinse. Repeat.
1909		2024
1910	This scheme causes more callback invocations (about one every 60 seconds	2025	This scheme causes more callback invocations (about one every 60 seconds
1911	minus half the average time between activity), but virtually no calls to	2026	minus half the average time between activity), but virtually no calls to
1912	libev to change the timeout.	2027	libev to change the timeout.
1913		2028
1914	To start the timer, simply initialise the watcher and set C<last_activity>	2029	To start the machinery, simply initialise the watcher and set
1915	to the current time (meaning we just have some activity :), then call the	2030	C<last_activity> to the current time (meaning there was some activity just
1916	callback, which will "do the right thing" and start the timer:	2031	now), then call the callback, which will "do the right thing" and start
		2032	the timer:
1917		2033
		2034	last_activity = ev_now (EV_A);
1918	ev_init (timer, callback);	2035	ev_init (&timer, callback);
1919	last_activity = ev_now (loop);	2036	callback (EV_A_ &timer, 0);
1920	callback (loop, timer, EV_TIMER);
1921		2037
1922	And when there is some activity, simply store the current time in	2038	When there is some activity, simply store the current time in
1923	C<last_activity>, no libev calls at all:	2039	C<last_activity>, no libev calls at all:
1924		2040
		2041	if (activity detected)
1925	last_activity = ev_now (loop);	2042	last_activity = ev_now (EV_A);
		2043
		2044	When your timeout value changes, then the timeout can be changed by simply
		2045	providing a new value, stopping the timer and calling the callback, which
		2046	will again do the right thing (for example, time out immediately :).
		2047
		2048	timeout = new_value;
		2049	ev_timer_stop (EV_A_ &timer);
		2050	callback (EV_A_ &timer, 0);
1926		2051
1927	This technique is slightly more complex, but in most cases where the	2052	This technique is slightly more complex, but in most cases where the
1928	time-out is unlikely to be triggered, much more efficient.	2053	time-out is unlikely to be triggered, much more efficient.
1929
1930	Changing the timeout is trivial as well (if it isn't hard-coded in the
1931	callback :) - just change the timeout and invoke the callback, which will
1932	fix things for you.
1933		2054
1934	=item 4. Wee, just use a double-linked list for your timeouts.	2055	=item 4. Wee, just use a double-linked list for your timeouts.
1935		2056
1936	If there is not one request, but many thousands (millions...), all	2057	If there is not one request, but many thousands (millions...), all
1937	employing some kind of timeout with the same timeout value, then one can	2058	employing some kind of timeout with the same timeout value, then one can
…		…
1964	Method #1 is almost always a bad idea, and buys you nothing. Method #4 is	2085	Method #1 is almost always a bad idea, and buys you nothing. Method #4 is
1965	rather complicated, but extremely efficient, something that really pays	2086	rather complicated, but extremely efficient, something that really pays
1966	off after the first million or so of active timers, i.e. it's usually	2087	off after the first million or so of active timers, i.e. it's usually
1967	overkill :)	2088	overkill :)
1968		2089
		2090	=head3 The special problem of being too early
		2091
		2092	If you ask a timer to call your callback after three seconds, then
		2093	you expect it to be invoked after three seconds - but of course, this
		2094	cannot be guaranteed to infinite precision. Less obviously, it cannot be
		2095	guaranteed to any precision by libev - imagine somebody suspending the
		2096	process with a STOP signal for a few hours for example.
		2097
		2098	So, libev tries to invoke your callback as soon as possible I<after> the
		2099	delay has occurred, but cannot guarantee this.
		2100
		2101	A less obvious failure mode is calling your callback too early: many event
		2102	loops compare timestamps with a "elapsed delay >= requested delay", but
		2103	this can cause your callback to be invoked much earlier than you would
		2104	expect.
		2105
		2106	To see why, imagine a system with a clock that only offers full second
		2107	resolution (think windows if you can't come up with a broken enough OS
		2108	yourself). If you schedule a one-second timer at the time 500.9, then the
		2109	event loop will schedule your timeout to elapse at a system time of 500
		2110	(500.9 truncated to the resolution) + 1, or 501.
		2111
		2112	If an event library looks at the timeout 0.1s later, it will see "501 >=
		2113	501" and invoke the callback 0.1s after it was started, even though a
		2114	one-second delay was requested - this is being "too early", despite best
		2115	intentions.
		2116
		2117	This is the reason why libev will never invoke the callback if the elapsed
		2118	delay equals the requested delay, but only when the elapsed delay is
		2119	larger than the requested delay. In the example above, libev would only invoke
		2120	the callback at system time 502, or 1.1s after the timer was started.
		2121
		2122	So, while libev cannot guarantee that your callback will be invoked
		2123	exactly when requested, it I<can> and I<does> guarantee that the requested
		2124	delay has actually elapsed, or in other words, it always errs on the "too
		2125	late" side of things.
		2126
1969	=head3 The special problem of time updates	2127	=head3 The special problem of time updates
1970		2128
1971	Establishing the current time is a costly operation (it usually takes at	2129	Establishing the current time is a costly operation (it usually takes
1972	least two system calls): EV therefore updates its idea of the current	2130	at least one system call): EV therefore updates its idea of the current
1973	time only before and after C<ev_run> collects new events, which causes a	2131	time only before and after C<ev_run> collects new events, which causes a
1974	growing difference between C<ev_now ()> and C<ev_time ()> when handling	2132	growing difference between C<ev_now ()> and C<ev_time ()> when handling
1975	lots of events in one iteration.	2133	lots of events in one iteration.
1976		2134
1977	The relative timeouts are calculated relative to the C<ev_now ()>	2135	The relative timeouts are calculated relative to the C<ev_now ()>
1978	time. This is usually the right thing as this timestamp refers to the time	2136	time. This is usually the right thing as this timestamp refers to the time
1979	of the event triggering whatever timeout you are modifying/starting. If	2137	of the event triggering whatever timeout you are modifying/starting. If
1980	you suspect event processing to be delayed and you I<need> to base the	2138	you suspect event processing to be delayed and you I<need> to base the
1981	timeout on the current time, use something like this to adjust for this:	2139	timeout on the current time, use something like the following to adjust
		2140	for it:
1982		2141
1983	ev_timer_set (&timer, after + ev_now () - ev_time (), 0.);	2142	ev_timer_set (&timer, after + (ev_time () - ev_now ()), 0.);
1984		2143
1985	If the event loop is suspended for a long time, you can also force an	2144	If the event loop is suspended for a long time, you can also force an
1986	update of the time returned by C<ev_now ()> by calling C<ev_now_update	2145	update of the time returned by C<ev_now ()> by calling C<ev_now_update
1987	()>.	2146	()>, although that will push the event time of all outstanding events
		2147	further into the future.
		2148
		2149	=head3 The special problem of unsynchronised clocks
		2150
		2151	Modern systems have a variety of clocks - libev itself uses the normal
		2152	"wall clock" clock and, if available, the monotonic clock (to avoid time
		2153	jumps).
		2154
		2155	Neither of these clocks is synchronised with each other or any other clock
		2156	on the system, so C<ev_time ()> might return a considerably different time
		2157	than C<gettimeofday ()> or C<time ()>. On a GNU/Linux system, for example,
		2158	a call to C<gettimeofday> might return a second count that is one higher
		2159	than a directly following call to C<time>.
		2160
		2161	The moral of this is to only compare libev-related timestamps with
		2162	C<ev_time ()> and C<ev_now ()>, at least if you want better precision than
		2163	a second or so.
		2164
		2165	One more problem arises due to this lack of synchronisation: if libev uses
		2166	the system monotonic clock and you compare timestamps from C<ev_time>
		2167	or C<ev_now> from when you started your timer and when your callback is
		2168	invoked, you will find that sometimes the callback is a bit "early".
		2169
		2170	This is because C<ev_timer>s work in real time, not wall clock time, so
		2171	libev makes sure your callback is not invoked before the delay happened,
		2172	I<measured according to the real time>, not the system clock.
		2173
		2174	If your timeouts are based on a physical timescale (e.g. "time out this
		2175	connection after 100 seconds") then this shouldn't bother you as it is
		2176	exactly the right behaviour.
		2177
		2178	If you want to compare wall clock/system timestamps to your timers, then
		2179	you need to use C<ev_periodic>s, as these are based on the wall clock
		2180	time, where your comparisons will always generate correct results.
1988		2181
1989	=head3 The special problems of suspended animation	2182	=head3 The special problems of suspended animation
1990		2183
1991	When you leave the server world it is quite customary to hit machines that	2184	When you leave the server world it is quite customary to hit machines that
1992	can suspend/hibernate - what happens to the clocks during such a suspend?	2185	can suspend/hibernate - what happens to the clocks during such a suspend?
…		…
2022		2215
2023	=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)	2216	=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
2024		2217
2025	=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)	2218	=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)
2026		2219
2027	Configure the timer to trigger after C<after> seconds. If C<repeat>	2220	Configure the timer to trigger after C<after> seconds (fractional and
2028	is C<0.>, then it will automatically be stopped once the timeout is	2221	negative values are supported). If C<repeat> is C<0.>, then it will
2029	reached. If it is positive, then the timer will automatically be	2222	automatically be stopped once the timeout is reached. If it is positive,
2030	configured to trigger again C<repeat> seconds later, again, and again,	2223	then the timer will automatically be configured to trigger again C<repeat>
2031	until stopped manually.	2224	seconds later, again, and again, until stopped manually.
2032		2225
2033	The timer itself will do a best-effort at avoiding drift, that is, if	2226	The timer itself will do a best-effort at avoiding drift, that is, if
2034	you configure a timer to trigger every 10 seconds, then it will normally	2227	you configure a timer to trigger every 10 seconds, then it will normally
2035	trigger at exactly 10 second intervals. If, however, your program cannot	2228	trigger at exactly 10 second intervals. If, however, your program cannot
2036	keep up with the timer (because it takes longer than those 10 seconds to	2229	keep up with the timer (because it takes longer than those 10 seconds to
2037	do stuff) the timer will not fire more than once per event loop iteration.	2230	do stuff) the timer will not fire more than once per event loop iteration.
2038		2231
2039	=item ev_timer_again (loop, ev_timer *)	2232	=item ev_timer_again (loop, ev_timer *)
2040		2233
2041	This will act as if the timer timed out and restart it again if it is	2234	This will act as if the timer timed out, and restarts it again if it is
2042	repeating. The exact semantics are:	2235	repeating. It basically works like calling C<ev_timer_stop>, updating the
		2236	timeout to the C<repeat> value and calling C<ev_timer_start>.
2043		2237
		2238	The exact semantics are as in the following rules, all of which will be
		2239	applied to the watcher:
		2240
		2241	=over 4
		2242
2044	If the timer is pending, its pending status is cleared.	2243	=item If the timer is pending, the pending status is always cleared.
2045		2244
2046	If the timer is started but non-repeating, stop it (as if it timed out).	2245	=item If the timer is started but non-repeating, stop it (as if it timed
		2246	out, without invoking it).
2047		2247
2048	If the timer is repeating, either start it if necessary (with the	2248	=item If the timer is repeating, make the C<repeat> value the new timeout
2049	C<repeat> value), or reset the running timer to the C<repeat> value.	2249	and start the timer, if necessary.
2050		2250
		2251	=back
		2252
2051	This sounds a bit complicated, see L<Be smart about timeouts>, above, for a	2253	This sounds a bit complicated, see L</Be smart about timeouts>, above, for a
2052	usage example.	2254	usage example.
2053		2255
2054	=item ev_tstamp ev_timer_remaining (loop, ev_timer *)	2256	=item ev_tstamp ev_timer_remaining (loop, ev_timer *)
2055		2257
2056	Returns the remaining time until a timer fires. If the timer is active,	2258	Returns the remaining time until a timer fires. If the timer is active,
…		…
2109	Periodic watchers are also timers of a kind, but they are very versatile	2311	Periodic watchers are also timers of a kind, but they are very versatile
2110	(and unfortunately a bit complex).	2312	(and unfortunately a bit complex).
2111		2313
2112	Unlike C<ev_timer>, periodic watchers are not based on real time (or	2314	Unlike C<ev_timer>, periodic watchers are not based on real time (or
2113	relative time, the physical time that passes) but on wall clock time	2315	relative time, the physical time that passes) but on wall clock time
2114	(absolute time, the thing you can read on your calender or clock). The	2316	(absolute time, the thing you can read on your calendar or clock). The
2115	difference is that wall clock time can run faster or slower than real	2317	difference is that wall clock time can run faster or slower than real
2116	time, and time jumps are not uncommon (e.g. when you adjust your	2318	time, and time jumps are not uncommon (e.g. when you adjust your
2117	wrist-watch).	2319	wrist-watch).
2118		2320
2119	You can tell a periodic watcher to trigger after some specific point	2321	You can tell a periodic watcher to trigger after some specific point
…		…
2124	C<ev_timer>, which would still trigger roughly 10 seconds after starting	2326	C<ev_timer>, which would still trigger roughly 10 seconds after starting
2125	it, as it uses a relative timeout).	2327	it, as it uses a relative timeout).
2126		2328
2127	C<ev_periodic> watchers can also be used to implement vastly more complex	2329	C<ev_periodic> watchers can also be used to implement vastly more complex
2128	timers, such as triggering an event on each "midnight, local time", or	2330	timers, such as triggering an event on each "midnight, local time", or
2129	other complicated rules. This cannot be done with C<ev_timer> watchers, as	2331	other complicated rules. This cannot easily be done with C<ev_timer>
2130	those cannot react to time jumps.	2332	watchers, as those cannot react to time jumps.
2131		2333
2132	As with timers, the callback is guaranteed to be invoked only when the	2334	As with timers, the callback is guaranteed to be invoked only when the
2133	point in time where it is supposed to trigger has passed. If multiple	2335	point in time where it is supposed to trigger has passed. If multiple
2134	timers become ready during the same loop iteration then the ones with	2336	timers become ready during the same loop iteration then the ones with
2135	earlier time-out values are invoked before ones with later time-out values	2337	earlier time-out values are invoked before ones with later time-out values
…		…
2176		2378
2177	Another way to think about it (for the mathematically inclined) is that	2379	Another way to think about it (for the mathematically inclined) is that
2178	C<ev_periodic> will try to run the callback in this mode at the next possible	2380	C<ev_periodic> will try to run the callback in this mode at the next possible
2179	time where C<time = offset (mod interval)>, regardless of any time jumps.	2381	time where C<time = offset (mod interval)>, regardless of any time jumps.
2180		2382
2181	For numerical stability it is preferable that the C<offset> value is near	2383	The C<interval> I<MUST> be positive, and for numerical stability, the
2182	C<ev_now ()> (the current time), but there is no range requirement for	2384	interval value should be higher than C<1/8192> (which is around 100
2183	this value, and in fact is often specified as zero.	2385	microseconds) and C<offset> should be higher than C<0> and should have
		2386	at most a similar magnitude as the current time (say, within a factor of
		2387	ten). Typical values for offset are, in fact, C<0> or something between
		2388	C<0> and C<interval>, which is also the recommended range.
2184		2389
2185	Note also that there is an upper limit to how often a timer can fire (CPU	2390	Note also that there is an upper limit to how often a timer can fire (CPU
2186	speed for example), so if C<interval> is very small then timing stability	2391	speed for example), so if C<interval> is very small then timing stability
2187	will of course deteriorate. Libev itself tries to be exact to be about one	2392	will of course deteriorate. Libev itself tries to be exact to be about one
2188	millisecond (if the OS supports it and the machine is fast enough).	2393	millisecond (if the OS supports it and the machine is fast enough).
…		…
2218		2423
2219	NOTE: I<< This callback must always return a time that is higher than or	2424	NOTE: I<< This callback must always return a time that is higher than or
2220	equal to the passed C<now> value >>.	2425	equal to the passed C<now> value >>.
2221		2426
2222	This can be used to create very complex timers, such as a timer that	2427	This can be used to create very complex timers, such as a timer that
2223	triggers on "next midnight, local time". To do this, you would calculate the	2428	triggers on "next midnight, local time". To do this, you would calculate
2224	next midnight after C<now> and return the timestamp value for this. How	2429	the next midnight after C<now> and return the timestamp value for
2225	you do this is, again, up to you (but it is not trivial, which is the main	2430	this. Here is a (completely untested, no error checking) example on how to
2226	reason I omitted it as an example).	2431	do this:
		2432
		2433	#include <time.h>
		2434
		2435	static ev_tstamp
		2436	my_rescheduler (ev_periodic *w, ev_tstamp now)
		2437	{
		2438	time_t tnow = (time_t)now;
		2439	struct tm tm;
		2440	localtime_r (&tnow, &tm);
		2441
		2442	tm.tm_sec = tm.tm_min = tm.tm_hour = 0; // midnight current day
		2443	++tm.tm_mday; // midnight next day
		2444
		2445	return mktime (&tm);
		2446	}
		2447
		2448	Note: this code might run into trouble on days that have more then two
		2449	midnights (beginning and end).
2227		2450
2228	=back	2451	=back
2229		2452
2230	=item ev_periodic_again (loop, ev_periodic *)	2453	=item ev_periodic_again (loop, ev_periodic *)
2231		2454
…		…
2296		2519
2297	ev_periodic hourly_tick;	2520	ev_periodic hourly_tick;
2298	ev_periodic_init (&hourly_tick, clock_cb,	2521	ev_periodic_init (&hourly_tick, clock_cb,
2299	fmod (ev_now (loop), 3600.), 3600., 0);	2522	fmod (ev_now (loop), 3600.), 3600., 0);
2300	ev_periodic_start (loop, &hourly_tick);	2523	ev_periodic_start (loop, &hourly_tick);
2301		2524
2302		2525
2303	=head2 C<ev_signal> - signal me when a signal gets signalled!	2526	=head2 C<ev_signal> - signal me when a signal gets signalled!
2304		2527
2305	Signal watchers will trigger an event when the process receives a specific	2528	Signal watchers will trigger an event when the process receives a specific
2306	signal one or more times. Even though signals are very asynchronous, libev	2529	signal one or more times. Even though signals are very asynchronous, libev
…		…
2316	only within the same loop, i.e. you can watch for C<SIGINT> in your	2539	only within the same loop, i.e. you can watch for C<SIGINT> in your
2317	default loop and for C<SIGIO> in another loop, but you cannot watch for	2540	default loop and for C<SIGIO> in another loop, but you cannot watch for
2318	C<SIGINT> in both the default loop and another loop at the same time. At	2541	C<SIGINT> in both the default loop and another loop at the same time. At
2319	the moment, C<SIGCHLD> is permanently tied to the default loop.	2542	the moment, C<SIGCHLD> is permanently tied to the default loop.
2320		2543
2321	When the first watcher gets started will libev actually register something	2544	Only after the first watcher for a signal is started will libev actually
2322	with the kernel (thus it coexists with your own signal handlers as long as	2545	register something with the kernel. It thus coexists with your own signal
2323	you don't register any with libev for the same signal).	2546	handlers as long as you don't register any with libev for the same signal.
2324		2547
2325	If possible and supported, libev will install its handlers with	2548	If possible and supported, libev will install its handlers with
2326	C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should	2549	C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should
2327	not be unduly interrupted. If you have a problem with system calls getting	2550	not be unduly interrupted. If you have a problem with system calls getting
2328	interrupted by signals you can block all signals in an C<ev_check> watcher	2551	interrupted by signals you can block all signals in an C<ev_check> watcher
…		…
2331	=head3 The special problem of inheritance over fork/execve/pthread_create	2554	=head3 The special problem of inheritance over fork/execve/pthread_create
2332		2555
2333	Both the signal mask (C<sigprocmask>) and the signal disposition	2556	Both the signal mask (C<sigprocmask>) and the signal disposition
2334	(C<sigaction>) are unspecified after starting a signal watcher (and after	2557	(C<sigaction>) are unspecified after starting a signal watcher (and after
2335	stopping it again), that is, libev might or might not block the signal,	2558	stopping it again), that is, libev might or might not block the signal,
2336	and might or might not set or restore the installed signal handler.	2559	and might or might not set or restore the installed signal handler (but
		2560	see C<EVFLAG_NOSIGMASK>).
2337		2561
2338	While this does not matter for the signal disposition (libev never	2562	While this does not matter for the signal disposition (libev never
2339	sets signals to C<SIG_IGN>, so handlers will be reset to C<SIG_DFL> on	2563	sets signals to C<SIG_IGN>, so handlers will be reset to C<SIG_DFL> on
2340	C<execve>), this matters for the signal mask: many programs do not expect	2564	C<execve>), this matters for the signal mask: many programs do not expect
2341	certain signals to be blocked.	2565	certain signals to be blocked.
…		…
2512		2736
2513	=head2 C<ev_stat> - did the file attributes just change?	2737	=head2 C<ev_stat> - did the file attributes just change?
2514		2738
2515	This watches a file system path for attribute changes. That is, it calls	2739	This watches a file system path for attribute changes. That is, it calls
2516	C<stat> on that path in regular intervals (or when the OS says it changed)	2740	C<stat> on that path in regular intervals (or when the OS says it changed)
2517	and sees if it changed compared to the last time, invoking the callback if	2741	and sees if it changed compared to the last time, invoking the callback
2518	it did.	2742	if it did. Starting the watcher C<stat>'s the file, so only changes that
		2743	happen after the watcher has been started will be reported.
2519		2744
2520	The path does not need to exist: changing from "path exists" to "path does	2745	The path does not need to exist: changing from "path exists" to "path does
2521	not exist" is a status change like any other. The condition "path does not	2746	not exist" is a status change like any other. The condition "path does not
2522	exist" (or more correctly "path cannot be stat'ed") is signified by the	2747	exist" (or more correctly "path cannot be stat'ed") is signified by the
2523	C<st_nlink> field being zero (which is otherwise always forced to be at	2748	C<st_nlink> field being zero (which is otherwise always forced to be at
…		…
2753	Apart from keeping your process non-blocking (which is a useful	2978	Apart from keeping your process non-blocking (which is a useful
2754	effect on its own sometimes), idle watchers are a good place to do	2979	effect on its own sometimes), idle watchers are a good place to do
2755	"pseudo-background processing", or delay processing stuff to after the	2980	"pseudo-background processing", or delay processing stuff to after the
2756	event loop has handled all outstanding events.	2981	event loop has handled all outstanding events.
2757		2982
		2983	=head3 Abusing an C<ev_idle> watcher for its side-effect
		2984
		2985	As long as there is at least one active idle watcher, libev will never
		2986	sleep unnecessarily. Or in other words, it will loop as fast as possible.
		2987	For this to work, the idle watcher doesn't need to be invoked at all - the
		2988	lowest priority will do.
		2989
		2990	This mode of operation can be useful together with an C<ev_check> watcher,
		2991	to do something on each event loop iteration - for example to balance load
		2992	between different connections.
		2993
		2994	See L</Abusing an ev_check watcher for its side-effect> for a longer
		2995	example.
		2996
2758	=head3 Watcher-Specific Functions and Data Members	2997	=head3 Watcher-Specific Functions and Data Members
2759		2998
2760	=over 4	2999	=over 4
2761		3000
2762	=item ev_idle_init (ev_idle *, callback)	3001	=item ev_idle_init (ev_idle *, callback)
…		…
2773	callback, free it. Also, use no error checking, as usual.	3012	callback, free it. Also, use no error checking, as usual.
2774		3013
2775	static void	3014	static void
2776	idle_cb (struct ev_loop *loop, ev_idle *w, int revents)	3015	idle_cb (struct ev_loop *loop, ev_idle *w, int revents)
2777	{	3016	{
		3017	// stop the watcher
		3018	ev_idle_stop (loop, w);
		3019
		3020	// now we can free it
2778	free (w);	3021	free (w);
		3022
2779	// now do something you wanted to do when the program has	3023	// now do something you wanted to do when the program has
2780	// no longer anything immediate to do.	3024	// no longer anything immediate to do.
2781	}	3025	}
2782		3026
2783	ev_idle *idle_watcher = malloc (sizeof (ev_idle));	3027	ev_idle *idle_watcher = malloc (sizeof (ev_idle));
…		…
2785	ev_idle_start (loop, idle_watcher);	3029	ev_idle_start (loop, idle_watcher);
2786		3030
2787		3031
2788	=head2 C<ev_prepare> and C<ev_check> - customise your event loop!	3032	=head2 C<ev_prepare> and C<ev_check> - customise your event loop!
2789		3033
2790	Prepare and check watchers are usually (but not always) used in pairs:	3034	Prepare and check watchers are often (but not always) used in pairs:
2791	prepare watchers get invoked before the process blocks and check watchers	3035	prepare watchers get invoked before the process blocks and check watchers
2792	afterwards.	3036	afterwards.
2793		3037
2794	You I<must not> call C<ev_run> or similar functions that enter	3038	You I<must not> call C<ev_run> (or similar functions that enter the
2795	the current event loop from either C<ev_prepare> or C<ev_check>	3039	current event loop) or C<ev_loop_fork> from either C<ev_prepare> or
2796	watchers. Other loops than the current one are fine, however. The	3040	C<ev_check> watchers. Other loops than the current one are fine,
2797	rationale behind this is that you do not need to check for recursion in	3041	however. The rationale behind this is that you do not need to check
2798	those watchers, i.e. the sequence will always be C<ev_prepare>, blocking,	3042	for recursion in those watchers, i.e. the sequence will always be
2799	C<ev_check> so if you have one watcher of each kind they will always be	3043	C<ev_prepare>, blocking, C<ev_check> so if you have one watcher of each
2800	called in pairs bracketing the blocking call.	3044	kind they will always be called in pairs bracketing the blocking call.
2801		3045
2802	Their main purpose is to integrate other event mechanisms into libev and	3046	Their main purpose is to integrate other event mechanisms into libev and
2803	their use is somewhat advanced. They could be used, for example, to track	3047	their use is somewhat advanced. They could be used, for example, to track
2804	variable changes, implement your own watchers, integrate net-snmp or a	3048	variable changes, implement your own watchers, integrate net-snmp or a
2805	coroutine library and lots more. They are also occasionally useful if	3049	coroutine library and lots more. They are also occasionally useful if
…		…
2823	with priority higher than or equal to the event loop and one coroutine	3067	with priority higher than or equal to the event loop and one coroutine
2824	of lower priority, but only once, using idle watchers to keep the event	3068	of lower priority, but only once, using idle watchers to keep the event
2825	loop from blocking if lower-priority coroutines are active, thus mapping	3069	loop from blocking if lower-priority coroutines are active, thus mapping
2826	low-priority coroutines to idle/background tasks).	3070	low-priority coroutines to idle/background tasks).
2827		3071
2828	It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>)	3072	When used for this purpose, it is recommended to give C<ev_check> watchers
2829	priority, to ensure that they are being run before any other watchers	3073	highest (C<EV_MAXPRI>) priority, to ensure that they are being run before
2830	after the poll (this doesn't matter for C<ev_prepare> watchers).	3074	any other watchers after the poll (this doesn't matter for C<ev_prepare>
		3075	watchers).
2831		3076
2832	Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not	3077	Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not
2833	activate ("feed") events into libev. While libev fully supports this, they	3078	activate ("feed") events into libev. While libev fully supports this, they
2834	might get executed before other C<ev_check> watchers did their job. As	3079	might get executed before other C<ev_check> watchers did their job. As
2835	C<ev_check> watchers are often used to embed other (non-libev) event	3080	C<ev_check> watchers are often used to embed other (non-libev) event
2836	loops those other event loops might be in an unusable state until their	3081	loops those other event loops might be in an unusable state until their
2837	C<ev_check> watcher ran (always remind yourself to coexist peacefully with	3082	C<ev_check> watcher ran (always remind yourself to coexist peacefully with
2838	others).	3083	others).
		3084
		3085	=head3 Abusing an C<ev_check> watcher for its side-effect
		3086
		3087	C<ev_check> (and less often also C<ev_prepare>) watchers can also be
		3088	useful because they are called once per event loop iteration. For
		3089	example, if you want to handle a large number of connections fairly, you
		3090	normally only do a bit of work for each active connection, and if there
		3091	is more work to do, you wait for the next event loop iteration, so other
		3092	connections have a chance of making progress.
		3093
		3094	Using an C<ev_check> watcher is almost enough: it will be called on the
		3095	next event loop iteration. However, that isn't as soon as possible -
		3096	without external events, your C<ev_check> watcher will not be invoked.
		3097
		3098	This is where C<ev_idle> watchers come in handy - all you need is a
		3099	single global idle watcher that is active as long as you have one active
		3100	C<ev_check> watcher. The C<ev_idle> watcher makes sure the event loop
		3101	will not sleep, and the C<ev_check> watcher makes sure a callback gets
		3102	invoked. Neither watcher alone can do that.
2839		3103
2840	=head3 Watcher-Specific Functions and Data Members	3104	=head3 Watcher-Specific Functions and Data Members
2841		3105
2842	=over 4	3106	=over 4
2843		3107
…		…
3044		3308
3045	=over 4	3309	=over 4
3046		3310
3047	=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)	3311	=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)
3048		3312
3049	=item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)	3313	=item ev_embed_set (ev_embed *, struct ev_loop *embedded_loop)
3050		3314
3051	Configures the watcher to embed the given loop, which must be	3315	Configures the watcher to embed the given loop, which must be
3052	embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be	3316	embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be
3053	invoked automatically, otherwise it is the responsibility of the callback	3317	invoked automatically, otherwise it is the responsibility of the callback
3054	to invoke it (it will continue to be called until the sweep has been done,	3318	to invoke it (it will continue to be called until the sweep has been done,
…		…
3075	used).	3339	used).
3076		3340
3077	struct ev_loop *loop_hi = ev_default_init (0);	3341	struct ev_loop *loop_hi = ev_default_init (0);
3078	struct ev_loop *loop_lo = 0;	3342	struct ev_loop *loop_lo = 0;
3079	ev_embed embed;	3343	ev_embed embed;
3080		3344
3081	// see if there is a chance of getting one that works	3345	// see if there is a chance of getting one that works
3082	// (remember that a flags value of 0 means autodetection)	3346	// (remember that a flags value of 0 means autodetection)
3083	loop_lo = ev_embeddable_backends () & ev_recommended_backends ()	3347	loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
3084	? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())	3348	? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
3085	: 0;	3349	: 0;
…		…
3099	C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).	3363	C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).
3100		3364
3101	struct ev_loop *loop = ev_default_init (0);	3365	struct ev_loop *loop = ev_default_init (0);
3102	struct ev_loop *loop_socket = 0;	3366	struct ev_loop *loop_socket = 0;
3103	ev_embed embed;	3367	ev_embed embed;
3104		3368
3105	if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)	3369	if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
3106	if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))	3370	if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
3107	{	3371	{
3108	ev_embed_init (&embed, 0, loop_socket);	3372	ev_embed_init (&embed, 0, loop_socket);
3109	ev_embed_start (loop, &embed);	3373	ev_embed_start (loop, &embed);
…		…
3117		3381
3118	=head2 C<ev_fork> - the audacity to resume the event loop after a fork	3382	=head2 C<ev_fork> - the audacity to resume the event loop after a fork
3119		3383
3120	Fork watchers are called when a C<fork ()> was detected (usually because	3384	Fork watchers are called when a C<fork ()> was detected (usually because
3121	whoever is a good citizen cared to tell libev about it by calling	3385	whoever is a good citizen cared to tell libev about it by calling
3122	C<ev_default_fork> or C<ev_loop_fork>). The invocation is done before the	3386	C<ev_loop_fork>). The invocation is done before the event loop blocks next
3123	event loop blocks next and before C<ev_check> watchers are being called,	3387	and before C<ev_check> watchers are being called, and only in the child
3124	and only in the child after the fork. If whoever good citizen calling	3388	after the fork. If whoever good citizen calling C<ev_default_fork> cheats
3125	C<ev_default_fork> cheats and calls it in the wrong process, the fork	3389	and calls it in the wrong process, the fork handlers will be invoked, too,
3126	handlers will be invoked, too, of course.	3390	of course.
3127		3391
3128	=head3 The special problem of life after fork - how is it possible?	3392	=head3 The special problem of life after fork - how is it possible?
3129		3393
3130	Most uses of C<fork()> consist of forking, then some simple calls to set	3394	Most uses of C<fork ()> consist of forking, then some simple calls to set
3131	up/change the process environment, followed by a call to C<exec()>. This	3395	up/change the process environment, followed by a call to C<exec()>. This
3132	sequence should be handled by libev without any problems.	3396	sequence should be handled by libev without any problems.
3133		3397
3134	This changes when the application actually wants to do event handling	3398	This changes when the application actually wants to do event handling
3135	in the child, or both parent in child, in effect "continuing" after the	3399	in the child, or both parent in child, in effect "continuing" after the
…		…
3212	atexit (program_exits);	3476	atexit (program_exits);
3213		3477
3214		3478
3215	=head2 C<ev_async> - how to wake up an event loop	3479	=head2 C<ev_async> - how to wake up an event loop
3216		3480
3217	In general, you cannot use an C<ev_run> from multiple threads or other	3481	In general, you cannot use an C<ev_loop> from multiple threads or other
3218	asynchronous sources such as signal handlers (as opposed to multiple event	3482	asynchronous sources such as signal handlers (as opposed to multiple event
3219	loops - those are of course safe to use in different threads).	3483	loops - those are of course safe to use in different threads).
3220		3484
3221	Sometimes, however, you need to wake up an event loop you do not control,	3485	Sometimes, however, you need to wake up an event loop you do not control,
3222	for example because it belongs to another thread. This is what C<ev_async>	3486	for example because it belongs to another thread. This is what C<ev_async>
…		…
3224	it by calling C<ev_async_send>, which is thread- and signal safe.	3488	it by calling C<ev_async_send>, which is thread- and signal safe.
3225		3489
3226	This functionality is very similar to C<ev_signal> watchers, as signals,	3490	This functionality is very similar to C<ev_signal> watchers, as signals,
3227	too, are asynchronous in nature, and signals, too, will be compressed	3491	too, are asynchronous in nature, and signals, too, will be compressed
3228	(i.e. the number of callback invocations may be less than the number of	3492	(i.e. the number of callback invocations may be less than the number of
3229	C<ev_async_sent> calls). In fact, you could use signal watchers as a kind	3493	C<ev_async_send> calls). In fact, you could use signal watchers as a kind
3230	of "global async watchers" by using a watcher on an otherwise unused	3494	of "global async watchers" by using a watcher on an otherwise unused
3231	signal, and C<ev_feed_signal> to signal this watcher from another thread,	3495	signal, and C<ev_feed_signal> to signal this watcher from another thread,
3232	even without knowing which loop owns the signal.	3496	even without knowing which loop owns the signal.
3233
3234	Unlike C<ev_signal> watchers, C<ev_async> works with any event loop, not
3235	just the default loop.
3236		3497
3237	=head3 Queueing	3498	=head3 Queueing
3238		3499
3239	C<ev_async> does not support queueing of data in any way. The reason	3500	C<ev_async> does not support queueing of data in any way. The reason
3240	is that the author does not know of a simple (or any) algorithm for a	3501	is that the author does not know of a simple (or any) algorithm for a
…		…
3332	trust me.	3593	trust me.
3333		3594
3334	=item ev_async_send (loop, ev_async *)	3595	=item ev_async_send (loop, ev_async *)
3335		3596
3336	Sends/signals/activates the given C<ev_async> watcher, that is, feeds	3597	Sends/signals/activates the given C<ev_async> watcher, that is, feeds
3337	an C<EV_ASYNC> event on the watcher into the event loop. Unlike	3598	an C<EV_ASYNC> event on the watcher into the event loop, and instantly
		3599	returns.
		3600
3338	C<ev_feed_event>, this call is safe to do from other threads, signal or	3601	Unlike C<ev_feed_event>, this call is safe to do from other threads,
3339	similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding	3602	signal or similar contexts (see the discussion of C<EV_ATOMIC_T> in the
3340	section below on what exactly this means).	3603	embedding section below on what exactly this means).
3341		3604
3342	Note that, as with other watchers in libev, multiple events might get	3605	Note that, as with other watchers in libev, multiple events might get
3343	compressed into a single callback invocation (another way to look at this	3606	compressed into a single callback invocation (another way to look at
3344	is that C<ev_async> watchers are level-triggered, set on C<ev_async_send>,	3607	this is that C<ev_async> watchers are level-triggered: they are set on
3345	reset when the event loop detects that).	3608	C<ev_async_send>, reset when the event loop detects that).
3346		3609
3347	This call incurs the overhead of a system call only once per event loop	3610	This call incurs the overhead of at most one extra system call per event
3348	iteration, so while the overhead might be noticeable, it doesn't apply to	3611	loop iteration, if the event loop is blocked, and no syscall at all if
3349	repeated calls to C<ev_async_send> for the same event loop.	3612	the event loop (or your program) is processing events. That means that
		3613	repeated calls are basically free (there is no need to avoid calls for
		3614	performance reasons) and that the overhead becomes smaller (typically
		3615	zero) under load.
3350		3616
3351	=item bool = ev_async_pending (ev_async *)	3617	=item bool = ev_async_pending (ev_async *)
3352		3618
3353	Returns a non-zero value when C<ev_async_send> has been called on the	3619	Returns a non-zero value when C<ev_async_send> has been called on the
3354	watcher but the event has not yet been processed (or even noted) by the	3620	watcher but the event has not yet been processed (or even noted) by the
…		…
3371		3637
3372	There are some other functions of possible interest. Described. Here. Now.	3638	There are some other functions of possible interest. Described. Here. Now.
3373		3639
3374	=over 4	3640	=over 4
3375		3641
3376	=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback)	3642	=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback, arg)
3377		3643
3378	This function combines a simple timer and an I/O watcher, calls your	3644	This function combines a simple timer and an I/O watcher, calls your
3379	callback on whichever event happens first and automatically stops both	3645	callback on whichever event happens first and automatically stops both
3380	watchers. This is useful if you want to wait for a single event on an fd	3646	watchers. This is useful if you want to wait for a single event on an fd
3381	or timeout without having to allocate/configure/start/stop/free one or	3647	or timeout without having to allocate/configure/start/stop/free one or
…		…
3409	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);	3675	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
3410		3676
3411	=item ev_feed_fd_event (loop, int fd, int revents)	3677	=item ev_feed_fd_event (loop, int fd, int revents)
3412		3678
3413	Feed an event on the given fd, as if a file descriptor backend detected	3679	Feed an event on the given fd, as if a file descriptor backend detected
3414	the given events it.	3680	the given events.
3415		3681
3416	=item ev_feed_signal_event (loop, int signum)	3682	=item ev_feed_signal_event (loop, int signum)
3417		3683
3418	Feed an event as if the given signal occurred. See also C<ev_feed_signal>,	3684	Feed an event as if the given signal occurred. See also C<ev_feed_signal>,
3419	which is async-safe.	3685	which is async-safe.
…		…
3425		3691
3426	This section explains some common idioms that are not immediately	3692	This section explains some common idioms that are not immediately
3427	obvious. Note that examples are sprinkled over the whole manual, and this	3693	obvious. Note that examples are sprinkled over the whole manual, and this
3428	section only contains stuff that wouldn't fit anywhere else.	3694	section only contains stuff that wouldn't fit anywhere else.
3429		3695
3430	=over 4	3696	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
3431		3697
3432	=item Model/nested event loop invocations and exit conditions.	3698	Each watcher has, by default, a C<void *data> member that you can read
		3699	or modify at any time: libev will completely ignore it. This can be used
		3700	to associate arbitrary data with your watcher. If you need more data and
		3701	don't want to allocate memory separately and store a pointer to it in that
		3702	data member, you can also "subclass" the watcher type and provide your own
		3703	data:
		3704
		3705	struct my_io
		3706	{
		3707	ev_io io;
		3708	int otherfd;
		3709	void *somedata;
		3710	struct whatever *mostinteresting;
		3711	};
		3712
		3713	...
		3714	struct my_io w;
		3715	ev_io_init (&w.io, my_cb, fd, EV_READ);
		3716
		3717	And since your callback will be called with a pointer to the watcher, you
		3718	can cast it back to your own type:
		3719
		3720	static void my_cb (struct ev_loop *loop, ev_io *w_, int revents)
		3721	{
		3722	struct my_io *w = (struct my_io *)w_;
		3723	...
		3724	}
		3725
		3726	More interesting and less C-conformant ways of casting your callback
		3727	function type instead have been omitted.
		3728
		3729	=head2 BUILDING YOUR OWN COMPOSITE WATCHERS
		3730
		3731	Another common scenario is to use some data structure with multiple
		3732	embedded watchers, in effect creating your own watcher that combines
		3733	multiple libev event sources into one "super-watcher":
		3734
		3735	struct my_biggy
		3736	{
		3737	int some_data;
		3738	ev_timer t1;
		3739	ev_timer t2;
		3740	}
		3741
		3742	In this case getting the pointer to C<my_biggy> is a bit more
		3743	complicated: Either you store the address of your C<my_biggy> struct in
		3744	the C<data> member of the watcher (for woozies or C++ coders), or you need
		3745	to use some pointer arithmetic using C<offsetof> inside your watchers (for
		3746	real programmers):
		3747
		3748	#include <stddef.h>
		3749
		3750	static void
		3751	t1_cb (EV_P_ ev_timer *w, int revents)
		3752	{
		3753	struct my_biggy big = (struct my_biggy *)
		3754	(((char *)w) - offsetof (struct my_biggy, t1));
		3755	}
		3756
		3757	static void
		3758	t2_cb (EV_P_ ev_timer *w, int revents)
		3759	{
		3760	struct my_biggy big = (struct my_biggy *)
		3761	(((char *)w) - offsetof (struct my_biggy, t2));
		3762	}
		3763
		3764	=head2 AVOIDING FINISHING BEFORE RETURNING
		3765
		3766	Often you have structures like this in event-based programs:
		3767
		3768	callback ()
		3769	{
		3770	free (request);
		3771	}
		3772
		3773	request = start_new_request (..., callback);
		3774
		3775	The intent is to start some "lengthy" operation. The C<request> could be
		3776	used to cancel the operation, or do other things with it.
		3777
		3778	It's not uncommon to have code paths in C<start_new_request> that
		3779	immediately invoke the callback, for example, to report errors. Or you add
		3780	some caching layer that finds that it can skip the lengthy aspects of the
		3781	operation and simply invoke the callback with the result.
		3782
		3783	The problem here is that this will happen I<before> C<start_new_request>
		3784	has returned, so C<request> is not set.
		3785
		3786	Even if you pass the request by some safer means to the callback, you
		3787	might want to do something to the request after starting it, such as
		3788	canceling it, which probably isn't working so well when the callback has
		3789	already been invoked.
		3790
		3791	A common way around all these issues is to make sure that
		3792	C<start_new_request> I<always> returns before the callback is invoked. If
		3793	C<start_new_request> immediately knows the result, it can artificially
		3794	delay invoking the callback by using a C<prepare> or C<idle> watcher for
		3795	example, or more sneakily, by reusing an existing (stopped) watcher and
		3796	pushing it into the pending queue:
		3797
		3798	ev_set_cb (watcher, callback);
		3799	ev_feed_event (EV_A_ watcher, 0);
		3800
		3801	This way, C<start_new_request> can safely return before the callback is
		3802	invoked, while not delaying callback invocation too much.
		3803
		3804	=head2 MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS
3433		3805
3434	Often (especially in GUI toolkits) there are places where you have	3806	Often (especially in GUI toolkits) there are places where you have
3435	I<modal> interaction, which is most easily implemented by recursively	3807	I<modal> interaction, which is most easily implemented by recursively
3436	invoking C<ev_run>.	3808	invoking C<ev_run>.
3437		3809
3438	This brings the problem of exiting - a callback might want to finish the	3810	This brings the problem of exiting - a callback might want to finish the
3439	main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but	3811	main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but
3440	a modal "Are you sure?" dialog is still waiting), or just the nested one	3812	a modal "Are you sure?" dialog is still waiting), or just the nested one
3441	and not the main one (e.g. user clocked "Ok" in a modal dialog), or some	3813	and not the main one (e.g. user clocked "Ok" in a modal dialog), or some
3442	other combination: In these cases, C<ev_break> will not work alone.	3814	other combination: In these cases, a simple C<ev_break> will not work.
3443		3815
3444	The solution is to maintain "break this loop" variable for each C<ev_run>	3816	The solution is to maintain "break this loop" variable for each C<ev_run>
3445	invocation, and use a loop around C<ev_run> until the condition is	3817	invocation, and use a loop around C<ev_run> until the condition is
3446	triggered, using C<EVRUN_ONCE>:	3818	triggered, using C<EVRUN_ONCE>:
3447		3819
…		…
3449	int exit_main_loop = 0;	3821	int exit_main_loop = 0;
3450		3822
3451	while (!exit_main_loop)	3823	while (!exit_main_loop)
3452	ev_run (EV_DEFAULT_ EVRUN_ONCE);	3824	ev_run (EV_DEFAULT_ EVRUN_ONCE);
3453		3825
3454	// in a model watcher	3826	// in a modal watcher
3455	int exit_nested_loop = 0;	3827	int exit_nested_loop = 0;
3456		3828
3457	while (!exit_nested_loop)	3829	while (!exit_nested_loop)
3458	ev_run (EV_A_ EVRUN_ONCE);	3830	ev_run (EV_A_ EVRUN_ONCE);
3459		3831
…		…
3466	exit_main_loop = 1;	3838	exit_main_loop = 1;
3467		3839
3468	// exit both	3840	// exit both
3469	exit_main_loop = exit_nested_loop = 1;	3841	exit_main_loop = exit_nested_loop = 1;
3470		3842
3471	=back	3843	=head2 THREAD LOCKING EXAMPLE
		3844
		3845	Here is a fictitious example of how to run an event loop in a different
		3846	thread from where callbacks are being invoked and watchers are
		3847	created/added/removed.
		3848
		3849	For a real-world example, see the C<EV::Loop::Async> perl module,
		3850	which uses exactly this technique (which is suited for many high-level
		3851	languages).
		3852
		3853	The example uses a pthread mutex to protect the loop data, a condition
		3854	variable to wait for callback invocations, an async watcher to notify the
		3855	event loop thread and an unspecified mechanism to wake up the main thread.
		3856
		3857	First, you need to associate some data with the event loop:
		3858
		3859	typedef struct {
		3860	mutex_t lock; /* global loop lock */
		3861	ev_async async_w;
		3862	thread_t tid;
		3863	cond_t invoke_cv;
		3864	} userdata;
		3865
		3866	void prepare_loop (EV_P)
		3867	{
		3868	// for simplicity, we use a static userdata struct.
		3869	static userdata u;
		3870
		3871	ev_async_init (&u->async_w, async_cb);
		3872	ev_async_start (EV_A_ &u->async_w);
		3873
		3874	pthread_mutex_init (&u->lock, 0);
		3875	pthread_cond_init (&u->invoke_cv, 0);
		3876
		3877	// now associate this with the loop
		3878	ev_set_userdata (EV_A_ u);
		3879	ev_set_invoke_pending_cb (EV_A_ l_invoke);
		3880	ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
		3881
		3882	// then create the thread running ev_run
		3883	pthread_create (&u->tid, 0, l_run, EV_A);
		3884	}
		3885
		3886	The callback for the C<ev_async> watcher does nothing: the watcher is used
		3887	solely to wake up the event loop so it takes notice of any new watchers
		3888	that might have been added:
		3889
		3890	static void
		3891	async_cb (EV_P_ ev_async *w, int revents)
		3892	{
		3893	// just used for the side effects
		3894	}
		3895
		3896	The C<l_release> and C<l_acquire> callbacks simply unlock/lock the mutex
		3897	protecting the loop data, respectively.
		3898
		3899	static void
		3900	l_release (EV_P)
		3901	{
		3902	userdata *u = ev_userdata (EV_A);
		3903	pthread_mutex_unlock (&u->lock);
		3904	}
		3905
		3906	static void
		3907	l_acquire (EV_P)
		3908	{
		3909	userdata *u = ev_userdata (EV_A);
		3910	pthread_mutex_lock (&u->lock);
		3911	}
		3912
		3913	The event loop thread first acquires the mutex, and then jumps straight
		3914	into C<ev_run>:
		3915
		3916	void *
		3917	l_run (void *thr_arg)
		3918	{
		3919	struct ev_loop *loop = (struct ev_loop *)thr_arg;
		3920
		3921	l_acquire (EV_A);
		3922	pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
		3923	ev_run (EV_A_ 0);
		3924	l_release (EV_A);
		3925
		3926	return 0;
		3927	}
		3928
		3929	Instead of invoking all pending watchers, the C<l_invoke> callback will
		3930	signal the main thread via some unspecified mechanism (signals? pipe
		3931	writes? C<Async::Interrupt>?) and then waits until all pending watchers
		3932	have been called (in a while loop because a) spurious wakeups are possible
		3933	and b) skipping inter-thread-communication when there are no pending
		3934	watchers is very beneficial):
		3935
		3936	static void
		3937	l_invoke (EV_P)
		3938	{
		3939	userdata *u = ev_userdata (EV_A);
		3940
		3941	while (ev_pending_count (EV_A))
		3942	{
		3943	wake_up_other_thread_in_some_magic_or_not_so_magic_way ();
		3944	pthread_cond_wait (&u->invoke_cv, &u->lock);
		3945	}
		3946	}
		3947
		3948	Now, whenever the main thread gets told to invoke pending watchers, it
		3949	will grab the lock, call C<ev_invoke_pending> and then signal the loop
		3950	thread to continue:
		3951
		3952	static void
		3953	real_invoke_pending (EV_P)
		3954	{
		3955	userdata *u = ev_userdata (EV_A);
		3956
		3957	pthread_mutex_lock (&u->lock);
		3958	ev_invoke_pending (EV_A);
		3959	pthread_cond_signal (&u->invoke_cv);
		3960	pthread_mutex_unlock (&u->lock);
		3961	}
		3962
		3963	Whenever you want to start/stop a watcher or do other modifications to an
		3964	event loop, you will now have to lock:
		3965
		3966	ev_timer timeout_watcher;
		3967	userdata *u = ev_userdata (EV_A);
		3968
		3969	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
		3970
		3971	pthread_mutex_lock (&u->lock);
		3972	ev_timer_start (EV_A_ &timeout_watcher);
		3973	ev_async_send (EV_A_ &u->async_w);
		3974	pthread_mutex_unlock (&u->lock);
		3975
		3976	Note that sending the C<ev_async> watcher is required because otherwise
		3977	an event loop currently blocking in the kernel will have no knowledge
		3978	about the newly added timer. By waking up the loop it will pick up any new
		3979	watchers in the next event loop iteration.
		3980
		3981	=head2 THREADS, COROUTINES, CONTINUATIONS, QUEUES... INSTEAD OF CALLBACKS
		3982
		3983	While the overhead of a callback that e.g. schedules a thread is small, it
		3984	is still an overhead. If you embed libev, and your main usage is with some
		3985	kind of threads or coroutines, you might want to customise libev so that
		3986	doesn't need callbacks anymore.
		3987
		3988	Imagine you have coroutines that you can switch to using a function
		3989	C<switch_to (coro)>, that libev runs in a coroutine called C<libev_coro>
		3990	and that due to some magic, the currently active coroutine is stored in a
		3991	global called C<current_coro>. Then you can build your own "wait for libev
		3992	event" primitive by changing C<EV_CB_DECLARE> and C<EV_CB_INVOKE> (note
		3993	the differing C<;> conventions):
		3994
		3995	#define EV_CB_DECLARE(type) struct my_coro *cb;
		3996	#define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb)
		3997
		3998	That means instead of having a C callback function, you store the
		3999	coroutine to switch to in each watcher, and instead of having libev call
		4000	your callback, you instead have it switch to that coroutine.
		4001
		4002	A coroutine might now wait for an event with a function called
		4003	C<wait_for_event>. (the watcher needs to be started, as always, but it doesn't
		4004	matter when, or whether the watcher is active or not when this function is
		4005	called):
		4006
		4007	void
		4008	wait_for_event (ev_watcher *w)
		4009	{
		4010	ev_set_cb (w, current_coro);
		4011	switch_to (libev_coro);
		4012	}
		4013
		4014	That basically suspends the coroutine inside C<wait_for_event> and
		4015	continues the libev coroutine, which, when appropriate, switches back to
		4016	this or any other coroutine.
		4017
		4018	You can do similar tricks if you have, say, threads with an event queue -
		4019	instead of storing a coroutine, you store the queue object and instead of
		4020	switching to a coroutine, you push the watcher onto the queue and notify
		4021	any waiters.
		4022
		4023	To embed libev, see L</EMBEDDING>, but in short, it's easiest to create two
		4024	files, F<my_ev.h> and F<my_ev.c> that include the respective libev files:
		4025
		4026	// my_ev.h
		4027	#define EV_CB_DECLARE(type) struct my_coro *cb;
		4028	#define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb)
		4029	#include "../libev/ev.h"
		4030
		4031	// my_ev.c
		4032	#define EV_H "my_ev.h"
		4033	#include "../libev/ev.c"
		4034
		4035	And then use F<my_ev.h> when you would normally use F<ev.h>, and compile
		4036	F<my_ev.c> into your project. When properly specifying include paths, you
		4037	can even use F<ev.h> as header file name directly.
3472		4038
3473		4039
3474	=head1 LIBEVENT EMULATION	4040	=head1 LIBEVENT EMULATION
3475		4041
3476	Libev offers a compatibility emulation layer for libevent. It cannot	4042	Libev offers a compatibility emulation layer for libevent. It cannot
…		…
3506		4072
3507	=back	4073	=back
3508		4074
3509	=head1 C++ SUPPORT	4075	=head1 C++ SUPPORT
3510		4076
		4077	=head2 C API
		4078
		4079	The normal C API should work fine when used from C++: both ev.h and the
		4080	libev sources can be compiled as C++. Therefore, code that uses the C API
		4081	will work fine.
		4082
		4083	Proper exception specifications might have to be added to callbacks passed
		4084	to libev: exceptions may be thrown only from watcher callbacks, all other
		4085	callbacks (allocator, syserr, loop acquire/release and periodic reschedule
		4086	callbacks) must not throw exceptions, and might need a C<noexcept>
		4087	specification. If you have code that needs to be compiled as both C and
		4088	C++ you can use the C<EV_NOEXCEPT> macro for this:
		4089
		4090	static void
		4091	fatal_error (const char *msg) EV_NOEXCEPT
		4092	{
		4093	perror (msg);
		4094	abort ();
		4095	}
		4096
		4097	...
		4098	ev_set_syserr_cb (fatal_error);
		4099
		4100	The only API functions that can currently throw exceptions are C<ev_run>,
		4101	C<ev_invoke>, C<ev_invoke_pending> and C<ev_loop_destroy> (the latter
		4102	because it runs cleanup watchers).
		4103
		4104	Throwing exceptions in watcher callbacks is only supported if libev itself
		4105	is compiled with a C++ compiler or your C and C++ environments allow
		4106	throwing exceptions through C libraries (most do).
		4107
		4108	=head2 C++ API
		4109
3511	Libev comes with some simplistic wrapper classes for C++ that mainly allow	4110	Libev comes with some simplistic wrapper classes for C++ that mainly allow
3512	you to use some convenience methods to start/stop watchers and also change	4111	you to use some convenience methods to start/stop watchers and also change
3513	the callback model to a model using method callbacks on objects.	4112	the callback model to a model using method callbacks on objects.
3514		4113
3515	To use it,	4114	To use it,
3516		4115
3517	#include <ev++.h>	4116	#include <ev++.h>
3518		4117
3519	This automatically includes F<ev.h> and puts all of its definitions (many	4118	This automatically includes F<ev.h> and puts all of its definitions (many
3520	of them macros) into the global namespace. All C++ specific things are	4119	of them macros) into the global namespace. All C++ specific things are
3521	put into the C<ev> namespace. It should support all the same embedding	4120	put into the C<ev> namespace. It should support all the same embedding
…		…
3530	with C<operator ()> can be used as callbacks. Other types should be easy	4129	with C<operator ()> can be used as callbacks. Other types should be easy
3531	to add as long as they only need one additional pointer for context. If	4130	to add as long as they only need one additional pointer for context. If
3532	you need support for other types of functors please contact the author	4131	you need support for other types of functors please contact the author
3533	(preferably after implementing it).	4132	(preferably after implementing it).
3534		4133
		4134	For all this to work, your C++ compiler either has to use the same calling
		4135	conventions as your C compiler (for static member functions), or you have
		4136	to embed libev and compile libev itself as C++.
		4137
3535	Here is a list of things available in the C<ev> namespace:	4138	Here is a list of things available in the C<ev> namespace:
3536		4139
3537	=over 4	4140	=over 4
3538		4141
3539	=item C<ev::READ>, C<ev::WRITE> etc.	4142	=item C<ev::READ>, C<ev::WRITE> etc.
…		…
3548	=item C<ev::io>, C<ev::timer>, C<ev::periodic>, C<ev::idle>, C<ev::sig> etc.	4151	=item C<ev::io>, C<ev::timer>, C<ev::periodic>, C<ev::idle>, C<ev::sig> etc.
3549		4152
3550	For each C<ev_TYPE> watcher in F<ev.h> there is a corresponding class of	4153	For each C<ev_TYPE> watcher in F<ev.h> there is a corresponding class of
3551	the same name in the C<ev> namespace, with the exception of C<ev_signal>	4154	the same name in the C<ev> namespace, with the exception of C<ev_signal>
3552	which is called C<ev::sig> to avoid clashes with the C<signal> macro	4155	which is called C<ev::sig> to avoid clashes with the C<signal> macro
3553	defines by many implementations.	4156	defined by many implementations.
3554		4157
3555	All of those classes have these methods:	4158	All of those classes have these methods:
3556		4159
3557	=over 4	4160	=over 4
3558		4161
…		…
3620	void operator() (ev::io &w, int revents)	4223	void operator() (ev::io &w, int revents)
3621	{	4224	{
3622	...	4225	...
3623	}	4226	}
3624	}	4227	}
3625		4228
3626	myfunctor f;	4229	myfunctor f;
3627		4230
3628	ev::io w;	4231	ev::io w;
3629	w.set (&f);	4232	w.set (&f);
3630		4233
…		…
3648	Associates a different C<struct ev_loop> with this watcher. You can only	4251	Associates a different C<struct ev_loop> with this watcher. You can only
3649	do this when the watcher is inactive (and not pending either).	4252	do this when the watcher is inactive (and not pending either).
3650		4253
3651	=item w->set ([arguments])	4254	=item w->set ([arguments])
3652		4255
3653	Basically the same as C<ev_TYPE_set>, with the same arguments. Either this	4256	Basically the same as C<ev_TYPE_set> (except for C<ev::embed> watchers>),
3654	method or a suitable start method must be called at least once. Unlike the	4257	with the same arguments. Either this method or a suitable start method
3655	C counterpart, an active watcher gets automatically stopped and restarted	4258	must be called at least once. Unlike the C counterpart, an active watcher
3656	when reconfiguring it with this method.	4259	gets automatically stopped and restarted when reconfiguring it with this
		4260	method.
		4261
		4262	For C<ev::embed> watchers this method is called C<set_embed>, to avoid
		4263	clashing with the C<set (loop)> method.
3657		4264
3658	=item w->start ()	4265	=item w->start ()
3659		4266
3660	Starts the watcher. Note that there is no C<loop> argument, as the	4267	Starts the watcher. Note that there is no C<loop> argument, as the
3661	constructor already stores the event loop.	4268	constructor already stores the event loop.
…		…
3691	watchers in the constructor.	4298	watchers in the constructor.
3692		4299
3693	class myclass	4300	class myclass
3694	{	4301	{
3695	ev::io io ; void io_cb (ev::io &w, int revents);	4302	ev::io io ; void io_cb (ev::io &w, int revents);
3696	ev::io2 io2 ; void io2_cb (ev::io &w, int revents);	4303	ev::io io2 ; void io2_cb (ev::io &w, int revents);
3697	ev::idle idle; void idle_cb (ev::idle &w, int revents);	4304	ev::idle idle; void idle_cb (ev::idle &w, int revents);
3698		4305
3699	myclass (int fd)	4306	myclass (int fd)
3700	{	4307	{
3701	io .set <myclass, &myclass::io_cb > (this);	4308	io .set <myclass, &myclass::io_cb > (this);
…		…
3752	L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>.	4359	L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>.
3753		4360
3754	=item D	4361	=item D
3755		4362
3756	Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to	4363	Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to
3757	be found at L<http://proj.llucax.com.ar/wiki/evd>.	4364	be found at L<http://www.llucax.com.ar/proj/ev.d/index.html>.
3758		4365
3759	=item Ocaml	4366	=item Ocaml
3760		4367
3761	Erkki Seppala has written Ocaml bindings for libev, to be found at	4368	Erkki Seppala has written Ocaml bindings for libev, to be found at
3762	L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.	4369	L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.
…		…
3765		4372
3766	Brian Maher has written a partial interface to libev for lua (at the	4373	Brian Maher has written a partial interface to libev for lua (at the
3767	time of this writing, only C<ev_io> and C<ev_timer>), to be found at	4374	time of this writing, only C<ev_io> and C<ev_timer>), to be found at
3768	L<http://github.com/brimworks/lua-ev>.	4375	L<http://github.com/brimworks/lua-ev>.
3769		4376
		4377	=item Javascript
		4378
		4379	Node.js (L<http://nodejs.org>) uses libev as the underlying event library.
		4380
		4381	=item Others
		4382
		4383	There are others, and I stopped counting.
		4384
3770	=back	4385	=back
3771		4386
3772		4387
3773	=head1 MACRO MAGIC	4388	=head1 MACRO MAGIC
3774		4389
…		…
3810	suitable for use with C<EV_A>.	4425	suitable for use with C<EV_A>.
3811		4426
3812	=item C<EV_DEFAULT>, C<EV_DEFAULT_>	4427	=item C<EV_DEFAULT>, C<EV_DEFAULT_>
3813		4428
3814	Similar to the other two macros, this gives you the value of the default	4429	Similar to the other two macros, this gives you the value of the default
3815	loop, if multiple loops are supported ("ev loop default").	4430	loop, if multiple loops are supported ("ev loop default"). The default loop
		4431	will be initialised if it isn't already initialised.
		4432
		4433	For non-multiplicity builds, these macros do nothing, so you always have
		4434	to initialise the loop somewhere.
3816		4435
3817	=item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_>	4436	=item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_>
3818		4437
3819	Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the	4438	Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the
3820	default loop has been initialised (C<UC> == unchecked). Their behaviour	4439	default loop has been initialised (C<UC> == unchecked). Their behaviour
…		…
3887	ev_vars.h	4506	ev_vars.h
3888	ev_wrap.h	4507	ev_wrap.h
3889		4508
3890	ev_win32.c required on win32 platforms only	4509	ev_win32.c required on win32 platforms only
3891		4510
3892	ev_select.c only when select backend is enabled (which is enabled by default)	4511	ev_select.c only when select backend is enabled
3893	ev_poll.c only when poll backend is enabled (disabled by default)	4512	ev_poll.c only when poll backend is enabled
3894	ev_epoll.c only when the epoll backend is enabled (disabled by default)	4513	ev_epoll.c only when the epoll backend is enabled
		4514	ev_linuxaio.c only when the linux aio backend is enabled
		4515	ev_iouring.c only when the linux io_uring backend is enabled
3895	ev_kqueue.c only when the kqueue backend is enabled (disabled by default)	4516	ev_kqueue.c only when the kqueue backend is enabled
3896	ev_port.c only when the solaris port backend is enabled (disabled by default)	4517	ev_port.c only when the solaris port backend is enabled
3897		4518
3898	F<ev.c> includes the backend files directly when enabled, so you only need	4519	F<ev.c> includes the backend files directly when enabled, so you only need
3899	to compile this single file.	4520	to compile this single file.
3900		4521
3901	=head3 LIBEVENT COMPATIBILITY API	4522	=head3 LIBEVENT COMPATIBILITY API
…		…
3965	supported). It will also not define any of the structs usually found in	4586	supported). It will also not define any of the structs usually found in
3966	F<event.h> that are not directly supported by the libev core alone.	4587	F<event.h> that are not directly supported by the libev core alone.
3967		4588
3968	In standalone mode, libev will still try to automatically deduce the	4589	In standalone mode, libev will still try to automatically deduce the
3969	configuration, but has to be more conservative.	4590	configuration, but has to be more conservative.
		4591
		4592	=item EV_USE_FLOOR
		4593
		4594	If defined to be C<1>, libev will use the C<floor ()> function for its
		4595	periodic reschedule calculations, otherwise libev will fall back on a
		4596	portable (slower) implementation. If you enable this, you usually have to
		4597	link against libm or something equivalent. Enabling this when the C<floor>
		4598	function is not available will fail, so the safe default is to not enable
		4599	this.
3970		4600
3971	=item EV_USE_MONOTONIC	4601	=item EV_USE_MONOTONIC
3972		4602
3973	If defined to be C<1>, libev will try to detect the availability of the	4603	If defined to be C<1>, libev will try to detect the availability of the
3974	monotonic clock option at both compile time and runtime. Otherwise no	4604	monotonic clock option at both compile time and runtime. Otherwise no
…		…
4011	available and will probe for kernel support at runtime. This will improve	4641	available and will probe for kernel support at runtime. This will improve
4012	C<ev_signal> and C<ev_async> performance and reduce resource consumption.	4642	C<ev_signal> and C<ev_async> performance and reduce resource consumption.
4013	If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc	4643	If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
4014	2.7 or newer, otherwise disabled.	4644	2.7 or newer, otherwise disabled.
4015		4645
		4646	=item EV_USE_SIGNALFD
		4647
		4648	If defined to be C<1>, then libev will assume that C<signalfd ()> is
		4649	available and will probe for kernel support at runtime. This enables
		4650	the use of EVFLAG_SIGNALFD for faster and simpler signal handling. If
		4651	undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
		4652	2.7 or newer, otherwise disabled.
		4653
		4654	=item EV_USE_TIMERFD
		4655
		4656	If defined to be C<1>, then libev will assume that C<timerfd ()> is
		4657	available and will probe for kernel support at runtime. This allows
		4658	libev to detect time jumps accurately. If undefined, it will be enabled
		4659	if the headers indicate GNU/Linux + Glibc 2.8 or newer and define
		4660	C<TFD_TIMER_CANCEL_ON_SET>, otherwise disabled.
		4661
		4662	=item EV_USE_EVENTFD
		4663
		4664	If defined to be C<1>, then libev will assume that C<eventfd ()> is
		4665	available and will probe for kernel support at runtime. This will improve
		4666	C<ev_signal> and C<ev_async> performance and reduce resource consumption.
		4667	If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
		4668	2.7 or newer, otherwise disabled.
		4669
4016	=item EV_USE_SELECT	4670	=item EV_USE_SELECT
4017		4671
4018	If undefined or defined to be C<1>, libev will compile in support for the	4672	If undefined or defined to be C<1>, libev will compile in support for the
4019	C<select>(2) backend. No attempt at auto-detection will be done: if no	4673	C<select>(2) backend. No attempt at auto-detection will be done: if no
4020	other method takes over, select will be it. Otherwise the select backend	4674	other method takes over, select will be it. Otherwise the select backend
…		…
4060	If programs implement their own fd to handle mapping on win32, then this	4714	If programs implement their own fd to handle mapping on win32, then this
4061	macro can be used to override the C<close> function, useful to unregister	4715	macro can be used to override the C<close> function, useful to unregister
4062	file descriptors again. Note that the replacement function has to close	4716	file descriptors again. Note that the replacement function has to close
4063	the underlying OS handle.	4717	the underlying OS handle.
4064		4718
		4719	=item EV_USE_WSASOCKET
		4720
		4721	If defined to be C<1>, libev will use C<WSASocket> to create its internal
		4722	communication socket, which works better in some environments. Otherwise,
		4723	the normal C<socket> function will be used, which works better in other
		4724	environments.
		4725
4065	=item EV_USE_POLL	4726	=item EV_USE_POLL
4066		4727
4067	If defined to be C<1>, libev will compile in support for the C<poll>(2)	4728	If defined to be C<1>, libev will compile in support for the C<poll>(2)
4068	backend. Otherwise it will be enabled on non-win32 platforms. It	4729	backend. Otherwise it will be enabled on non-win32 platforms. It
4069	takes precedence over select.	4730	takes precedence over select.
…		…
4073	If defined to be C<1>, libev will compile in support for the Linux	4734	If defined to be C<1>, libev will compile in support for the Linux
4074	C<epoll>(7) backend. Its availability will be detected at runtime,	4735	C<epoll>(7) backend. Its availability will be detected at runtime,
4075	otherwise another method will be used as fallback. This is the preferred	4736	otherwise another method will be used as fallback. This is the preferred
4076	backend for GNU/Linux systems. If undefined, it will be enabled if the	4737	backend for GNU/Linux systems. If undefined, it will be enabled if the
4077	headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.	4738	headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
		4739
		4740	=item EV_USE_LINUXAIO
		4741
		4742	If defined to be C<1>, libev will compile in support for the Linux aio
		4743	backend (C<EV_USE_EPOLL> must also be enabled). If undefined, it will be
		4744	enabled on linux, otherwise disabled.
		4745
		4746	=item EV_USE_IOURING
		4747
		4748	If defined to be C<1>, libev will compile in support for the Linux
		4749	io_uring backend (C<EV_USE_EPOLL> must also be enabled). Due to it's
		4750	current limitations it has to be requested explicitly. If undefined, it
		4751	will be enabled on linux, otherwise disabled.
4078		4752
4079	=item EV_USE_KQUEUE	4753	=item EV_USE_KQUEUE
4080		4754
4081	If defined to be C<1>, libev will compile in support for the BSD style	4755	If defined to be C<1>, libev will compile in support for the BSD style
4082	C<kqueue>(2) backend. Its actual availability will be detected at runtime,	4756	C<kqueue>(2) backend. Its actual availability will be detected at runtime,
…		…
4104	If defined to be C<1>, libev will compile in support for the Linux inotify	4778	If defined to be C<1>, libev will compile in support for the Linux inotify
4105	interface to speed up C<ev_stat> watchers. Its actual availability will	4779	interface to speed up C<ev_stat> watchers. Its actual availability will
4106	be detected at runtime. If undefined, it will be enabled if the headers	4780	be detected at runtime. If undefined, it will be enabled if the headers
4107	indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.	4781	indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
4108		4782
		4783	=item EV_NO_SMP
		4784
		4785	If defined to be C<1>, libev will assume that memory is always coherent
		4786	between threads, that is, threads can be used, but threads never run on
		4787	different cpus (or different cpu cores). This reduces dependencies
		4788	and makes libev faster.
		4789
		4790	=item EV_NO_THREADS
		4791
		4792	If defined to be C<1>, libev will assume that it will never be called from
		4793	different threads (that includes signal handlers), which is a stronger
		4794	assumption than C<EV_NO_SMP>, above. This reduces dependencies and makes
		4795	libev faster.
		4796
4109	=item EV_ATOMIC_T	4797	=item EV_ATOMIC_T
4110		4798
4111	Libev requires an integer type (suitable for storing C<0> or C<1>) whose	4799	Libev requires an integer type (suitable for storing C<0> or C<1>) whose
4112	access is atomic with respect to other threads or signal contexts. No such	4800	access is atomic with respect to other threads or signal contexts. No
4113	type is easily found in the C language, so you can provide your own type	4801	such type is easily found in the C language, so you can provide your own
4114	that you know is safe for your purposes. It is used both for signal handler "locking"	4802	type that you know is safe for your purposes. It is used both for signal
4115	as well as for signal and thread safety in C<ev_async> watchers.	4803	handler "locking" as well as for signal and thread safety in C<ev_async>
		4804	watchers.
4116		4805
4117	In the absence of this define, libev will use C<sig_atomic_t volatile>	4806	In the absence of this define, libev will use C<sig_atomic_t volatile>
4118	(from F<signal.h>), which is usually good enough on most platforms.	4807	(from F<signal.h>), which is usually good enough on most platforms.
4119		4808
4120	=item EV_H (h)	4809	=item EV_H (h)
…		…
4147	will have the C<struct ev_loop *> as first argument, and you can create	4836	will have the C<struct ev_loop *> as first argument, and you can create
4148	additional independent event loops. Otherwise there will be no support	4837	additional independent event loops. Otherwise there will be no support
4149	for multiple event loops and there is no first event loop pointer	4838	for multiple event loops and there is no first event loop pointer
4150	argument. Instead, all functions act on the single default loop.	4839	argument. Instead, all functions act on the single default loop.
4151		4840
		4841	Note that C<EV_DEFAULT> and C<EV_DEFAULT_> will no longer provide a
		4842	default loop when multiplicity is switched off - you always have to
		4843	initialise the loop manually in this case.
		4844
4152	=item EV_MINPRI	4845	=item EV_MINPRI
4153		4846
4154	=item EV_MAXPRI	4847	=item EV_MAXPRI
4155		4848
4156	The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to	4849	The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to
…		…
4192	#define EV_USE_POLL 1	4885	#define EV_USE_POLL 1
4193	#define EV_CHILD_ENABLE 1	4886	#define EV_CHILD_ENABLE 1
4194	#define EV_ASYNC_ENABLE 1	4887	#define EV_ASYNC_ENABLE 1
4195		4888
4196	The actual value is a bitset, it can be a combination of the following	4889	The actual value is a bitset, it can be a combination of the following
4197	values:	4890	values (by default, all of these are enabled):
4198		4891
4199	=over 4	4892	=over 4
4200		4893
4201	=item C<1> - faster/larger code	4894	=item C<1> - faster/larger code
4202		4895
…		…
4206	code size by roughly 30% on amd64).	4899	code size by roughly 30% on amd64).
4207		4900
4208	When optimising for size, use of compiler flags such as C<-Os> with	4901	When optimising for size, use of compiler flags such as C<-Os> with
4209	gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of	4902	gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of
4210	assertions.	4903	assertions.
		4904
		4905	The default is off when C<__OPTIMIZE_SIZE__> is defined by your compiler
		4906	(e.g. gcc with C<-Os>).
4211		4907
4212	=item C<2> - faster/larger data structures	4908	=item C<2> - faster/larger data structures
4213		4909
4214	Replaces the small 2-heap for timer management by a faster 4-heap, larger	4910	Replaces the small 2-heap for timer management by a faster 4-heap, larger
4215	hash table sizes and so on. This will usually further increase code size	4911	hash table sizes and so on. This will usually further increase code size
4216	and can additionally have an effect on the size of data structures at	4912	and can additionally have an effect on the size of data structures at
4217	runtime.	4913	runtime.
4218		4914
		4915	The default is off when C<__OPTIMIZE_SIZE__> is defined by your compiler
		4916	(e.g. gcc with C<-Os>).
		4917
4219	=item C<4> - full API configuration	4918	=item C<4> - full API configuration
4220		4919
4221	This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and	4920	This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and
4222	enables multiplicity (C<EV_MULTIPLICITY>=1).	4921	enables multiplicity (C<EV_MULTIPLICITY>=1).
4223		4922
…		…
4253		4952
4254	With an intelligent-enough linker (gcc+binutils are intelligent enough	4953	With an intelligent-enough linker (gcc+binutils are intelligent enough
4255	when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by	4954	when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by
4256	your program might be left out as well - a binary starting a timer and an	4955	your program might be left out as well - a binary starting a timer and an
4257	I/O watcher then might come out at only 5Kb.	4956	I/O watcher then might come out at only 5Kb.
		4957
		4958	=item EV_API_STATIC
		4959
		4960	If this symbol is defined (by default it is not), then all identifiers
		4961	will have static linkage. This means that libev will not export any
		4962	identifiers, and you cannot link against libev anymore. This can be useful
		4963	when you embed libev, only want to use libev functions in a single file,
		4964	and do not want its identifiers to be visible.
		4965
		4966	To use this, define C<EV_API_STATIC> and include F<ev.c> in the file that
		4967	wants to use libev.
		4968
		4969	This option only works when libev is compiled with a C compiler, as C++
		4970	doesn't support the required declaration syntax.
4258		4971
4259	=item EV_AVOID_STDIO	4972	=item EV_AVOID_STDIO
4260		4973
4261	If this is set to C<1> at compiletime, then libev will avoid using stdio	4974	If this is set to C<1> at compiletime, then libev will avoid using stdio
4262	functions (printf, scanf, perror etc.). This will increase the code size	4975	functions (printf, scanf, perror etc.). This will increase the code size
…		…
4320	in. If set to C<1>, then verification code will be compiled in, but not	5033	in. If set to C<1>, then verification code will be compiled in, but not
4321	called. If set to C<2>, then the internal verification code will be	5034	called. If set to C<2>, then the internal verification code will be
4322	called once per loop, which can slow down libev. If set to C<3>, then the	5035	called once per loop, which can slow down libev. If set to C<3>, then the
4323	verification code will be called very frequently, which will slow down	5036	verification code will be called very frequently, which will slow down
4324	libev considerably.	5037	libev considerably.
		5038
		5039	Verification errors are reported via C's C<assert> mechanism, so if you
		5040	disable that (e.g. by defining C<NDEBUG>) then no errors will be reported.
4325		5041
4326	The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it	5042	The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
4327	will be C<0>.	5043	will be C<0>.
4328		5044
4329	=item EV_COMMON	5045	=item EV_COMMON
…		…
4406	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:	5122	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
4407		5123
4408	#include "ev_cpp.h"	5124	#include "ev_cpp.h"
4409	#include "ev.c"	5125	#include "ev.c"
4410		5126
4411	=head1 INTERACTION WITH OTHER PROGRAMS OR LIBRARIES	5127	=head1 INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT
4412		5128
4413	=head2 THREADS AND COROUTINES	5129	=head2 THREADS AND COROUTINES
4414		5130
4415	=head3 THREADS	5131	=head3 THREADS
4416		5132
…		…
4467	default loop and triggering an C<ev_async> watcher from the default loop	5183	default loop and triggering an C<ev_async> watcher from the default loop
4468	watcher callback into the event loop interested in the signal.	5184	watcher callback into the event loop interested in the signal.
4469		5185
4470	=back	5186	=back
4471		5187
4472	=head4 THREAD LOCKING EXAMPLE	5188	See also L</THREAD LOCKING EXAMPLE>.
4473
4474	Here is a fictitious example of how to run an event loop in a different
4475	thread than where callbacks are being invoked and watchers are
4476	created/added/removed.
4477
4478	For a real-world example, see the C<EV::Loop::Async> perl module,
4479	which uses exactly this technique (which is suited for many high-level
4480	languages).
4481
4482	The example uses a pthread mutex to protect the loop data, a condition
4483	variable to wait for callback invocations, an async watcher to notify the
4484	event loop thread and an unspecified mechanism to wake up the main thread.
4485
4486	First, you need to associate some data with the event loop:
4487
4488	typedef struct {
4489	mutex_t lock; /* global loop lock */
4490	ev_async async_w;
4491	thread_t tid;
4492	cond_t invoke_cv;
4493	} userdata;
4494
4495	void prepare_loop (EV_P)
4496	{
4497	// for simplicity, we use a static userdata struct.
4498	static userdata u;
4499
4500	ev_async_init (&u->async_w, async_cb);
4501	ev_async_start (EV_A_ &u->async_w);
4502
4503	pthread_mutex_init (&u->lock, 0);
4504	pthread_cond_init (&u->invoke_cv, 0);
4505
4506	// now associate this with the loop
4507	ev_set_userdata (EV_A_ u);
4508	ev_set_invoke_pending_cb (EV_A_ l_invoke);
4509	ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
4510
4511	// then create the thread running ev_loop
4512	pthread_create (&u->tid, 0, l_run, EV_A);
4513	}
4514
4515	The callback for the C<ev_async> watcher does nothing: the watcher is used
4516	solely to wake up the event loop so it takes notice of any new watchers
4517	that might have been added:
4518
4519	static void
4520	async_cb (EV_P_ ev_async *w, int revents)
4521	{
4522	// just used for the side effects
4523	}
4524
4525	The C<l_release> and C<l_acquire> callbacks simply unlock/lock the mutex
4526	protecting the loop data, respectively.
4527
4528	static void
4529	l_release (EV_P)
4530	{
4531	userdata *u = ev_userdata (EV_A);
4532	pthread_mutex_unlock (&u->lock);
4533	}
4534
4535	static void
4536	l_acquire (EV_P)
4537	{
4538	userdata *u = ev_userdata (EV_A);
4539	pthread_mutex_lock (&u->lock);
4540	}
4541
4542	The event loop thread first acquires the mutex, and then jumps straight
4543	into C<ev_run>:
4544
4545	void *
4546	l_run (void *thr_arg)
4547	{
4548	struct ev_loop *loop = (struct ev_loop *)thr_arg;
4549
4550	l_acquire (EV_A);
4551	pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
4552	ev_run (EV_A_ 0);
4553	l_release (EV_A);
4554
4555	return 0;
4556	}
4557
4558	Instead of invoking all pending watchers, the C<l_invoke> callback will
4559	signal the main thread via some unspecified mechanism (signals? pipe
4560	writes? C<Async::Interrupt>?) and then waits until all pending watchers
4561	have been called (in a while loop because a) spurious wakeups are possible
4562	and b) skipping inter-thread-communication when there are no pending
4563	watchers is very beneficial):
4564
4565	static void
4566	l_invoke (EV_P)
4567	{
4568	userdata *u = ev_userdata (EV_A);
4569
4570	while (ev_pending_count (EV_A))
4571	{
4572	wake_up_other_thread_in_some_magic_or_not_so_magic_way ();
4573	pthread_cond_wait (&u->invoke_cv, &u->lock);
4574	}
4575	}
4576
4577	Now, whenever the main thread gets told to invoke pending watchers, it
4578	will grab the lock, call C<ev_invoke_pending> and then signal the loop
4579	thread to continue:
4580
4581	static void
4582	real_invoke_pending (EV_P)
4583	{
4584	userdata *u = ev_userdata (EV_A);
4585
4586	pthread_mutex_lock (&u->lock);
4587	ev_invoke_pending (EV_A);
4588	pthread_cond_signal (&u->invoke_cv);
4589	pthread_mutex_unlock (&u->lock);
4590	}
4591
4592	Whenever you want to start/stop a watcher or do other modifications to an
4593	event loop, you will now have to lock:
4594
4595	ev_timer timeout_watcher;
4596	userdata *u = ev_userdata (EV_A);
4597
4598	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
4599
4600	pthread_mutex_lock (&u->lock);
4601	ev_timer_start (EV_A_ &timeout_watcher);
4602	ev_async_send (EV_A_ &u->async_w);
4603	pthread_mutex_unlock (&u->lock);
4604
4605	Note that sending the C<ev_async> watcher is required because otherwise
4606	an event loop currently blocking in the kernel will have no knowledge
4607	about the newly added timer. By waking up the loop it will pick up any new
4608	watchers in the next event loop iteration.
4609		5189
4610	=head3 COROUTINES	5190	=head3 COROUTINES
4611		5191
4612	Libev is very accommodating to coroutines ("cooperative threads"):	5192	Libev is very accommodating to coroutines ("cooperative threads"):
4613	libev fully supports nesting calls to its functions from different	5193	libev fully supports nesting calls to its functions from different
…		…
4778	requires, and its I/O model is fundamentally incompatible with the POSIX	5358	requires, and its I/O model is fundamentally incompatible with the POSIX
4779	model. Libev still offers limited functionality on this platform in	5359	model. Libev still offers limited functionality on this platform in
4780	the form of the C<EVBACKEND_SELECT> backend, and only supports socket	5360	the form of the C<EVBACKEND_SELECT> backend, and only supports socket
4781	descriptors. This only applies when using Win32 natively, not when using	5361	descriptors. This only applies when using Win32 natively, not when using
4782	e.g. cygwin. Actually, it only applies to the microsofts own compilers,	5362	e.g. cygwin. Actually, it only applies to the microsofts own compilers,
4783	as every compielr comes with a slightly differently broken/incompatible	5363	as every compiler comes with a slightly differently broken/incompatible
4784	environment.	5364	environment.
4785		5365
4786	Lifting these limitations would basically require the full	5366	Lifting these limitations would basically require the full
4787	re-implementation of the I/O system. If you are into this kind of thing,	5367	re-implementation of the I/O system. If you are into this kind of thing,
4788	then note that glib does exactly that for you in a very portable way (note	5368	then note that glib does exactly that for you in a very portable way (note
…		…
4882	structure (guaranteed by POSIX but not by ISO C for example), but it also	5462	structure (guaranteed by POSIX but not by ISO C for example), but it also
4883	assumes that the same (machine) code can be used to call any watcher	5463	assumes that the same (machine) code can be used to call any watcher
4884	callback: The watcher callbacks have different type signatures, but libev	5464	callback: The watcher callbacks have different type signatures, but libev
4885	calls them using an C<ev_watcher *> internally.	5465	calls them using an C<ev_watcher *> internally.
4886		5466
		5467	=item null pointers and integer zero are represented by 0 bytes
		5468
		5469	Libev uses C<memset> to initialise structs and arrays to C<0> bytes, and
		5470	relies on this setting pointers and integers to null.
		5471
4887	=item pointer accesses must be thread-atomic	5472	=item pointer accesses must be thread-atomic
4888		5473
4889	Accessing a pointer value must be atomic, it must both be readable and	5474	Accessing a pointer value must be atomic, it must both be readable and
4890	writable in one piece - this is the case on all current architectures.	5475	writable in one piece - this is the case on all current architectures.
4891		5476
…		…
4904	thread" or will block signals process-wide, both behaviours would	5489	thread" or will block signals process-wide, both behaviours would
4905	be compatible with libev. Interaction between C<sigprocmask> and	5490	be compatible with libev. Interaction between C<sigprocmask> and
4906	C<pthread_sigmask> could complicate things, however.	5491	C<pthread_sigmask> could complicate things, however.
4907		5492
4908	The most portable way to handle signals is to block signals in all threads	5493	The most portable way to handle signals is to block signals in all threads
4909	except the initial one, and run the default loop in the initial thread as	5494	except the initial one, and run the signal handling loop in the initial
4910	well.	5495	thread as well.
4911		5496
4912	=item C<long> must be large enough for common memory allocation sizes	5497	=item C<long> must be large enough for common memory allocation sizes
4913		5498
4914	To improve portability and simplify its API, libev uses C<long> internally	5499	To improve portability and simplify its API, libev uses C<long> internally
4915	instead of C<size_t> when allocating its data structures. On non-POSIX	5500	instead of C<size_t> when allocating its data structures. On non-POSIX
…		…
4921		5506
4922	The type C<double> is used to represent timestamps. It is required to	5507	The type C<double> is used to represent timestamps. It is required to
4923	have at least 51 bits of mantissa (and 9 bits of exponent), which is	5508	have at least 51 bits of mantissa (and 9 bits of exponent), which is
4924	good enough for at least into the year 4000 with millisecond accuracy	5509	good enough for at least into the year 4000 with millisecond accuracy
4925	(the design goal for libev). This requirement is overfulfilled by	5510	(the design goal for libev). This requirement is overfulfilled by
4926	implementations using IEEE 754, which is basically all existing ones. With	5511	implementations using IEEE 754, which is basically all existing ones.
		5512
4927	IEEE 754 doubles, you get microsecond accuracy until at least 2200.	5513	With IEEE 754 doubles, you get microsecond accuracy until at least the
		5514	year 2255 (and millisecond accuracy till the year 287396 - by then, libev
		5515	is either obsolete or somebody patched it to use C<long double> or
		5516	something like that, just kidding).
4928		5517
4929	=back	5518	=back
4930		5519
4931	If you know of other additional requirements drop me a note.	5520	If you know of other additional requirements drop me a note.
4932		5521
…		…
4994	=item Processing ev_async_send: O(number_of_async_watchers)	5583	=item Processing ev_async_send: O(number_of_async_watchers)
4995		5584
4996	=item Processing signals: O(max_signal_number)	5585	=item Processing signals: O(max_signal_number)
4997		5586
4998	Sending involves a system call I<iff> there were no other C<ev_async_send>	5587	Sending involves a system call I<iff> there were no other C<ev_async_send>
4999	calls in the current loop iteration. Checking for async and signal events	5588	calls in the current loop iteration and the loop is currently
		5589	blocked. Checking for async and signal events involves iterating over all
5000	involves iterating over all running async watchers or all signal numbers.	5590	running async watchers or all signal numbers.
5001		5591
5002	=back	5592	=back
5003		5593
5004		5594
5005	=head1 PORTING FROM LIBEV 3.X TO 4.X	5595	=head1 PORTING FROM LIBEV 3.X TO 4.X
…		…
5014	=over 4	5604	=over 4
5015		5605
5016	=item C<EV_COMPAT3> backwards compatibility mechanism	5606	=item C<EV_COMPAT3> backwards compatibility mechanism
5017		5607
5018	The backward compatibility mechanism can be controlled by	5608	The backward compatibility mechanism can be controlled by
5019	C<EV_COMPAT3>. See L<PREPROCESSOR SYMBOLS/MACROS> in the L<EMBEDDING>	5609	C<EV_COMPAT3>. See L</"PREPROCESSOR SYMBOLS/MACROS"> in the L</EMBEDDING>
5020	section.	5610	section.
5021		5611
5022	=item C<ev_default_destroy> and C<ev_default_fork> have been removed	5612	=item C<ev_default_destroy> and C<ev_default_fork> have been removed
5023		5613
5024	These calls can be replaced easily by their C<ev_loop_xxx> counterparts:	5614	These calls can be replaced easily by their C<ev_loop_xxx> counterparts:
…		…
5067	=over 4	5657	=over 4
5068		5658
5069	=item active	5659	=item active
5070		5660
5071	A watcher is active as long as it has been started and not yet stopped.	5661	A watcher is active as long as it has been started and not yet stopped.
5072	See L<WATCHER STATES> for details.	5662	See L</WATCHER STATES> for details.
5073		5663
5074	=item application	5664	=item application
5075		5665
5076	In this document, an application is whatever is using libev.	5666	In this document, an application is whatever is using libev.
5077		5667
…		…
5113	watchers and events.	5703	watchers and events.
5114		5704
5115	=item pending	5705	=item pending
5116		5706
5117	A watcher is pending as soon as the corresponding event has been	5707	A watcher is pending as soon as the corresponding event has been
5118	detected. See L<WATCHER STATES> for details.	5708	detected. See L</WATCHER STATES> for details.
5119		5709
5120	=item real time	5710	=item real time
5121		5711
5122	The physical time that is observed. It is apparently strictly monotonic :)	5712	The physical time that is observed. It is apparently strictly monotonic :)
5123		5713
5124	=item wall-clock time	5714	=item wall-clock time
5125		5715
5126	The time and date as shown on clocks. Unlike real time, it can actually	5716	The time and date as shown on clocks. Unlike real time, it can actually
5127	be wrong and jump forwards and backwards, e.g. when the you adjust your	5717	be wrong and jump forwards and backwards, e.g. when you adjust your
5128	clock.	5718	clock.
5129		5719
5130	=item watcher	5720	=item watcher
5131		5721
5132	A data structure that describes interest in certain events. Watchers need	5722	A data structure that describes interest in certain events. Watchers need
…		…
5135	=back	5725	=back
5136		5726
5137	=head1 AUTHOR	5727	=head1 AUTHOR
5138		5728
5139	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael	5729	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael
5140	Magnusson and Emanuele Giaquinta.	5730	Magnusson and Emanuele Giaquinta, and minor corrections by many others.
5141		5731

Diff Legend

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