ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.246 by root, Thu Jul 2 12:08:55 2009 UTC vs.
Revision 1.384 by sf-exg, Sun Oct 16 11:02:57 2011 UTC

…		…
26	puts ("stdin ready");	26	puts ("stdin ready");
27	// for one-shot events, one must manually stop the watcher	27	// for one-shot events, one must manually stop the watcher
28	// with its corresponding stop function.	28	// with its corresponding stop function.
29	ev_io_stop (EV_A_ w);	29	ev_io_stop (EV_A_ w);
30		30
31	// this causes all nested ev_loop's to stop iterating	31	// this causes all nested ev_run's to stop iterating
32	ev_unloop (EV_A_ EVUNLOOP_ALL);	32	ev_break (EV_A_ EVBREAK_ALL);
33	}	33	}
34		34
35	// another callback, this time for a time-out	35	// another callback, this time for a time-out
36	static void	36	static void
37	timeout_cb (EV_P_ ev_timer *w, int revents)	37	timeout_cb (EV_P_ ev_timer *w, int revents)
38	{	38	{
39	puts ("timeout");	39	puts ("timeout");
40	// this causes the innermost ev_loop to stop iterating	40	// this causes the innermost ev_run to stop iterating
41	ev_unloop (EV_A_ EVUNLOOP_ONE);	41	ev_break (EV_A_ EVBREAK_ONE);
42	}	42	}
43		43
44	int	44	int
45	main (void)	45	main (void)
46	{	46	{
47	// use the default event loop unless you have special needs	47	// use the default event loop unless you have special needs
48	struct ev_loop *loop = ev_default_loop (0);	48	struct ev_loop *loop = EV_DEFAULT;
49		49
50	// initialise an io watcher, then start it	50	// initialise an io watcher, then start it
51	// this one will watch for stdin to become readable	51	// this one will watch for stdin to become readable
52	ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);	52	ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);
53	ev_io_start (loop, &stdin_watcher);	53	ev_io_start (loop, &stdin_watcher);
…		…
56	// simple non-repeating 5.5 second timeout	56	// simple non-repeating 5.5 second timeout
57	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);	57	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
58	ev_timer_start (loop, &timeout_watcher);	58	ev_timer_start (loop, &timeout_watcher);
59		59
60	// now wait for events to arrive	60	// now wait for events to arrive
61	ev_loop (loop, 0);	61	ev_run (loop, 0);
62		62
63	// unloop was called, so exit	63	// break was called, so exit
64	return 0;	64	return 0;
65	}	65	}
66		66
67	=head1 ABOUT THIS DOCUMENT	67	=head1 ABOUT THIS DOCUMENT
68		68
…		…
75	While this document tries to be as complete as possible in documenting	75	While this document tries to be as complete as possible in documenting
76	libev, its usage and the rationale behind its design, it is not a tutorial	76	libev, its usage and the rationale behind its design, it is not a tutorial
77	on event-based programming, nor will it introduce event-based programming	77	on event-based programming, nor will it introduce event-based programming
78	with libev.	78	with libev.
79		79
80	Familarity with event based programming techniques in general is assumed	80	Familiarity with event based programming techniques in general is assumed
81	throughout this document.	81	throughout this document.
		82
		83	=head1 WHAT TO READ WHEN IN A HURRY
		84
		85	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
		87	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
		89	C<ev_timer> sections in L<WATCHER TYPES>.
82		90
83	=head1 ABOUT LIBEV	91	=head1 ABOUT LIBEV
84		92
85	Libev is an event loop: you register interest in certain events (such as a	93	Libev is an event loop: you register interest in certain events (such as a
86	file descriptor being readable or a timeout occurring), and it will manage	94	file descriptor being readable or a timeout occurring), and it will manage
…		…
98	=head2 FEATURES	106	=head2 FEATURES
99		107
100	Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the	108	Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the
101	BSD-specific C<kqueue> and the Solaris-specific event port mechanisms	109	BSD-specific C<kqueue> and the Solaris-specific event port mechanisms
102	for file descriptor events (C<ev_io>), the Linux C<inotify> interface	110	for file descriptor events (C<ev_io>), the Linux C<inotify> interface
103	(for C<ev_stat>), relative timers (C<ev_timer>), absolute timers	111	(for C<ev_stat>), Linux eventfd/signalfd (for faster and cleaner
104	with customised rescheduling (C<ev_periodic>), synchronous signals	112	inter-thread wakeup (C<ev_async>)/signal handling (C<ev_signal>)) relative
105	(C<ev_signal>), process status change events (C<ev_child>), and event	113	timers (C<ev_timer>), absolute timers with customised rescheduling
106	watchers dealing with the event loop mechanism itself (C<ev_idle>,	114	(C<ev_periodic>), synchronous signals (C<ev_signal>), process status
107	C<ev_embed>, C<ev_prepare> and C<ev_check> watchers) as well as	115	change events (C<ev_child>), and event watchers dealing with the event
108	file watchers (C<ev_stat>) and even limited support for fork events	116	loop mechanism itself (C<ev_idle>, C<ev_embed>, C<ev_prepare> and
109	(C<ev_fork>).	117	C<ev_check> watchers) as well as file watchers (C<ev_stat>) and even
		118	limited support for fork events (C<ev_fork>).
110		119
111	It also is quite fast (see this	120	It also is quite fast (see this
112	L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent	121	L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent
113	for example).	122	for example).
114		123
…		…
117	Libev is very configurable. In this manual the default (and most common)	126	Libev is very configurable. In this manual the default (and most common)
118	configuration will be described, which supports multiple event loops. For	127	configuration will be described, which supports multiple event loops. For
119	more info about various configuration options please have a look at	128	more info about various configuration options please have a look at
120	B<EMBED> section in this manual. If libev was configured without support	129	B<EMBED> section in this manual. If libev was configured without support
121	for multiple event loops, then all functions taking an initial argument of	130	for multiple event loops, then all functions taking an initial argument of
122	name C<loop> (which is always of type C<ev_loop *>) will not have	131	name C<loop> (which is always of type C<struct ev_loop *>) will not have
123	this argument.	132	this argument.
124		133
125	=head2 TIME REPRESENTATION	134	=head2 TIME REPRESENTATION
126		135
127	Libev represents time as a single floating point number, representing	136	Libev represents time as a single floating point number, representing
128	the (fractional) number of seconds since the (POSIX) epoch (somewhere	137	the (fractional) number of seconds since the (POSIX) epoch (in practice
129	near the beginning of 1970, details are complicated, don't ask). This	138	somewhere near the beginning of 1970, details are complicated, don't
130	type is called C<ev_tstamp>, which is what you should use too. It usually	139	ask). This type is called C<ev_tstamp>, which is what you should use
131	aliases to the C<double> type in C. When you need to do any calculations	140	too. It usually aliases to the C<double> type in C. When you need to do
132	on it, you should treat it as some floating point value. Unlike the name	141	any calculations on it, you should treat it as some floating point value.
		142
133	component C<stamp> might indicate, it is also used for time differences	143	Unlike the name component C<stamp> might indicate, it is also used for
134	throughout libev.	144	time differences (e.g. delays) throughout libev.
135		145
136	=head1 ERROR HANDLING	146	=head1 ERROR HANDLING
137		147
138	Libev knows three classes of errors: operating system errors, usage errors	148	Libev knows three classes of errors: operating system errors, usage errors
139	and internal errors (bugs).	149	and internal errors (bugs).
…		…
163		173
164	=item ev_tstamp ev_time ()	174	=item ev_tstamp ev_time ()
165		175
166	Returns the current time as libev would use it. Please note that the	176	Returns the current time as libev would use it. Please note that the
167	C<ev_now> function is usually faster and also often returns the timestamp	177	C<ev_now> function is usually faster and also often returns the timestamp
168	you actually want to know.	178	you actually want to know. Also interesting is the combination of
		179	C<ev_now_update> and C<ev_now>.
169		180
170	=item ev_sleep (ev_tstamp interval)	181	=item ev_sleep (ev_tstamp interval)
171		182
172	Sleep for the given interval: The current thread will be blocked until	183	Sleep for the given interval: The current thread will be blocked
173	either it is interrupted or the given time interval has passed. Basically	184	until either it is interrupted or the given time interval has
		185	passed (approximately - it might return a bit earlier even if not
		186	interrupted). Returns immediately if C<< interval <= 0 >>.
		187
174	this is a sub-second-resolution C<sleep ()>.	188	Basically this is a sub-second-resolution C<sleep ()>.
		189
		190	The range of the C<interval> is limited - libev only guarantees to work
		191	with sleep times of up to one day (C<< interval <= 86400 >>).
175		192
176	=item int ev_version_major ()	193	=item int ev_version_major ()
177		194
178	=item int ev_version_minor ()	195	=item int ev_version_minor ()
179		196
…		…
190	as this indicates an incompatible change. Minor versions are usually	207	as this indicates an incompatible change. Minor versions are usually
191	compatible to older versions, so a larger minor version alone is usually	208	compatible to older versions, so a larger minor version alone is usually
192	not a problem.	209	not a problem.
193		210
194	Example: Make sure we haven't accidentally been linked against the wrong	211	Example: Make sure we haven't accidentally been linked against the wrong
195	version.	212	version (note, however, that this will not detect other ABI mismatches,
		213	such as LFS or reentrancy).
196		214
197	assert (("libev version mismatch",	215	assert (("libev version mismatch",
198	ev_version_major () == EV_VERSION_MAJOR	216	ev_version_major () == EV_VERSION_MAJOR
199	&& ev_version_minor () >= EV_VERSION_MINOR));	217	&& ev_version_minor () >= EV_VERSION_MINOR));
200		218
…		…
211	assert (("sorry, no epoll, no sex",	229	assert (("sorry, no epoll, no sex",
212	ev_supported_backends () & EVBACKEND_EPOLL));	230	ev_supported_backends () & EVBACKEND_EPOLL));
213		231
214	=item unsigned int ev_recommended_backends ()	232	=item unsigned int ev_recommended_backends ()
215		233
216	Return the set of all backends compiled into this binary of libev and also	234	Return the set of all backends compiled into this binary of libev and
217	recommended for this platform. This set is often smaller than the one	235	also recommended for this platform, meaning it will work for most file
		236	descriptor types. This set is often smaller than the one returned by
218	returned by C<ev_supported_backends>, as for example kqueue is broken on	237	C<ev_supported_backends>, as for example kqueue is broken on most BSDs
219	most BSDs and will not be auto-detected unless you explicitly request it	238	and will not be auto-detected unless you explicitly request it (assuming
220	(assuming you know what you are doing). This is the set of backends that	239	you know what you are doing). This is the set of backends that libev will
221	libev will probe for if you specify no backends explicitly.	240	probe for if you specify no backends explicitly.
222		241
223	=item unsigned int ev_embeddable_backends ()	242	=item unsigned int ev_embeddable_backends ()
224		243
225	Returns the set of backends that are embeddable in other event loops. This	244	Returns the set of backends that are embeddable in other event loops. This
226	is the theoretical, all-platform, value. To find which backends	245	value is platform-specific but can include backends not available on the
227	might be supported on the current system, you would need to look at	246	current system. To find which embeddable backends might be supported on
228	C<ev_embeddable_backends () & ev_supported_backends ()>, likewise for	247	the current system, you would need to look at C<ev_embeddable_backends ()
229	recommended ones.	248	& ev_supported_backends ()>, likewise for recommended ones.
230		249
231	See the description of C<ev_embed> watchers for more info.	250	See the description of C<ev_embed> watchers for more info.
232		251
233	=item ev_set_allocator (void *(*cb)(void *ptr, long size)) [NOT REENTRANT]	252	=item ev_set_allocator (void *(*cb)(void *ptr, long size))
234		253
235	Sets the allocation function to use (the prototype is similar - the	254	Sets the allocation function to use (the prototype is similar - the
236	semantics are identical to the C<realloc> C89/SuS/POSIX function). It is	255	semantics are identical to the C<realloc> C89/SuS/POSIX function). It is
237	used to allocate and free memory (no surprises here). If it returns zero	256	used to allocate and free memory (no surprises here). If it returns zero
238	when memory needs to be allocated (C<size != 0>), the library might abort	257	when memory needs to be allocated (C<size != 0>), the library might abort
…		…
264	}	283	}
265		284
266	...	285	...
267	ev_set_allocator (persistent_realloc);	286	ev_set_allocator (persistent_realloc);
268		287
269	=item ev_set_syserr_cb (void (*cb)(const char *msg)); [NOT REENTRANT]	288	=item ev_set_syserr_cb (void (*cb)(const char *msg))
270		289
271	Set the callback function to call on a retryable system call error (such	290	Set the callback function to call on a retryable system call error (such
272	as failed select, poll, epoll_wait). The message is a printable string	291	as failed select, poll, epoll_wait). The message is a printable string
273	indicating the system call or subsystem causing the problem. If this	292	indicating the system call or subsystem causing the problem. If this
274	callback is set, then libev will expect it to remedy the situation, no	293	callback is set, then libev will expect it to remedy the situation, no
…		…
286	}	305	}
287		306
288	...	307	...
289	ev_set_syserr_cb (fatal_error);	308	ev_set_syserr_cb (fatal_error);
290		309
		310	=item ev_feed_signal (int signum)
		311
		312	This function can be used to "simulate" a signal receive. It is completely
		313	safe to call this function at any time, from any context, including signal
		314	handlers or random threads.
		315
		316	Its main use is to customise signal handling in your process, especially
		317	in the presence of threads. For example, you could block signals
		318	by default in all threads (and specifying C<EVFLAG_NOSIGMASK> when
		319	creating any loops), and in one thread, use C<sigwait> or any other
		320	mechanism to wait for signals, then "deliver" them to libev by calling
		321	C<ev_feed_signal>.
		322
291	=back	323	=back
292		324
293	=head1 FUNCTIONS CONTROLLING THE EVENT LOOP	325	=head1 FUNCTIONS CONTROLLING EVENT LOOPS
294		326
295	An event loop is described by a C<struct ev_loop *> (the C<struct>	327	An event loop is described by a C<struct ev_loop *> (the C<struct> is
296	is I<not> optional in this case, as there is also an C<ev_loop>	328	I<not> optional in this case unless libev 3 compatibility is disabled, as
297	I<function>).	329	libev 3 had an C<ev_loop> function colliding with the struct name).
298		330
299	The library knows two types of such loops, the I<default> loop, which	331	The library knows two types of such loops, the I<default> loop, which
300	supports signals and child events, and dynamically created loops which do	332	supports child process events, and dynamically created event loops which
301	not.	333	do not.
302		334
303	=over 4	335	=over 4
304		336
305	=item struct ev_loop *ev_default_loop (unsigned int flags)	337	=item struct ev_loop *ev_default_loop (unsigned int flags)
306		338
307	This will initialise the default event loop if it hasn't been initialised	339	This returns the "default" event loop object, which is what you should
308	yet and return it. If the default loop could not be initialised, returns	340	normally use when you just need "the event loop". Event loop objects and
309	false. If it already was initialised it simply returns it (and ignores the	341	the C<flags> parameter are described in more detail in the entry for
310	flags. If that is troubling you, check C<ev_backend ()> afterwards).	342	C<ev_loop_new>.
		343
		344	If the default loop is already initialised then this function simply
		345	returns it (and ignores the flags. If that is troubling you, check
		346	C<ev_backend ()> afterwards). Otherwise it will create it with the given
		347	flags, which should almost always be C<0>, unless the caller is also the
		348	one calling C<ev_run> or otherwise qualifies as "the main program".
311		349
312	If you don't know what event loop to use, use the one returned from this	350	If you don't know what event loop to use, use the one returned from this
313	function.	351	function (or via the C<EV_DEFAULT> macro).
314		352
315	Note that this function is I<not> thread-safe, so if you want to use it	353	Note that this function is I<not> thread-safe, so if you want to use it
316	from multiple threads, you have to lock (note also that this is unlikely,	354	from multiple threads, you have to employ some kind of mutex (note also
317	as loops cannot be shared easily between threads anyway).	355	that this case is unlikely, as loops cannot be shared easily between
		356	threads anyway).
318		357
319	The default loop is the only loop that can handle C<ev_signal> and	358	The default loop is the only loop that can handle C<ev_child> watchers,
320	C<ev_child> watchers, and to do this, it always registers a handler	359	and to do this, it always registers a handler for C<SIGCHLD>. If this is
321	for C<SIGCHLD>. If this is a problem for your application you can either	360	a problem for your application you can either create a dynamic loop with
322	create a dynamic loop with C<ev_loop_new> that doesn't do that, or you	361	C<ev_loop_new> which doesn't do that, or you can simply overwrite the
323	can simply overwrite the C<SIGCHLD> signal handler I<after> calling	362	C<SIGCHLD> signal handler I<after> calling C<ev_default_init>.
324	C<ev_default_init>.	363
		364	Example: This is the most typical usage.
		365
		366	if (!ev_default_loop (0))
		367	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
		368
		369	Example: Restrict libev to the select and poll backends, and do not allow
		370	environment settings to be taken into account:
		371
		372	ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV);
		373
		374	=item struct ev_loop *ev_loop_new (unsigned int flags)
		375
		376	This will create and initialise a new event loop object. If the loop
		377	could not be initialised, returns false.
		378
		379	This function is thread-safe, and one common way to use libev with
		380	threads is indeed to create one loop per thread, and using the default
		381	loop in the "main" or "initial" thread.
325		382
326	The flags argument can be used to specify special behaviour or specific	383	The flags argument can be used to specify special behaviour or specific
327	backends to use, and is usually specified as C<0> (or C<EVFLAG_AUTO>).	384	backends to use, and is usually specified as C<0> (or C<EVFLAG_AUTO>).
328		385
329	The following flags are supported:	386	The following flags are supported:
…		…
344	useful to try out specific backends to test their performance, or to work	401	useful to try out specific backends to test their performance, or to work
345	around bugs.	402	around bugs.
346		403
347	=item C<EVFLAG_FORKCHECK>	404	=item C<EVFLAG_FORKCHECK>
348		405
349	Instead of calling C<ev_default_fork> or C<ev_loop_fork> manually after	406	Instead of calling C<ev_loop_fork> manually after a fork, you can also
350	a fork, you can also make libev check for a fork in each iteration by	407	make libev check for a fork in each iteration by enabling this flag.
351	enabling this flag.
352		408
353	This works by calling C<getpid ()> on every iteration of the loop,	409	This works by calling C<getpid ()> on every iteration of the loop,
354	and thus this might slow down your event loop if you do a lot of loop	410	and thus this might slow down your event loop if you do a lot of loop
355	iterations and little real work, but is usually not noticeable (on my	411	iterations and little real work, but is usually not noticeable (on my
356	GNU/Linux system for example, C<getpid> is actually a simple 5-insn sequence	412	GNU/Linux system for example, C<getpid> is actually a simple 5-insn sequence
…		…
362	flag.	418	flag.
363		419
364	This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS>	420	This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS>
365	environment variable.	421	environment variable.
366		422
		423	=item C<EVFLAG_NOINOTIFY>
		424
		425	When this flag is specified, then libev will not attempt to use the
		426	I<inotify> API for its C<ev_stat> watchers. Apart from debugging and
		427	testing, this flag can be useful to conserve inotify file descriptors, as
		428	otherwise each loop using C<ev_stat> watchers consumes one inotify handle.
		429
		430	=item C<EVFLAG_SIGNALFD>
		431
		432	When this flag is specified, then libev will attempt to use the
		433	I<signalfd> API for its C<ev_signal> (and C<ev_child>) watchers. This API
		434	delivers signals synchronously, which makes it both faster and might make
		435	it possible to get the queued signal data. It can also simplify signal
		436	handling with threads, as long as you properly block signals in your
		437	threads that are not interested in handling them.
		438
		439	Signalfd will not be used by default as this changes your signal mask, and
		440	there are a lot of shoddy libraries and programs (glib's threadpool for
		441	example) that can't properly initialise their signal masks.
		442
		443	=item C<EVFLAG_NOSIGMASK>
		444
		445	When this flag is specified, then libev will avoid to modify the signal
		446	mask. Specifically, this means you have to make sure signals are unblocked
		447	when you want to receive them.
		448
		449	This behaviour is useful when you want to do your own signal handling, or
		450	want to handle signals only in specific threads and want to avoid libev
		451	unblocking the signals.
		452
		453	It's also required by POSIX in a threaded program, as libev calls
		454	C<sigprocmask>, whose behaviour is officially unspecified.
		455
		456	This flag's behaviour will become the default in future versions of libev.
		457
367	=item C<EVBACKEND_SELECT> (value 1, portable select backend)	458	=item C<EVBACKEND_SELECT> (value 1, portable select backend)
368		459
369	This is your standard select(2) backend. Not I<completely> standard, as	460	This is your standard select(2) backend. Not I<completely> standard, as
370	libev tries to roll its own fd_set with no limits on the number of fds,	461	libev tries to roll its own fd_set with no limits on the number of fds,
371	but if that fails, expect a fairly low limit on the number of fds when	462	but if that fails, expect a fairly low limit on the number of fds when
…		…
395	This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and	486	This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and
396	C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>.	487	C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>.
397		488
398	=item C<EVBACKEND_EPOLL> (value 4, Linux)	489	=item C<EVBACKEND_EPOLL> (value 4, Linux)
399		490
		491	Use the linux-specific epoll(7) interface (for both pre- and post-2.6.9
		492	kernels).
		493
400	For few fds, this backend is a bit little slower than poll and select,	494	For few fds, this backend is a bit little slower than poll and select, but
401	but it scales phenomenally better. While poll and select usually scale	495	it scales phenomenally better. While poll and select usually scale like
402	like O(total_fds) where n is the total number of fds (or the highest fd),	496	O(total_fds) where total_fds is the total number of fds (or the highest
403	epoll scales either O(1) or O(active_fds).	497	fd), epoll scales either O(1) or O(active_fds).
404		498
405	The epoll mechanism deserves honorable mention as the most misdesigned	499	The epoll mechanism deserves honorable mention as the most misdesigned
406	of the more advanced event mechanisms: mere annoyances include silently	500	of the more advanced event mechanisms: mere annoyances include silently
407	dropping file descriptors, requiring a system call per change per file	501	dropping file descriptors, requiring a system call per change per file
408	descriptor (and unnecessary guessing of parameters), problems with dup and	502	descriptor (and unnecessary guessing of parameters), problems with dup,
		503	returning before the timeout value, resulting in additional iterations
		504	(and only giving 5ms accuracy while select on the same platform gives
409	so on. The biggest issue is fork races, however - if a program forks then	505	0.1ms) and so on. The biggest issue is fork races, however - if a program
410	I<both> parent and child process have to recreate the epoll set, which can	506	forks then I<both> parent and child process have to recreate the epoll
411	take considerable time (one syscall per file descriptor) and is of course	507	set, which can take considerable time (one syscall per file descriptor)
412	hard to detect.	508	and is of course hard to detect.
413		509
414	Epoll is also notoriously buggy - embedding epoll fds I<should> work, but	510	Epoll is also notoriously buggy - embedding epoll fds I<should> work,
415	of course I<doesn't>, and epoll just loves to report events for totally	511	but of course I<doesn't>, and epoll just loves to report events for
416	I<different> file descriptors (even already closed ones, so one cannot	512	totally I<different> file descriptors (even already closed ones, so
417	even remove them from the set) than registered in the set (especially	513	one cannot even remove them from the set) than registered in the set
418	on SMP systems). Libev tries to counter these spurious notifications by	514	(especially on SMP systems). Libev tries to counter these spurious
419	employing an additional generation counter and comparing that against the	515	notifications by employing an additional generation counter and comparing
420	events to filter out spurious ones, recreating the set when required.	516	that against the events to filter out spurious ones, recreating the set
		517	when required. Epoll also erroneously rounds down timeouts, but gives you
		518	no way to know when and by how much, so sometimes you have to busy-wait
		519	because epoll returns immediately despite a nonzero timeout. And last
		520	not least, it also refuses to work with some file descriptors which work
		521	perfectly fine with C<select> (files, many character devices...).
		522
		523	Epoll is truly the train wreck among event poll mechanisms, a frankenpoll,
		524	cobbled together in a hurry, no thought to design or interaction with
		525	others. Oh, the pain, will it ever stop...
421		526
422	While stopping, setting and starting an I/O watcher in the same iteration	527	While stopping, setting and starting an I/O watcher in the same iteration
423	will result in some caching, there is still a system call per such	528	will result in some caching, there is still a system call per such
424	incident (because the same I<file descriptor> could point to a different	529	incident (because the same I<file descriptor> could point to a different
425	I<file description> now), so its best to avoid that. Also, C<dup ()>'ed	530	I<file description> now), so its best to avoid that. Also, C<dup ()>'ed
…		…
491	=item C<EVBACKEND_PORT> (value 32, Solaris 10)	596	=item C<EVBACKEND_PORT> (value 32, Solaris 10)
492		597
493	This uses the Solaris 10 event port mechanism. As with everything on Solaris,	598	This uses the Solaris 10 event port mechanism. As with everything on Solaris,
494	it's really slow, but it still scales very well (O(active_fds)).	599	it's really slow, but it still scales very well (O(active_fds)).
495		600
496	Please note that Solaris event ports can deliver a lot of spurious
497	notifications, so you need to use non-blocking I/O or other means to avoid
498	blocking when no data (or space) is available.
499
500	While this backend scales well, it requires one system call per active	601	While this backend scales well, it requires one system call per active
501	file descriptor per loop iteration. For small and medium numbers of file	602	file descriptor per loop iteration. For small and medium numbers of file
502	descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend	603	descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend
503	might perform better.	604	might perform better.
504		605
505	On the positive side, with the exception of the spurious readiness	606	On the positive side, this backend actually performed fully to
506	notifications, this backend actually performed fully to specification
507	in all tests and is fully embeddable, which is a rare feat among the	607	specification in all tests and is fully embeddable, which is a rare feat
508	OS-specific backends (I vastly prefer correctness over speed hacks).	608	among the OS-specific backends (I vastly prefer correctness over speed
		609	hacks).
		610
		611	On the negative side, the interface is I<bizarre> - so bizarre that
		612	even sun itself gets it wrong in their code examples: The event polling
		613	function sometimes returns events to the caller even though an error
		614	occurred, but with no indication whether it has done so or not (yes, it's
		615	even documented that way) - deadly for edge-triggered interfaces where you
		616	absolutely have to know whether an event occurred or not because you have
		617	to re-arm the watcher.
		618
		619	Fortunately libev seems to be able to work around these idiocies.
509		620
510	This backend maps C<EV_READ> and C<EV_WRITE> in the same way as	621	This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
511	C<EVBACKEND_POLL>.	622	C<EVBACKEND_POLL>.
512		623
513	=item C<EVBACKEND_ALL>	624	=item C<EVBACKEND_ALL>
514		625
515	Try all backends (even potentially broken ones that wouldn't be tried	626	Try all backends (even potentially broken ones that wouldn't be tried
516	with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as	627	with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as
517	C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>.	628	C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>.
518		629
519	It is definitely not recommended to use this flag.	630	It is definitely not recommended to use this flag, use whatever
		631	C<ev_recommended_backends ()> returns, or simply do not specify a backend
		632	at all.
		633
		634	=item C<EVBACKEND_MASK>
		635
		636	Not a backend at all, but a mask to select all backend bits from a
		637	C<flags> value, in case you want to mask out any backends from a flags
		638	value (e.g. when modifying the C<LIBEV_FLAGS> environment variable).
520		639
521	=back	640	=back
522		641
523	If one or more of these are or'ed into the flags value, then only these	642	If one or more of the backend flags are or'ed into the flags value,
524	backends will be tried (in the reverse order as listed here). If none are	643	then only these backends will be tried (in the reverse order as listed
525	specified, all backends in C<ev_recommended_backends ()> will be tried.	644	here). If none are specified, all backends in C<ev_recommended_backends
526		645	()> will be tried.
527	Example: This is the most typical usage.
528
529	if (!ev_default_loop (0))
530	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
531
532	Example: Restrict libev to the select and poll backends, and do not allow
533	environment settings to be taken into account:
534
535	ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV);
536
537	Example: Use whatever libev has to offer, but make sure that kqueue is
538	used if available (warning, breaks stuff, best use only with your own
539	private event loop and only if you know the OS supports your types of
540	fds):
541
542	ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE);
543
544	=item struct ev_loop *ev_loop_new (unsigned int flags)
545
546	Similar to C<ev_default_loop>, but always creates a new event loop that is
547	always distinct from the default loop. Unlike the default loop, it cannot
548	handle signal and child watchers, and attempts to do so will be greeted by
549	undefined behaviour (or a failed assertion if assertions are enabled).
550
551	Note that this function I<is> thread-safe, and the recommended way to use
552	libev with threads is indeed to create one loop per thread, and using the
553	default loop in the "main" or "initial" thread.
554		646
555	Example: Try to create a event loop that uses epoll and nothing else.	647	Example: Try to create a event loop that uses epoll and nothing else.
556		648
557	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);	649	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
558	if (!epoller)	650	if (!epoller)
559	fatal ("no epoll found here, maybe it hides under your chair");	651	fatal ("no epoll found here, maybe it hides under your chair");
560		652
		653	Example: Use whatever libev has to offer, but make sure that kqueue is
		654	used if available.
		655
		656	struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE);
		657
561	=item ev_default_destroy ()	658	=item ev_loop_destroy (loop)
562		659
563	Destroys the default loop again (frees all memory and kernel state	660	Destroys an event loop object (frees all memory and kernel state
564	etc.). None of the active event watchers will be stopped in the normal	661	etc.). None of the active event watchers will be stopped in the normal
565	sense, so e.g. C<ev_is_active> might still return true. It is your	662	sense, so e.g. C<ev_is_active> might still return true. It is your
566	responsibility to either stop all watchers cleanly yourself I<before>	663	responsibility to either stop all watchers cleanly yourself I<before>
567	calling this function, or cope with the fact afterwards (which is usually	664	calling this function, or cope with the fact afterwards (which is usually
568	the easiest thing, you can just ignore the watchers and/or C<free ()> them	665	the easiest thing, you can just ignore the watchers and/or C<free ()> them
…		…
570		667
571	Note that certain global state, such as signal state (and installed signal	668	Note that certain global state, such as signal state (and installed signal
572	handlers), will not be freed by this function, and related watchers (such	669	handlers), will not be freed by this function, and related watchers (such
573	as signal and child watchers) would need to be stopped manually.	670	as signal and child watchers) would need to be stopped manually.
574		671
575	In general it is not advisable to call this function except in the	672	This function is normally used on loop objects allocated by
576	rare occasion where you really need to free e.g. the signal handling	673	C<ev_loop_new>, but it can also be used on the default loop returned by
		674	C<ev_default_loop>, in which case it is not thread-safe.
		675
		676	Note that it is not advisable to call this function on the default loop
		677	except in the rare occasion where you really need to free its resources.
577	pipe fds. If you need dynamically allocated loops it is better to use	678	If you need dynamically allocated loops it is better to use C<ev_loop_new>
578	C<ev_loop_new> and C<ev_loop_destroy>).	679	and C<ev_loop_destroy>.
579		680
580	=item ev_loop_destroy (loop)	681	=item ev_loop_fork (loop)
581		682
582	Like C<ev_default_destroy>, but destroys an event loop created by an
583	earlier call to C<ev_loop_new>.
584
585	=item ev_default_fork ()
586
587	This function sets a flag that causes subsequent C<ev_loop> iterations	683	This function sets a flag that causes subsequent C<ev_run> iterations to
588	to reinitialise the kernel state for backends that have one. Despite the	684	reinitialise the kernel state for backends that have one. Despite the
589	name, you can call it anytime, but it makes most sense after forking, in	685	name, you can call it anytime, but it makes most sense after forking, in
590	the child process (or both child and parent, but that again makes little	686	the child process. You I<must> call it (or use C<EVFLAG_FORKCHECK>) in the
591	sense). You I<must> call it in the child before using any of the libev	687	child before resuming or calling C<ev_run>.
592	functions, and it will only take effect at the next C<ev_loop> iteration.	688
		689	Again, you I<have> to call it on I<any> loop that you want to re-use after
		690	a fork, I<even if you do not plan to use the loop in the parent>. This is
		691	because some kernel interfaces *cough* I<kqueue> *cough* do funny things
		692	during fork.
593		693
594	On the other hand, you only need to call this function in the child	694	On the other hand, you only need to call this function in the child
595	process if and only if you want to use the event library in the child. If	695	process if and only if you want to use the event loop in the child. If
596	you just fork+exec, you don't have to call it at all.	696	you just fork+exec or create a new loop in the child, you don't have to
		697	call it at all (in fact, C<epoll> is so badly broken that it makes a
		698	difference, but libev will usually detect this case on its own and do a
		699	costly reset of the backend).
597		700
598	The function itself is quite fast and it's usually not a problem to call	701	The function itself is quite fast and it's usually not a problem to call
599	it just in case after a fork. To make this easy, the function will fit in	702	it just in case after a fork.
600	quite nicely into a call to C<pthread_atfork>:
601		703
		704	Example: Automate calling C<ev_loop_fork> on the default loop when
		705	using pthreads.
		706
		707	static void
		708	post_fork_child (void)
		709	{
		710	ev_loop_fork (EV_DEFAULT);
		711	}
		712
		713	...
602	pthread_atfork (0, 0, ev_default_fork);	714	pthread_atfork (0, 0, post_fork_child);
603
604	=item ev_loop_fork (loop)
605
606	Like C<ev_default_fork>, but acts on an event loop created by
607	C<ev_loop_new>. Yes, you have to call this on every allocated event loop
608	after fork that you want to re-use in the child, and how you do this is
609	entirely your own problem.
610		715
611	=item int ev_is_default_loop (loop)	716	=item int ev_is_default_loop (loop)
612		717
613	Returns true when the given loop is, in fact, the default loop, and false	718	Returns true when the given loop is, in fact, the default loop, and false
614	otherwise.	719	otherwise.
615		720
616	=item unsigned int ev_loop_count (loop)	721	=item unsigned int ev_iteration (loop)
617		722
618	Returns the count of loop iterations for the loop, which is identical to	723	Returns the current iteration count for the event loop, which is identical
619	the number of times libev did poll for new events. It starts at C<0> and	724	to the number of times libev did poll for new events. It starts at C<0>
620	happily wraps around with enough iterations.	725	and happily wraps around with enough iterations.
621		726
622	This value can sometimes be useful as a generation counter of sorts (it	727	This value can sometimes be useful as a generation counter of sorts (it
623	"ticks" the number of loop iterations), as it roughly corresponds with	728	"ticks" the number of loop iterations), as it roughly corresponds with
624	C<ev_prepare> and C<ev_check> calls.	729	C<ev_prepare> and C<ev_check> calls - and is incremented between the
		730	prepare and check phases.
		731
		732	=item unsigned int ev_depth (loop)
		733
		734	Returns the number of times C<ev_run> was entered minus the number of
		735	times C<ev_run> was exited normally, in other words, the recursion depth.
		736
		737	Outside C<ev_run>, this number is zero. In a callback, this number is
		738	C<1>, unless C<ev_run> was invoked recursively (or from another thread),
		739	in which case it is higher.
		740
		741	Leaving C<ev_run> abnormally (setjmp/longjmp, cancelling the thread,
		742	throwing an exception etc.), doesn't count as "exit" - consider this
		743	as a hint to avoid such ungentleman-like behaviour unless it's really
		744	convenient, in which case it is fully supported.
625		745
626	=item unsigned int ev_backend (loop)	746	=item unsigned int ev_backend (loop)
627		747
628	Returns one of the C<EVBACKEND_*> flags indicating the event backend in	748	Returns one of the C<EVBACKEND_*> flags indicating the event backend in
629	use.	749	use.
…		…
638		758
639	=item ev_now_update (loop)	759	=item ev_now_update (loop)
640		760
641	Establishes the current time by querying the kernel, updating the time	761	Establishes the current time by querying the kernel, updating the time
642	returned by C<ev_now ()> in the progress. This is a costly operation and	762	returned by C<ev_now ()> in the progress. This is a costly operation and
643	is usually done automatically within C<ev_loop ()>.	763	is usually done automatically within C<ev_run ()>.
644		764
645	This function is rarely useful, but when some event callback runs for a	765	This function is rarely useful, but when some event callback runs for a
646	very long time without entering the event loop, updating libev's idea of	766	very long time without entering the event loop, updating libev's idea of
647	the current time is a good idea.	767	the current time is a good idea.
648		768
…		…
650		770
651	=item ev_suspend (loop)	771	=item ev_suspend (loop)
652		772
653	=item ev_resume (loop)	773	=item ev_resume (loop)
654		774
655	These two functions suspend and resume a loop, for use when the loop is	775	These two functions suspend and resume an event loop, for use when the
656	not used for a while and timeouts should not be processed.	776	loop is not used for a while and timeouts should not be processed.
657		777
658	A typical use case would be an interactive program such as a game: When	778	A typical use case would be an interactive program such as a game: When
659	the user presses C<^Z> to suspend the game and resumes it an hour later it	779	the user presses C<^Z> to suspend the game and resumes it an hour later it
660	would be best to handle timeouts as if no time had actually passed while	780	would be best to handle timeouts as if no time had actually passed while
661	the program was suspended. This can be achieved by calling C<ev_suspend>	781	the program was suspended. This can be achieved by calling C<ev_suspend>
…		…
663	C<ev_resume> directly afterwards to resume timer processing.	783	C<ev_resume> directly afterwards to resume timer processing.
664		784
665	Effectively, all C<ev_timer> watchers will be delayed by the time spend	785	Effectively, all C<ev_timer> watchers will be delayed by the time spend
666	between C<ev_suspend> and C<ev_resume>, and all C<ev_periodic> watchers	786	between C<ev_suspend> and C<ev_resume>, and all C<ev_periodic> watchers
667	will be rescheduled (that is, they will lose any events that would have	787	will be rescheduled (that is, they will lose any events that would have
668	occured while suspended).	788	occurred while suspended).
669		789
670	After calling C<ev_suspend> you B<must not> call I<any> function on the	790	After calling C<ev_suspend> you B<must not> call I<any> function on the
671	given loop other than C<ev_resume>, and you B<must not> call C<ev_resume>	791	given loop other than C<ev_resume>, and you B<must not> call C<ev_resume>
672	without a previous call to C<ev_suspend>.	792	without a previous call to C<ev_suspend>.
673		793
674	Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the	794	Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the
675	event loop time (see C<ev_now_update>).	795	event loop time (see C<ev_now_update>).
676		796
677	=item ev_loop (loop, int flags)	797	=item ev_run (loop, int flags)
678		798
679	Finally, this is it, the event handler. This function usually is called	799	Finally, this is it, the event handler. This function usually is called
680	after you initialised all your watchers and you want to start handling	800	after you have initialised all your watchers and you want to start
681	events.	801	handling events. It will ask the operating system for any new events, call
		802	the watcher callbacks, an then repeat the whole process indefinitely: This
		803	is why event loops are called I<loops>.
682		804
683	If the flags argument is specified as C<0>, it will not return until	805	If the flags argument is specified as C<0>, it will keep handling events
684	either no event watchers are active anymore or C<ev_unloop> was called.	806	until either no event watchers are active anymore or C<ev_break> was
		807	called.
685		808
686	Please note that an explicit C<ev_unloop> is usually better than	809	Please note that an explicit C<ev_break> is usually better than
687	relying on all watchers to be stopped when deciding when a program has	810	relying on all watchers to be stopped when deciding when a program has
688	finished (especially in interactive programs), but having a program	811	finished (especially in interactive programs), but having a program
689	that automatically loops as long as it has to and no longer by virtue	812	that automatically loops as long as it has to and no longer by virtue
690	of relying on its watchers stopping correctly, that is truly a thing of	813	of relying on its watchers stopping correctly, that is truly a thing of
691	beauty.	814	beauty.
692		815
		816	This function is also I<mostly> exception-safe - you can break out of
		817	a C<ev_run> call by calling C<longjmp> in a callback, throwing a C++
		818	exception and so on. This does not decrement the C<ev_depth> value, nor
		819	will it clear any outstanding C<EVBREAK_ONE> breaks.
		820
693	A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle	821	A flags value of C<EVRUN_NOWAIT> will look for new events, will handle
694	those events and any already outstanding ones, but will not block your	822	those events and any already outstanding ones, but will not wait and
695	process in case there are no events and will return after one iteration of	823	block your process in case there are no events and will return after one
696	the loop.	824	iteration of the loop. This is sometimes useful to poll and handle new
		825	events while doing lengthy calculations, to keep the program responsive.
697		826
698	A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if	827	A flags value of C<EVRUN_ONCE> will look for new events (waiting if
699	necessary) and will handle those and any already outstanding ones. It	828	necessary) and will handle those and any already outstanding ones. It
700	will block your process until at least one new event arrives (which could	829	will block your process until at least one new event arrives (which could
701	be an event internal to libev itself, so there is no guarantee that a	830	be an event internal to libev itself, so there is no guarantee that a
702	user-registered callback will be called), and will return after one	831	user-registered callback will be called), and will return after one
703	iteration of the loop.	832	iteration of the loop.
704		833
705	This is useful if you are waiting for some external event in conjunction	834	This is useful if you are waiting for some external event in conjunction
706	with something not expressible using other libev watchers (i.e. "roll your	835	with something not expressible using other libev watchers (i.e. "roll your
707	own C<ev_loop>"). However, a pair of C<ev_prepare>/C<ev_check> watchers is	836	own C<ev_run>"). However, a pair of C<ev_prepare>/C<ev_check> watchers is
708	usually a better approach for this kind of thing.	837	usually a better approach for this kind of thing.
709		838
710	Here are the gory details of what C<ev_loop> does:	839	Here are the gory details of what C<ev_run> does (this is for your
		840	understanding, not a guarantee that things will work exactly like this in
		841	future versions):
711		842
		843	- Increment loop depth.
		844	- Reset the ev_break status.
712	- Before the first iteration, call any pending watchers.	845	- Before the first iteration, call any pending watchers.
		846	LOOP:
713	* If EVFLAG_FORKCHECK was used, check for a fork.	847	- If EVFLAG_FORKCHECK was used, check for a fork.
714	- If a fork was detected (by any means), queue and call all fork watchers.	848	- If a fork was detected (by any means), queue and call all fork watchers.
715	- Queue and call all prepare watchers.	849	- Queue and call all prepare watchers.
		850	- If ev_break was called, goto FINISH.
716	- If we have been forked, detach and recreate the kernel state	851	- If we have been forked, detach and recreate the kernel state
717	as to not disturb the other process.	852	as to not disturb the other process.
718	- Update the kernel state with all outstanding changes.	853	- Update the kernel state with all outstanding changes.
719	- Update the "event loop time" (ev_now ()).	854	- Update the "event loop time" (ev_now ()).
720	- Calculate for how long to sleep or block, if at all	855	- Calculate for how long to sleep or block, if at all
721	(active idle watchers, EVLOOP_NONBLOCK or not having	856	(active idle watchers, EVRUN_NOWAIT or not having
722	any active watchers at all will result in not sleeping).	857	any active watchers at all will result in not sleeping).
723	- Sleep if the I/O and timer collect interval say so.	858	- Sleep if the I/O and timer collect interval say so.
		859	- Increment loop iteration counter.
724	- Block the process, waiting for any events.	860	- Block the process, waiting for any events.
725	- Queue all outstanding I/O (fd) events.	861	- Queue all outstanding I/O (fd) events.
726	- Update the "event loop time" (ev_now ()), and do time jump adjustments.	862	- Update the "event loop time" (ev_now ()), and do time jump adjustments.
727	- Queue all expired timers.	863	- Queue all expired timers.
728	- Queue all expired periodics.	864	- Queue all expired periodics.
729	- Unless any events are pending now, queue all idle watchers.	865	- Queue all idle watchers with priority higher than that of pending events.
730	- Queue all check watchers.	866	- Queue all check watchers.
731	- Call all queued watchers in reverse order (i.e. check watchers first).	867	- Call all queued watchers in reverse order (i.e. check watchers first).
732	Signals and child watchers are implemented as I/O watchers, and will	868	Signals and child watchers are implemented as I/O watchers, and will
733	be handled here by queueing them when their watcher gets executed.	869	be handled here by queueing them when their watcher gets executed.
734	- If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK	870	- If ev_break has been called, or EVRUN_ONCE or EVRUN_NOWAIT
735	were used, or there are no active watchers, return, otherwise	871	were used, or there are no active watchers, goto FINISH, otherwise
736	continue with step *.	872	continue with step LOOP.
		873	FINISH:
		874	- Reset the ev_break status iff it was EVBREAK_ONE.
		875	- Decrement the loop depth.
		876	- Return.
737		877
738	Example: Queue some jobs and then loop until no events are outstanding	878	Example: Queue some jobs and then loop until no events are outstanding
739	anymore.	879	anymore.
740		880
741	... queue jobs here, make sure they register event watchers as long	881	... queue jobs here, make sure they register event watchers as long
742	... as they still have work to do (even an idle watcher will do..)	882	... as they still have work to do (even an idle watcher will do..)
743	ev_loop (my_loop, 0);	883	ev_run (my_loop, 0);
744	... jobs done or somebody called unloop. yeah!	884	... jobs done or somebody called break. yeah!
745		885
746	=item ev_unloop (loop, how)	886	=item ev_break (loop, how)
747		887
748	Can be used to make a call to C<ev_loop> return early (but only after it	888	Can be used to make a call to C<ev_run> return early (but only after it
749	has processed all outstanding events). The C<how> argument must be either	889	has processed all outstanding events). The C<how> argument must be either
750	C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or	890	C<EVBREAK_ONE>, which will make the innermost C<ev_run> call return, or
751	C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return.	891	C<EVBREAK_ALL>, which will make all nested C<ev_run> calls return.
752		892
753	This "unloop state" will be cleared when entering C<ev_loop> again.	893	This "break state" will be cleared on the next call to C<ev_run>.
754		894
755	It is safe to call C<ev_unloop> from otuside any C<ev_loop> calls.	895	It is safe to call C<ev_break> from outside any C<ev_run> calls, too, in
		896	which case it will have no effect.
756		897
757	=item ev_ref (loop)	898	=item ev_ref (loop)
758		899
759	=item ev_unref (loop)	900	=item ev_unref (loop)
760		901
761	Ref/unref can be used to add or remove a reference count on the event	902	Ref/unref can be used to add or remove a reference count on the event
762	loop: Every watcher keeps one reference, and as long as the reference	903	loop: Every watcher keeps one reference, and as long as the reference
763	count is nonzero, C<ev_loop> will not return on its own.	904	count is nonzero, C<ev_run> will not return on its own.
764		905
765	If you have a watcher you never unregister that should not keep C<ev_loop>	906	This is useful when you have a watcher that you never intend to
766	from returning, call ev_unref() after starting, and ev_ref() before	907	unregister, but that nevertheless should not keep C<ev_run> from
		908	returning. In such a case, call C<ev_unref> after starting, and C<ev_ref>
767	stopping it.	909	before stopping it.
768		910
769	As an example, libev itself uses this for its internal signal pipe: It	911	As an example, libev itself uses this for its internal signal pipe: It
770	is not visible to the libev user and should not keep C<ev_loop> from	912	is not visible to the libev user and should not keep C<ev_run> from
771	exiting if no event watchers registered by it are active. It is also an	913	exiting if no event watchers registered by it are active. It is also an
772	excellent way to do this for generic recurring timers or from within	914	excellent way to do this for generic recurring timers or from within
773	third-party libraries. Just remember to I<unref after start> and I<ref	915	third-party libraries. Just remember to I<unref after start> and I<ref
774	before stop> (but only if the watcher wasn't active before, or was active	916	before stop> (but only if the watcher wasn't active before, or was active
775	before, respectively. Note also that libev might stop watchers itself	917	before, respectively. Note also that libev might stop watchers itself
776	(e.g. non-repeating timers) in which case you have to C<ev_ref>	918	(e.g. non-repeating timers) in which case you have to C<ev_ref>
777	in the callback).	919	in the callback).
778		920
779	Example: Create a signal watcher, but keep it from keeping C<ev_loop>	921	Example: Create a signal watcher, but keep it from keeping C<ev_run>
780	running when nothing else is active.	922	running when nothing else is active.
781		923
782	ev_signal exitsig;	924	ev_signal exitsig;
783	ev_signal_init (&exitsig, sig_cb, SIGINT);	925	ev_signal_init (&exitsig, sig_cb, SIGINT);
784	ev_signal_start (loop, &exitsig);	926	ev_signal_start (loop, &exitsig);
785	evf_unref (loop);	927	ev_unref (loop);
786		928
787	Example: For some weird reason, unregister the above signal handler again.	929	Example: For some weird reason, unregister the above signal handler again.
788		930
789	ev_ref (loop);	931	ev_ref (loop);
790	ev_signal_stop (loop, &exitsig);	932	ev_signal_stop (loop, &exitsig);
…		…
810	overhead for the actual polling but can deliver many events at once.	952	overhead for the actual polling but can deliver many events at once.
811		953
812	By setting a higher I<io collect interval> you allow libev to spend more	954	By setting a higher I<io collect interval> you allow libev to spend more
813	time collecting I/O events, so you can handle more events per iteration,	955	time collecting I/O events, so you can handle more events per iteration,
814	at the cost of increasing latency. Timeouts (both C<ev_periodic> and	956	at the cost of increasing latency. Timeouts (both C<ev_periodic> and
815	C<ev_timer>) will be not affected. Setting this to a non-null value will	957	C<ev_timer>) will not be affected. Setting this to a non-null value will
816	introduce an additional C<ev_sleep ()> call into most loop iterations. The	958	introduce an additional C<ev_sleep ()> call into most loop iterations. The
817	sleep time ensures that libev will not poll for I/O events more often then	959	sleep time ensures that libev will not poll for I/O events more often then
818	once per this interval, on average.	960	once per this interval, on average (as long as the host time resolution is
		961	good enough).
819		962
820	Likewise, by setting a higher I<timeout collect interval> you allow libev	963	Likewise, by setting a higher I<timeout collect interval> you allow libev
821	to spend more time collecting timeouts, at the expense of increased	964	to spend more time collecting timeouts, at the expense of increased
822	latency/jitter/inexactness (the watcher callback will be called	965	latency/jitter/inexactness (the watcher callback will be called
823	later). C<ev_io> watchers will not be affected. Setting this to a non-null	966	later). C<ev_io> watchers will not be affected. Setting this to a non-null
…		…
829	usually doesn't make much sense to set it to a lower value than C<0.01>,	972	usually doesn't make much sense to set it to a lower value than C<0.01>,
830	as this approaches the timing granularity of most systems. Note that if	973	as this approaches the timing granularity of most systems. Note that if
831	you do transactions with the outside world and you can't increase the	974	you do transactions with the outside world and you can't increase the
832	parallelity, then this setting will limit your transaction rate (if you	975	parallelity, then this setting will limit your transaction rate (if you
833	need to poll once per transaction and the I/O collect interval is 0.01,	976	need to poll once per transaction and the I/O collect interval is 0.01,
834	then you can't do more than 100 transations per second).	977	then you can't do more than 100 transactions per second).
835		978
836	Setting the I<timeout collect interval> can improve the opportunity for	979	Setting the I<timeout collect interval> can improve the opportunity for
837	saving power, as the program will "bundle" timer callback invocations that	980	saving power, as the program will "bundle" timer callback invocations that
838	are "near" in time together, by delaying some, thus reducing the number of	981	are "near" in time together, by delaying some, thus reducing the number of
839	times the process sleeps and wakes up again. Another useful technique to	982	times the process sleeps and wakes up again. Another useful technique to
…		…
844	more often than 100 times per second:	987	more often than 100 times per second:
845		988
846	ev_set_timeout_collect_interval (EV_DEFAULT_UC_ 0.1);	989	ev_set_timeout_collect_interval (EV_DEFAULT_UC_ 0.1);
847	ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01);	990	ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01);
848		991
		992	=item ev_invoke_pending (loop)
		993
		994	This call will simply invoke all pending watchers while resetting their
		995	pending state. Normally, C<ev_run> does this automatically when required,
		996	but when overriding the invoke callback this call comes handy. This
		997	function can be invoked from a watcher - this can be useful for example
		998	when you want to do some lengthy calculation and want to pass further
		999	event handling to another thread (you still have to make sure only one
		1000	thread executes within C<ev_invoke_pending> or C<ev_run> of course).
		1001
		1002	=item int ev_pending_count (loop)
		1003
		1004	Returns the number of pending watchers - zero indicates that no watchers
		1005	are pending.
		1006
		1007	=item ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P))
		1008
		1009	This overrides the invoke pending functionality of the loop: Instead of
		1010	invoking all pending watchers when there are any, C<ev_run> will call
		1011	this callback instead. This is useful, for example, when you want to
		1012	invoke the actual watchers inside another context (another thread etc.).
		1013
		1014	If you want to reset the callback, use C<ev_invoke_pending> as new
		1015	callback.
		1016
		1017	=item ev_set_loop_release_cb (loop, void (*release)(EV_P), void (*acquire)(EV_P))
		1018
		1019	Sometimes you want to share the same loop between multiple threads. This
		1020	can be done relatively simply by putting mutex_lock/unlock calls around
		1021	each call to a libev function.
		1022
		1023	However, C<ev_run> can run an indefinite time, so it is not feasible
		1024	to wait for it to return. One way around this is to wake up the event
		1025	loop via C<ev_break> and C<av_async_send>, another way is to set these
		1026	I<release> and I<acquire> callbacks on the loop.
		1027
		1028	When set, then C<release> will be called just before the thread is
		1029	suspended waiting for new events, and C<acquire> is called just
		1030	afterwards.
		1031
		1032	Ideally, C<release> will just call your mutex_unlock function, and
		1033	C<acquire> will just call the mutex_lock function again.
		1034
		1035	While event loop modifications are allowed between invocations of
		1036	C<release> and C<acquire> (that's their only purpose after all), no
		1037	modifications done will affect the event loop, i.e. adding watchers will
		1038	have no effect on the set of file descriptors being watched, or the time
		1039	waited. Use an C<ev_async> watcher to wake up C<ev_run> when you want it
		1040	to take note of any changes you made.
		1041
		1042	In theory, threads executing C<ev_run> will be async-cancel safe between
		1043	invocations of C<release> and C<acquire>.
		1044
		1045	See also the locking example in the C<THREADS> section later in this
		1046	document.
		1047
		1048	=item ev_set_userdata (loop, void *data)
		1049
		1050	=item void *ev_userdata (loop)
		1051
		1052	Set and retrieve a single C<void *> associated with a loop. When
		1053	C<ev_set_userdata> has never been called, then C<ev_userdata> returns
		1054	C<0>.
		1055
		1056	These two functions can be used to associate arbitrary data with a loop,
		1057	and are intended solely for the C<invoke_pending_cb>, C<release> and
		1058	C<acquire> callbacks described above, but of course can be (ab-)used for
		1059	any other purpose as well.
		1060
849	=item ev_loop_verify (loop)	1061	=item ev_verify (loop)
850		1062
851	This function only does something when C<EV_VERIFY> support has been	1063	This function only does something when C<EV_VERIFY> support has been
852	compiled in, which is the default for non-minimal builds. It tries to go	1064	compiled in, which is the default for non-minimal builds. It tries to go
853	through all internal structures and checks them for validity. If anything	1065	through all internal structures and checks them for validity. If anything
854	is found to be inconsistent, it will print an error message to standard	1066	is found to be inconsistent, it will print an error message to standard
…		…
865		1077
866	In the following description, uppercase C<TYPE> in names stands for the	1078	In the following description, uppercase C<TYPE> in names stands for the
867	watcher type, e.g. C<ev_TYPE_start> can mean C<ev_timer_start> for timer	1079	watcher type, e.g. C<ev_TYPE_start> can mean C<ev_timer_start> for timer
868	watchers and C<ev_io_start> for I/O watchers.	1080	watchers and C<ev_io_start> for I/O watchers.
869		1081
870	A watcher is a structure that you create and register to record your	1082	A watcher is an opaque structure that you allocate and register to record
871	interest in some event. For instance, if you want to wait for STDIN to	1083	your interest in some event. To make a concrete example, imagine you want
872	become readable, you would create an C<ev_io> watcher for that:	1084	to wait for STDIN to become readable, you would create an C<ev_io> watcher
		1085	for that:
873		1086
874	static void my_cb (struct ev_loop *loop, ev_io *w, int revents)	1087	static void my_cb (struct ev_loop *loop, ev_io *w, int revents)
875	{	1088	{
876	ev_io_stop (w);	1089	ev_io_stop (w);
877	ev_unloop (loop, EVUNLOOP_ALL);	1090	ev_break (loop, EVBREAK_ALL);
878	}	1091	}
879		1092
880	struct ev_loop *loop = ev_default_loop (0);	1093	struct ev_loop *loop = ev_default_loop (0);
881		1094
882	ev_io stdin_watcher;	1095	ev_io stdin_watcher;
883		1096
884	ev_init (&stdin_watcher, my_cb);	1097	ev_init (&stdin_watcher, my_cb);
885	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);	1098	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);
886	ev_io_start (loop, &stdin_watcher);	1099	ev_io_start (loop, &stdin_watcher);
887		1100
888	ev_loop (loop, 0);	1101	ev_run (loop, 0);
889		1102
890	As you can see, you are responsible for allocating the memory for your	1103	As you can see, you are responsible for allocating the memory for your
891	watcher structures (and it is I<usually> a bad idea to do this on the	1104	watcher structures (and it is I<usually> a bad idea to do this on the
892	stack).	1105	stack).
893		1106
894	Each watcher has an associated watcher structure (called C<struct ev_TYPE>	1107	Each watcher has an associated watcher structure (called C<struct ev_TYPE>
895	or simply C<ev_TYPE>, as typedefs are provided for all watcher structs).	1108	or simply C<ev_TYPE>, as typedefs are provided for all watcher structs).
896		1109
897	Each watcher structure must be initialised by a call to C<ev_init	1110	Each watcher structure must be initialised by a call to C<ev_init (watcher
898	(watcher *, callback)>, which expects a callback to be provided. This	1111	*, callback)>, which expects a callback to be provided. This callback is
899	callback gets invoked each time the event occurs (or, in the case of I/O	1112	invoked each time the event occurs (or, in the case of I/O watchers, each
900	watchers, each time the event loop detects that the file descriptor given	1113	time the event loop detects that the file descriptor given is readable
901	is readable and/or writable).	1114	and/or writable).
902		1115
903	Each watcher type further has its own C<< ev_TYPE_set (watcher *, ...) >>	1116	Each watcher type further has its own C<< ev_TYPE_set (watcher *, ...) >>
904	macro to configure it, with arguments specific to the watcher type. There	1117	macro to configure it, with arguments specific to the watcher type. There
905	is also a macro to combine initialisation and setting in one call: C<<	1118	is also a macro to combine initialisation and setting in one call: C<<
906	ev_TYPE_init (watcher *, callback, ...) >>.	1119	ev_TYPE_init (watcher *, callback, ...) >>.
…		…
929	=item C<EV_WRITE>	1142	=item C<EV_WRITE>
930		1143
931	The file descriptor in the C<ev_io> watcher has become readable and/or	1144	The file descriptor in the C<ev_io> watcher has become readable and/or
932	writable.	1145	writable.
933		1146
934	=item C<EV_TIMEOUT>	1147	=item C<EV_TIMER>
935		1148
936	The C<ev_timer> watcher has timed out.	1149	The C<ev_timer> watcher has timed out.
937		1150
938	=item C<EV_PERIODIC>	1151	=item C<EV_PERIODIC>
939		1152
…		…
957		1170
958	=item C<EV_PREPARE>	1171	=item C<EV_PREPARE>
959		1172
960	=item C<EV_CHECK>	1173	=item C<EV_CHECK>
961		1174
962	All C<ev_prepare> watchers are invoked just I<before> C<ev_loop> starts	1175	All C<ev_prepare> watchers are invoked just I<before> C<ev_run> starts
963	to gather new events, and all C<ev_check> watchers are invoked just after	1176	to gather new events, and all C<ev_check> watchers are invoked just after
964	C<ev_loop> has gathered them, but before it invokes any callbacks for any	1177	C<ev_run> has gathered them, but before it invokes any callbacks for any
965	received events. Callbacks of both watcher types can start and stop as	1178	received events. Callbacks of both watcher types can start and stop as
966	many watchers as they want, and all of them will be taken into account	1179	many watchers as they want, and all of them will be taken into account
967	(for example, a C<ev_prepare> watcher might start an idle watcher to keep	1180	(for example, a C<ev_prepare> watcher might start an idle watcher to keep
968	C<ev_loop> from blocking).	1181	C<ev_run> from blocking).
969		1182
970	=item C<EV_EMBED>	1183	=item C<EV_EMBED>
971		1184
972	The embedded event loop specified in the C<ev_embed> watcher needs attention.	1185	The embedded event loop specified in the C<ev_embed> watcher needs attention.
973		1186
974	=item C<EV_FORK>	1187	=item C<EV_FORK>
975		1188
976	The event loop has been resumed in the child process after fork (see	1189	The event loop has been resumed in the child process after fork (see
977	C<ev_fork>).	1190	C<ev_fork>).
		1191
		1192	=item C<EV_CLEANUP>
		1193
		1194	The event loop is about to be destroyed (see C<ev_cleanup>).
978		1195
979	=item C<EV_ASYNC>	1196	=item C<EV_ASYNC>
980		1197
981	The given async watcher has been asynchronously notified (see C<ev_async>).	1198	The given async watcher has been asynchronously notified (see C<ev_async>).
982		1199
…		…
1029		1246
1030	ev_io w;	1247	ev_io w;
1031	ev_init (&w, my_cb);	1248	ev_init (&w, my_cb);
1032	ev_io_set (&w, STDIN_FILENO, EV_READ);	1249	ev_io_set (&w, STDIN_FILENO, EV_READ);
1033		1250
1034	=item C<ev_TYPE_set> (ev_TYPE *, [args])	1251	=item C<ev_TYPE_set> (ev_TYPE *watcher, [args])
1035		1252
1036	This macro initialises the type-specific parts of a watcher. You need to	1253	This macro initialises the type-specific parts of a watcher. You need to
1037	call C<ev_init> at least once before you call this macro, but you can	1254	call C<ev_init> at least once before you call this macro, but you can
1038	call C<ev_TYPE_set> any number of times. You must not, however, call this	1255	call C<ev_TYPE_set> any number of times. You must not, however, call this
1039	macro on a watcher that is active (it can be pending, however, which is a	1256	macro on a watcher that is active (it can be pending, however, which is a
…		…
1052		1269
1053	Example: Initialise and set an C<ev_io> watcher in one step.	1270	Example: Initialise and set an C<ev_io> watcher in one step.
1054		1271
1055	ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ);	1272	ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ);
1056		1273
1057	=item C<ev_TYPE_start> (loop *, ev_TYPE *watcher)	1274	=item C<ev_TYPE_start> (loop, ev_TYPE *watcher)
1058		1275
1059	Starts (activates) the given watcher. Only active watchers will receive	1276	Starts (activates) the given watcher. Only active watchers will receive
1060	events. If the watcher is already active nothing will happen.	1277	events. If the watcher is already active nothing will happen.
1061		1278
1062	Example: Start the C<ev_io> watcher that is being abused as example in this	1279	Example: Start the C<ev_io> watcher that is being abused as example in this
1063	whole section.	1280	whole section.
1064		1281
1065	ev_io_start (EV_DEFAULT_UC, &w);	1282	ev_io_start (EV_DEFAULT_UC, &w);
1066		1283
1067	=item C<ev_TYPE_stop> (loop *, ev_TYPE *watcher)	1284	=item C<ev_TYPE_stop> (loop, ev_TYPE *watcher)
1068		1285
1069	Stops the given watcher if active, and clears the pending status (whether	1286	Stops the given watcher if active, and clears the pending status (whether
1070	the watcher was active or not).	1287	the watcher was active or not).
1071		1288
1072	It is possible that stopped watchers are pending - for example,	1289	It is possible that stopped watchers are pending - for example,
…		…
1097	=item ev_cb_set (ev_TYPE *watcher, callback)	1314	=item ev_cb_set (ev_TYPE *watcher, callback)
1098		1315
1099	Change the callback. You can change the callback at virtually any time	1316	Change the callback. You can change the callback at virtually any time
1100	(modulo threads).	1317	(modulo threads).
1101		1318
1102	=item ev_set_priority (ev_TYPE *watcher, priority)	1319	=item ev_set_priority (ev_TYPE *watcher, int priority)
1103		1320
1104	=item int ev_priority (ev_TYPE *watcher)	1321	=item int ev_priority (ev_TYPE *watcher)
1105		1322
1106	Set and query the priority of the watcher. The priority is a small	1323	Set and query the priority of the watcher. The priority is a small
1107	integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>	1324	integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>
…		…
1139	watcher isn't pending it does nothing and returns C<0>.	1356	watcher isn't pending it does nothing and returns C<0>.
1140		1357
1141	Sometimes it can be useful to "poll" a watcher instead of waiting for its	1358	Sometimes it can be useful to "poll" a watcher instead of waiting for its
1142	callback to be invoked, which can be accomplished with this function.	1359	callback to be invoked, which can be accomplished with this function.
1143		1360
		1361	=item ev_feed_event (loop, ev_TYPE *watcher, int revents)
		1362
		1363	Feeds the given event set into the event loop, as if the specified event
		1364	had happened for the specified watcher (which must be a pointer to an
		1365	initialised but not necessarily started event watcher). Obviously you must
		1366	not free the watcher as long as it has pending events.
		1367
		1368	Stopping the watcher, letting libev invoke it, or calling
		1369	C<ev_clear_pending> will clear the pending event, even if the watcher was
		1370	not started in the first place.
		1371
		1372	See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related
		1373	functions that do not need a watcher.
		1374
1144	=back	1375	=back
1145		1376
		1377	See also the L<ASSOCIATING CUSTOM DATA WITH A WATCHER> and L<BUILDING YOUR
		1378	OWN COMPOSITE WATCHERS> idioms.
1146		1379
1147	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER	1380	=head2 WATCHER STATES
1148		1381
1149	Each watcher has, by default, a member C<void *data> that you can change	1382	There are various watcher states mentioned throughout this manual -
1150	and read at any time: libev will completely ignore it. This can be used	1383	active, pending and so on. In this section these states and the rules to
1151	to associate arbitrary data with your watcher. If you need more data and	1384	transition between them will be described in more detail - and while these
1152	don't want to allocate memory and store a pointer to it in that data	1385	rules might look complicated, they usually do "the right thing".
1153	member, you can also "subclass" the watcher type and provide your own
1154	data:
1155		1386
1156	struct my_io	1387	=over 4
1157	{
1158	ev_io io;
1159	int otherfd;
1160	void *somedata;
1161	struct whatever *mostinteresting;
1162	};
1163		1388
1164	...	1389	=item initialiased
1165	struct my_io w;
1166	ev_io_init (&w.io, my_cb, fd, EV_READ);
1167		1390
1168	And since your callback will be called with a pointer to the watcher, you	1391	Before a watcher can be registered with the event loop it has to be
1169	can cast it back to your own type:	1392	initialised. This can be done with a call to C<ev_TYPE_init>, or calls to
		1393	C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function.
1170		1394
1171	static void my_cb (struct ev_loop *loop, ev_io *w_, int revents)	1395	In this state it is simply some block of memory that is suitable for
1172	{	1396	use in an event loop. It can be moved around, freed, reused etc. at
1173	struct my_io *w = (struct my_io *)w_;	1397	will - as long as you either keep the memory contents intact, or call
1174	...	1398	C<ev_TYPE_init> again.
1175	}
1176		1399
1177	More interesting and less C-conformant ways of casting your callback type	1400	=item started/running/active
1178	instead have been omitted.
1179		1401
1180	Another common scenario is to use some data structure with multiple	1402	Once a watcher has been started with a call to C<ev_TYPE_start> it becomes
1181	embedded watchers:	1403	property of the event loop, and is actively waiting for events. While in
		1404	this state it cannot be accessed (except in a few documented ways), moved,
		1405	freed or anything else - the only legal thing is to keep a pointer to it,
		1406	and call libev functions on it that are documented to work on active watchers.
1182		1407
1183	struct my_biggy	1408	=item pending
1184	{
1185	int some_data;
1186	ev_timer t1;
1187	ev_timer t2;
1188	}
1189		1409
1190	In this case getting the pointer to C<my_biggy> is a bit more	1410	If a watcher is active and libev determines that an event it is interested
1191	complicated: Either you store the address of your C<my_biggy> struct	1411	in has occurred (such as a timer expiring), it will become pending. It will
1192	in the C<data> member of the watcher (for woozies), or you need to use	1412	stay in this pending state until either it is stopped or its callback is
1193	some pointer arithmetic using C<offsetof> inside your watchers (for real	1413	about to be invoked, so it is not normally pending inside the watcher
1194	programmers):	1414	callback.
1195		1415
1196	#include <stddef.h>	1416	The watcher might or might not be active while it is pending (for example,
		1417	an expired non-repeating timer can be pending but no longer active). If it
		1418	is stopped, it can be freely accessed (e.g. by calling C<ev_TYPE_set>),
		1419	but it is still property of the event loop at this time, so cannot be
		1420	moved, freed or reused. And if it is active the rules described in the
		1421	previous item still apply.
1197		1422
1198	static void	1423	It is also possible to feed an event on a watcher that is not active (e.g.
1199	t1_cb (EV_P_ ev_timer *w, int revents)	1424	via C<ev_feed_event>), in which case it becomes pending without being
1200	{	1425	active.
1201	struct my_biggy big = (struct my_biggy *)
1202	(((char *)w) - offsetof (struct my_biggy, t1));
1203	}
1204		1426
1205	static void	1427	=item stopped
1206	t2_cb (EV_P_ ev_timer *w, int revents)	1428
1207	{	1429	A watcher can be stopped implicitly by libev (in which case it might still
1208	struct my_biggy big = (struct my_biggy *)	1430	be pending), or explicitly by calling its C<ev_TYPE_stop> function. The
1209	(((char *)w) - offsetof (struct my_biggy, t2));	1431	latter will clear any pending state the watcher might be in, regardless
1210	}	1432	of whether it was active or not, so stopping a watcher explicitly before
		1433	freeing it is often a good idea.
		1434
		1435	While stopped (and not pending) the watcher is essentially in the
		1436	initialised state, that is, it can be reused, moved, modified in any way
		1437	you wish (but when you trash the memory block, you need to C<ev_TYPE_init>
		1438	it again).
		1439
		1440	=back
1211		1441
1212	=head2 WATCHER PRIORITY MODELS	1442	=head2 WATCHER PRIORITY MODELS
1213		1443
1214	Many event loops support I<watcher priorities>, which are usually small	1444	Many event loops support I<watcher priorities>, which are usually small
1215	integers that influence the ordering of event callback invocation	1445	integers that influence the ordering of event callback invocation
…		…
1258		1488
1259	For example, to emulate how many other event libraries handle priorities,	1489	For example, to emulate how many other event libraries handle priorities,
1260	you can associate an C<ev_idle> watcher to each such watcher, and in	1490	you can associate an C<ev_idle> watcher to each such watcher, and in
1261	the normal watcher callback, you just start the idle watcher. The real	1491	the normal watcher callback, you just start the idle watcher. The real
1262	processing is done in the idle watcher callback. This causes libev to	1492	processing is done in the idle watcher callback. This causes libev to
1263	continously poll and process kernel event data for the watcher, but when	1493	continuously poll and process kernel event data for the watcher, but when
1264	the lock-out case is known to be rare (which in turn is rare :), this is	1494	the lock-out case is known to be rare (which in turn is rare :), this is
1265	workable.	1495	workable.
1266		1496
1267	Usually, however, the lock-out model implemented that way will perform	1497	Usually, however, the lock-out model implemented that way will perform
1268	miserably under the type of load it was designed to handle. In that case,	1498	miserably under the type of load it was designed to handle. In that case,
…		…
1282	{	1512	{
1283	// stop the I/O watcher, we received the event, but	1513	// stop the I/O watcher, we received the event, but
1284	// are not yet ready to handle it.	1514	// are not yet ready to handle it.
1285	ev_io_stop (EV_A_ w);	1515	ev_io_stop (EV_A_ w);
1286		1516
1287	// start the idle watcher to ahndle the actual event.	1517	// start the idle watcher to handle the actual event.
1288	// it will not be executed as long as other watchers	1518	// it will not be executed as long as other watchers
1289	// with the default priority are receiving events.	1519	// with the default priority are receiving events.
1290	ev_idle_start (EV_A_ &idle);	1520	ev_idle_start (EV_A_ &idle);
1291	}	1521	}
1292		1522
…		…
1342	In general you can register as many read and/or write event watchers per	1572	In general you can register as many read and/or write event watchers per
1343	fd as you want (as long as you don't confuse yourself). Setting all file	1573	fd as you want (as long as you don't confuse yourself). Setting all file
1344	descriptors to non-blocking mode is also usually a good idea (but not	1574	descriptors to non-blocking mode is also usually a good idea (but not
1345	required if you know what you are doing).	1575	required if you know what you are doing).
1346		1576
1347	If you cannot use non-blocking mode, then force the use of a
1348	known-to-be-good backend (at the time of this writing, this includes only
1349	C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>). The same applies to file
1350	descriptors for which non-blocking operation makes no sense (such as
1351	files) - libev doesn't guarentee any specific behaviour in that case.
1352
1353	Another thing you have to watch out for is that it is quite easy to	1577	Another thing you have to watch out for is that it is quite easy to
1354	receive "spurious" readiness notifications, that is your callback might	1578	receive "spurious" readiness notifications, that is, your callback might
1355	be called with C<EV_READ> but a subsequent C<read>(2) will actually block	1579	be called with C<EV_READ> but a subsequent C<read>(2) will actually block
1356	because there is no data. Not only are some backends known to create a	1580	because there is no data. It is very easy to get into this situation even
1357	lot of those (for example Solaris ports), it is very easy to get into	1581	with a relatively standard program structure. Thus it is best to always
1358	this situation even with a relatively standard program structure. Thus	1582	use non-blocking I/O: An extra C<read>(2) returning C<EAGAIN> is far
1359	it is best to always use non-blocking I/O: An extra C<read>(2) returning
1360	C<EAGAIN> is far preferable to a program hanging until some data arrives.	1583	preferable to a program hanging until some data arrives.
1361		1584
1362	If you cannot run the fd in non-blocking mode (for example you should	1585	If you cannot run the fd in non-blocking mode (for example you should
1363	not play around with an Xlib connection), then you have to separately	1586	not play around with an Xlib connection), then you have to separately
1364	re-test whether a file descriptor is really ready with a known-to-be good	1587	re-test whether a file descriptor is really ready with a known-to-be good
1365	interface such as poll (fortunately in our Xlib example, Xlib already	1588	interface such as poll (fortunately in the case of Xlib, it already does
1366	does this on its own, so its quite safe to use). Some people additionally	1589	this on its own, so its quite safe to use). Some people additionally
1367	use C<SIGALRM> and an interval timer, just to be sure you won't block	1590	use C<SIGALRM> and an interval timer, just to be sure you won't block
1368	indefinitely.	1591	indefinitely.
1369		1592
1370	But really, best use non-blocking mode.	1593	But really, best use non-blocking mode.
1371		1594
…		…
1399		1622
1400	There is no workaround possible except not registering events	1623	There is no workaround possible except not registering events
1401	for potentially C<dup ()>'ed file descriptors, or to resort to	1624	for potentially C<dup ()>'ed file descriptors, or to resort to
1402	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.	1625	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1403		1626
		1627	=head3 The special problem of files
		1628
		1629	Many people try to use C<select> (or libev) on file descriptors
		1630	representing files, and expect it to become ready when their program
		1631	doesn't block on disk accesses (which can take a long time on their own).
		1632
		1633	However, this cannot ever work in the "expected" way - you get a readiness
		1634	notification as soon as the kernel knows whether and how much data is
		1635	there, and in the case of open files, that's always the case, so you
		1636	always get a readiness notification instantly, and your read (or possibly
		1637	write) will still block on the disk I/O.
		1638
		1639	Another way to view it is that in the case of sockets, pipes, character
		1640	devices and so on, there is another party (the sender) that delivers data
		1641	on its own, but in the case of files, there is no such thing: the disk
		1642	will not send data on its own, simply because it doesn't know what you
		1643	wish to read - you would first have to request some data.
		1644
		1645	Since files are typically not-so-well supported by advanced notification
		1646	mechanism, libev tries hard to emulate POSIX behaviour with respect
		1647	to files, even though you should not use it. The reason for this is
		1648	convenience: sometimes you want to watch STDIN or STDOUT, which is
		1649	usually a tty, often a pipe, but also sometimes files or special devices
		1650	(for example, C<epoll> on Linux works with F</dev/random> but not with
		1651	F</dev/urandom>), and even though the file might better be served with
		1652	asynchronous I/O instead of with non-blocking I/O, it is still useful when
		1653	it "just works" instead of freezing.
		1654
		1655	So avoid file descriptors pointing to files when you know it (e.g. use
		1656	libeio), but use them when it is convenient, e.g. for STDIN/STDOUT, or
		1657	when you rarely read from a file instead of from a socket, and want to
		1658	reuse the same code path.
		1659
1404	=head3 The special problem of fork	1660	=head3 The special problem of fork
1405		1661
1406	Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit	1662	Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit
1407	useless behaviour. Libev fully supports fork, but needs to be told about	1663	useless behaviour. Libev fully supports fork, but needs to be told about
1408	it in the child.	1664	it in the child if you want to continue to use it in the child.
1409		1665
1410	To support fork in your programs, you either have to call	1666	To support fork in your child processes, you have to call C<ev_loop_fork
1411	C<ev_default_fork ()> or C<ev_loop_fork ()> after a fork in the child,	1667	()> after a fork in the child, enable C<EVFLAG_FORKCHECK>, or resort to
1412	enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or	1668	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1413	C<EVBACKEND_POLL>.
1414		1669
1415	=head3 The special problem of SIGPIPE	1670	=head3 The special problem of SIGPIPE
1416		1671
1417	While not really specific to libev, it is easy to forget about C<SIGPIPE>:	1672	While not really specific to libev, it is easy to forget about C<SIGPIPE>:
1418	when writing to a pipe whose other end has been closed, your program gets	1673	when writing to a pipe whose other end has been closed, your program gets
…		…
1421		1676
1422	So when you encounter spurious, unexplained daemon exits, make sure you	1677	So when you encounter spurious, unexplained daemon exits, make sure you
1423	ignore SIGPIPE (and maybe make sure you log the exit status of your daemon	1678	ignore SIGPIPE (and maybe make sure you log the exit status of your daemon
1424	somewhere, as that would have given you a big clue).	1679	somewhere, as that would have given you a big clue).
1425		1680
		1681	=head3 The special problem of accept()ing when you can't
		1682
		1683	Many implementations of the POSIX C<accept> function (for example,
		1684	found in post-2004 Linux) have the peculiar behaviour of not removing a
		1685	connection from the pending queue in all error cases.
		1686
		1687	For example, larger servers often run out of file descriptors (because
		1688	of resource limits), causing C<accept> to fail with C<ENFILE> but not
		1689	rejecting the connection, leading to libev signalling readiness on
		1690	the next iteration again (the connection still exists after all), and
		1691	typically causing the program to loop at 100% CPU usage.
		1692
		1693	Unfortunately, the set of errors that cause this issue differs between
		1694	operating systems, there is usually little the app can do to remedy the
		1695	situation, and no known thread-safe method of removing the connection to
		1696	cope with overload is known (to me).
		1697
		1698	One of the easiest ways to handle this situation is to just ignore it
		1699	- when the program encounters an overload, it will just loop until the
		1700	situation is over. While this is a form of busy waiting, no OS offers an
		1701	event-based way to handle this situation, so it's the best one can do.
		1702
		1703	A better way to handle the situation is to log any errors other than
		1704	C<EAGAIN> and C<EWOULDBLOCK>, making sure not to flood the log with such
		1705	messages, and continue as usual, which at least gives the user an idea of
		1706	what could be wrong ("raise the ulimit!"). For extra points one could stop
		1707	the C<ev_io> watcher on the listening fd "for a while", which reduces CPU
		1708	usage.
		1709
		1710	If your program is single-threaded, then you could also keep a dummy file
		1711	descriptor for overload situations (e.g. by opening F</dev/null>), and
		1712	when you run into C<ENFILE> or C<EMFILE>, close it, run C<accept>,
		1713	close that fd, and create a new dummy fd. This will gracefully refuse
		1714	clients under typical overload conditions.
		1715
		1716	The last way to handle it is to simply log the error and C<exit>, as
		1717	is often done with C<malloc> failures, but this results in an easy
		1718	opportunity for a DoS attack.
1426		1719
1427	=head3 Watcher-Specific Functions	1720	=head3 Watcher-Specific Functions
1428		1721
1429	=over 4	1722	=over 4
1430		1723
…		…
1462	...	1755	...
1463	struct ev_loop *loop = ev_default_init (0);	1756	struct ev_loop *loop = ev_default_init (0);
1464	ev_io stdin_readable;	1757	ev_io stdin_readable;
1465	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);	1758	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);
1466	ev_io_start (loop, &stdin_readable);	1759	ev_io_start (loop, &stdin_readable);
1467	ev_loop (loop, 0);	1760	ev_run (loop, 0);
1468		1761
1469		1762
1470	=head2 C<ev_timer> - relative and optionally repeating timeouts	1763	=head2 C<ev_timer> - relative and optionally repeating timeouts
1471		1764
1472	Timer watchers are simple relative timers that generate an event after a	1765	Timer watchers are simple relative timers that generate an event after a
…		…
1478	detecting time jumps is hard, and some inaccuracies are unavoidable (the	1771	detecting time jumps is hard, and some inaccuracies are unavoidable (the
1479	monotonic clock option helps a lot here).	1772	monotonic clock option helps a lot here).
1480		1773
1481	The callback is guaranteed to be invoked only I<after> its timeout has	1774	The callback is guaranteed to be invoked only I<after> its timeout has
1482	passed (not I<at>, so on systems with very low-resolution clocks this	1775	passed (not I<at>, so on systems with very low-resolution clocks this
1483	might introduce a small delay). If multiple timers become ready during the	1776	might introduce a small delay, see "the special problem of being too
		1777	early", below). If multiple timers become ready during the same loop
1484	same loop iteration then the ones with earlier time-out values are invoked	1778	iteration then the ones with earlier time-out values are invoked before
1485	before ones with later time-out values (but this is no longer true when a	1779	ones of the same priority with later time-out values (but this is no
1486	callback calls C<ev_loop> recursively).	1780	longer true when a callback calls C<ev_run> recursively).
1487		1781
1488	=head3 Be smart about timeouts	1782	=head3 Be smart about timeouts
1489		1783
1490	Many real-world problems involve some kind of timeout, usually for error	1784	Many real-world problems involve some kind of timeout, usually for error
1491	recovery. A typical example is an HTTP request - if the other side hangs,	1785	recovery. A typical example is an HTTP request - if the other side hangs,
…		…
1577	ev_tstamp timeout = last_activity + 60.;	1871	ev_tstamp timeout = last_activity + 60.;
1578		1872
1579	// if last_activity + 60. is older than now, we did time out	1873	// if last_activity + 60. is older than now, we did time out
1580	if (timeout < now)	1874	if (timeout < now)
1581	{	1875	{
1582	// timeout occured, take action	1876	// timeout occurred, take action
1583	}	1877	}
1584	else	1878	else
1585	{	1879	{
1586	// callback was invoked, but there was some activity, re-arm	1880	// callback was invoked, but there was some activity, re-arm
1587	// the watcher to fire in last_activity + 60, which is	1881	// the watcher to fire in last_activity + 60, which is
…		…
1609	to the current time (meaning we just have some activity :), then call the	1903	to the current time (meaning we just have some activity :), then call the
1610	callback, which will "do the right thing" and start the timer:	1904	callback, which will "do the right thing" and start the timer:
1611		1905
1612	ev_init (timer, callback);	1906	ev_init (timer, callback);
1613	last_activity = ev_now (loop);	1907	last_activity = ev_now (loop);
1614	callback (loop, timer, EV_TIMEOUT);	1908	callback (loop, timer, EV_TIMER);
1615		1909
1616	And when there is some activity, simply store the current time in	1910	And when there is some activity, simply store the current time in
1617	C<last_activity>, no libev calls at all:	1911	C<last_activity>, no libev calls at all:
1618		1912
1619	last_actiivty = ev_now (loop);	1913	last_activity = ev_now (loop);
1620		1914
1621	This technique is slightly more complex, but in most cases where the	1915	This technique is slightly more complex, but in most cases where the
1622	time-out is unlikely to be triggered, much more efficient.	1916	time-out is unlikely to be triggered, much more efficient.
1623		1917
1624	Changing the timeout is trivial as well (if it isn't hard-coded in the	1918	Changing the timeout is trivial as well (if it isn't hard-coded in the
…		…
1658	Method #1 is almost always a bad idea, and buys you nothing. Method #4 is	1952	Method #1 is almost always a bad idea, and buys you nothing. Method #4 is
1659	rather complicated, but extremely efficient, something that really pays	1953	rather complicated, but extremely efficient, something that really pays
1660	off after the first million or so of active timers, i.e. it's usually	1954	off after the first million or so of active timers, i.e. it's usually
1661	overkill :)	1955	overkill :)
1662		1956
		1957	=head3 The special problem of being too early
		1958
		1959	If you ask a timer to call your callback after three seconds, then
		1960	you expect it to be invoked after three seconds - but of course, this
		1961	cannot be guaranteed to infinite precision. Less obviously, it cannot be
		1962	guaranteed to any precision by libev - imagine somebody suspending the
		1963	process a STOP signal for a few hours for example.
		1964
		1965	So, libev tries to invoke your callback as soon as possible I<after> the
		1966	delay has occurred, but cannot guarantee this.
		1967
		1968	A less obvious failure mode is calling your callback too early: many event
		1969	loops compare timestamps with a "elapsed delay >= requested delay", but
		1970	this can cause your callback to be invoked much earlier than you would
		1971	expect.
		1972
		1973	To see why, imagine a system with a clock that only offers full second
		1974	resolution (think windows if you can't come up with a broken enough OS
		1975	yourself). If you schedule a one-second timer at the time 500.9, then the
		1976	event loop will schedule your timeout to elapse at a system time of 500
		1977	(500.9 truncated to the resolution) + 1, or 501.
		1978
		1979	If an event library looks at the timeout 0.1s later, it will see "501 >=
		1980	501" and invoke the callback 0.1s after it was started, even though a
		1981	one-second delay was requested - this is being "too early", despite best
		1982	intentions.
		1983
		1984	This is the reason why libev will never invoke the callback if the elapsed
		1985	delay equals the requested delay, but only when the elapsed delay is
		1986	larger than the requested delay. In the example above, libev would only invoke
		1987	the callback at system time 502, or 1.1s after the timer was started.
		1988
		1989	So, while libev cannot guarantee that your callback will be invoked
		1990	exactly when requested, it I<can> and I<does> guarantee that the requested
		1991	delay has actually elapsed, or in other words, it always errs on the "too
		1992	late" side of things.
		1993
1663	=head3 The special problem of time updates	1994	=head3 The special problem of time updates
1664		1995
1665	Establishing the current time is a costly operation (it usually takes at	1996	Establishing the current time is a costly operation (it usually takes
1666	least two system calls): EV therefore updates its idea of the current	1997	at least one system call): EV therefore updates its idea of the current
1667	time only before and after C<ev_loop> collects new events, which causes a	1998	time only before and after C<ev_run> collects new events, which causes a
1668	growing difference between C<ev_now ()> and C<ev_time ()> when handling	1999	growing difference between C<ev_now ()> and C<ev_time ()> when handling
1669	lots of events in one iteration.	2000	lots of events in one iteration.
1670		2001
1671	The relative timeouts are calculated relative to the C<ev_now ()>	2002	The relative timeouts are calculated relative to the C<ev_now ()>
1672	time. This is usually the right thing as this timestamp refers to the time	2003	time. This is usually the right thing as this timestamp refers to the time
…		…
1678		2009
1679	If the event loop is suspended for a long time, you can also force an	2010	If the event loop is suspended for a long time, you can also force an
1680	update of the time returned by C<ev_now ()> by calling C<ev_now_update	2011	update of the time returned by C<ev_now ()> by calling C<ev_now_update
1681	()>.	2012	()>.
1682		2013
		2014	=head3 The special problem of unsynchronised clocks
		2015
		2016	Modern systems have a variety of clocks - libev itself uses the normal
		2017	"wall clock" clock and, if available, the monotonic clock (to avoid time
		2018	jumps).
		2019
		2020	Neither of these clocks is synchronised with each other or any other clock
		2021	on the system, so C<ev_time ()> might return a considerably different time
		2022	than C<gettimeofday ()> or C<time ()>. On a GNU/Linux system, for example,
		2023	a call to C<gettimeofday> might return a second count that is one higher
		2024	than a directly following call to C<time>.
		2025
		2026	The moral of this is to only compare libev-related timestamps with
		2027	C<ev_time ()> and C<ev_now ()>, at least if you want better precision than
		2028	a second or so.
		2029
		2030	One more problem arises due to this lack of synchronisation: if libev uses
		2031	the system monotonic clock and you compare timestamps from C<ev_time>
		2032	or C<ev_now> from when you started your timer and when your callback is
		2033	invoked, you will find that sometimes the callback is a bit "early".
		2034
		2035	This is because C<ev_timer>s work in real time, not wall clock time, so
		2036	libev makes sure your callback is not invoked before the delay happened,
		2037	I<measured according to the real time>, not the system clock.
		2038
		2039	If your timeouts are based on a physical timescale (e.g. "time out this
		2040	connection after 100 seconds") then this shouldn't bother you as it is
		2041	exactly the right behaviour.
		2042
		2043	If you want to compare wall clock/system timestamps to your timers, then
		2044	you need to use C<ev_periodic>s, as these are based on the wall clock
		2045	time, where your comparisons will always generate correct results.
		2046
		2047	=head3 The special problems of suspended animation
		2048
		2049	When you leave the server world it is quite customary to hit machines that
		2050	can suspend/hibernate - what happens to the clocks during such a suspend?
		2051
		2052	Some quick tests made with a Linux 2.6.28 indicate that a suspend freezes
		2053	all processes, while the clocks (C<times>, C<CLOCK_MONOTONIC>) continue
		2054	to run until the system is suspended, but they will not advance while the
		2055	system is suspended. That means, on resume, it will be as if the program
		2056	was frozen for a few seconds, but the suspend time will not be counted
		2057	towards C<ev_timer> when a monotonic clock source is used. The real time
		2058	clock advanced as expected, but if it is used as sole clocksource, then a
		2059	long suspend would be detected as a time jump by libev, and timers would
		2060	be adjusted accordingly.
		2061
		2062	I would not be surprised to see different behaviour in different between
		2063	operating systems, OS versions or even different hardware.
		2064
		2065	The other form of suspend (job control, or sending a SIGSTOP) will see a
		2066	time jump in the monotonic clocks and the realtime clock. If the program
		2067	is suspended for a very long time, and monotonic clock sources are in use,
		2068	then you can expect C<ev_timer>s to expire as the full suspension time
		2069	will be counted towards the timers. When no monotonic clock source is in
		2070	use, then libev will again assume a timejump and adjust accordingly.
		2071
		2072	It might be beneficial for this latter case to call C<ev_suspend>
		2073	and C<ev_resume> in code that handles C<SIGTSTP>, to at least get
		2074	deterministic behaviour in this case (you can do nothing against
		2075	C<SIGSTOP>).
		2076
1683	=head3 Watcher-Specific Functions and Data Members	2077	=head3 Watcher-Specific Functions and Data Members
1684		2078
1685	=over 4	2079	=over 4
1686		2080
1687	=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)	2081	=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
…		…
1700	keep up with the timer (because it takes longer than those 10 seconds to	2094	keep up with the timer (because it takes longer than those 10 seconds to
1701	do stuff) the timer will not fire more than once per event loop iteration.	2095	do stuff) the timer will not fire more than once per event loop iteration.
1702		2096
1703	=item ev_timer_again (loop, ev_timer *)	2097	=item ev_timer_again (loop, ev_timer *)
1704		2098
1705	This will act as if the timer timed out and restart it again if it is	2099	This will act as if the timer timed out and restarts it again if it is
1706	repeating. The exact semantics are:	2100	repeating. The exact semantics are:
1707		2101
1708	If the timer is pending, its pending status is cleared.	2102	If the timer is pending, its pending status is cleared.
1709		2103
1710	If the timer is started but non-repeating, stop it (as if it timed out).	2104	If the timer is started but non-repeating, stop it (as if it timed out).
…		…
1712	If the timer is repeating, either start it if necessary (with the	2106	If the timer is repeating, either start it if necessary (with the
1713	C<repeat> value), or reset the running timer to the C<repeat> value.	2107	C<repeat> value), or reset the running timer to the C<repeat> value.
1714		2108
1715	This sounds a bit complicated, see L<Be smart about timeouts>, above, for a	2109	This sounds a bit complicated, see L<Be smart about timeouts>, above, for a
1716	usage example.	2110	usage example.
		2111
		2112	=item ev_tstamp ev_timer_remaining (loop, ev_timer *)
		2113
		2114	Returns the remaining time until a timer fires. If the timer is active,
		2115	then this time is relative to the current event loop time, otherwise it's
		2116	the timeout value currently configured.
		2117
		2118	That is, after an C<ev_timer_set (w, 5, 7)>, C<ev_timer_remaining> returns
		2119	C<5>. When the timer is started and one second passes, C<ev_timer_remaining>
		2120	will return C<4>. When the timer expires and is restarted, it will return
		2121	roughly C<7> (likely slightly less as callback invocation takes some time,
		2122	too), and so on.
1717		2123
1718	=item ev_tstamp repeat [read-write]	2124	=item ev_tstamp repeat [read-write]
1719		2125
1720	The current C<repeat> value. Will be used each time the watcher times out	2126	The current C<repeat> value. Will be used each time the watcher times out
1721	or C<ev_timer_again> is called, and determines the next timeout (if any),	2127	or C<ev_timer_again> is called, and determines the next timeout (if any),
…		…
1747	}	2153	}
1748		2154
1749	ev_timer mytimer;	2155	ev_timer mytimer;
1750	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */	2156	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */
1751	ev_timer_again (&mytimer); /* start timer */	2157	ev_timer_again (&mytimer); /* start timer */
1752	ev_loop (loop, 0);	2158	ev_run (loop, 0);
1753		2159
1754	// and in some piece of code that gets executed on any "activity":	2160	// and in some piece of code that gets executed on any "activity":
1755	// reset the timeout to start ticking again at 10 seconds	2161	// reset the timeout to start ticking again at 10 seconds
1756	ev_timer_again (&mytimer);	2162	ev_timer_again (&mytimer);
1757		2163
…		…
1783		2189
1784	As with timers, the callback is guaranteed to be invoked only when the	2190	As with timers, the callback is guaranteed to be invoked only when the
1785	point in time where it is supposed to trigger has passed. If multiple	2191	point in time where it is supposed to trigger has passed. If multiple
1786	timers become ready during the same loop iteration then the ones with	2192	timers become ready during the same loop iteration then the ones with
1787	earlier time-out values are invoked before ones with later time-out values	2193	earlier time-out values are invoked before ones with later time-out values
1788	(but this is no longer true when a callback calls C<ev_loop> recursively).	2194	(but this is no longer true when a callback calls C<ev_run> recursively).
1789		2195
1790	=head3 Watcher-Specific Functions and Data Members	2196	=head3 Watcher-Specific Functions and Data Members
1791		2197
1792	=over 4	2198	=over 4
1793		2199
…		…
1828		2234
1829	Another way to think about it (for the mathematically inclined) is that	2235	Another way to think about it (for the mathematically inclined) is that
1830	C<ev_periodic> will try to run the callback in this mode at the next possible	2236	C<ev_periodic> will try to run the callback in this mode at the next possible
1831	time where C<time = offset (mod interval)>, regardless of any time jumps.	2237	time where C<time = offset (mod interval)>, regardless of any time jumps.
1832		2238
1833	For numerical stability it is preferable that the C<offset> value is near	2239	The C<interval> I<MUST> be positive, and for numerical stability, the
1834	C<ev_now ()> (the current time), but there is no range requirement for	2240	interval value should be higher than C<1/8192> (which is around 100
1835	this value, and in fact is often specified as zero.	2241	microseconds) and C<offset> should be higher than C<0> and should have
		2242	at most a similar magnitude as the current time (say, within a factor of
		2243	ten). Typical values for offset are, in fact, C<0> or something between
		2244	C<0> and C<interval>, which is also the recommended range.
1836		2245
1837	Note also that there is an upper limit to how often a timer can fire (CPU	2246	Note also that there is an upper limit to how often a timer can fire (CPU
1838	speed for example), so if C<interval> is very small then timing stability	2247	speed for example), so if C<interval> is very small then timing stability
1839	will of course deteriorate. Libev itself tries to be exact to be about one	2248	will of course deteriorate. Libev itself tries to be exact to be about one
1840	millisecond (if the OS supports it and the machine is fast enough).	2249	millisecond (if the OS supports it and the machine is fast enough).
…		…
1921	Example: Call a callback every hour, or, more precisely, whenever the	2330	Example: Call a callback every hour, or, more precisely, whenever the
1922	system time is divisible by 3600. The callback invocation times have	2331	system time is divisible by 3600. The callback invocation times have
1923	potentially a lot of jitter, but good long-term stability.	2332	potentially a lot of jitter, but good long-term stability.
1924		2333
1925	static void	2334	static void
1926	clock_cb (struct ev_loop *loop, ev_io *w, int revents)	2335	clock_cb (struct ev_loop *loop, ev_periodic *w, int revents)
1927	{	2336	{
1928	... its now a full hour (UTC, or TAI or whatever your clock follows)	2337	... its now a full hour (UTC, or TAI or whatever your clock follows)
1929	}	2338	}
1930		2339
1931	ev_periodic hourly_tick;	2340	ev_periodic hourly_tick;
…		…
1954		2363
1955	=head2 C<ev_signal> - signal me when a signal gets signalled!	2364	=head2 C<ev_signal> - signal me when a signal gets signalled!
1956		2365
1957	Signal watchers will trigger an event when the process receives a specific	2366	Signal watchers will trigger an event when the process receives a specific
1958	signal one or more times. Even though signals are very asynchronous, libev	2367	signal one or more times. Even though signals are very asynchronous, libev
1959	will try it's best to deliver signals synchronously, i.e. as part of the	2368	will try its best to deliver signals synchronously, i.e. as part of the
1960	normal event processing, like any other event.	2369	normal event processing, like any other event.
1961		2370
1962	If you want signals asynchronously, just use C<sigaction> as you would	2371	If you want signals to be delivered truly asynchronously, just use
1963	do without libev and forget about sharing the signal. You can even use	2372	C<sigaction> as you would do without libev and forget about sharing
1964	C<ev_async> from a signal handler to synchronously wake up an event loop.	2373	the signal. You can even use C<ev_async> from a signal handler to
		2374	synchronously wake up an event loop.
1965		2375
1966	You can configure as many watchers as you like per signal. Only when the	2376	You can configure as many watchers as you like for the same signal, but
		2377	only within the same loop, i.e. you can watch for C<SIGINT> in your
		2378	default loop and for C<SIGIO> in another loop, but you cannot watch for
		2379	C<SIGINT> in both the default loop and another loop at the same time. At
		2380	the moment, C<SIGCHLD> is permanently tied to the default loop.
		2381
1967	first watcher gets started will libev actually register a signal handler	2382	When the first watcher gets started will libev actually register something
1968	with the kernel (thus it coexists with your own signal handlers as long as	2383	with the kernel (thus it coexists with your own signal handlers as long as
1969	you don't register any with libev for the same signal). Similarly, when	2384	you don't register any with libev for the same signal).
1970	the last signal watcher for a signal is stopped, libev will reset the
1971	signal handler to SIG_DFL (regardless of what it was set to before).
1972		2385
1973	If possible and supported, libev will install its handlers with	2386	If possible and supported, libev will install its handlers with
1974	C<SA_RESTART> behaviour enabled, so system calls should not be unduly	2387	C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should
1975	interrupted. If you have a problem with system calls getting interrupted by	2388	not be unduly interrupted. If you have a problem with system calls getting
1976	signals you can block all signals in an C<ev_check> watcher and unblock	2389	interrupted by signals you can block all signals in an C<ev_check> watcher
1977	them in an C<ev_prepare> watcher.	2390	and unblock them in an C<ev_prepare> watcher.
		2391
		2392	=head3 The special problem of inheritance over fork/execve/pthread_create
		2393
		2394	Both the signal mask (C<sigprocmask>) and the signal disposition
		2395	(C<sigaction>) are unspecified after starting a signal watcher (and after
		2396	stopping it again), that is, libev might or might not block the signal,
		2397	and might or might not set or restore the installed signal handler (but
		2398	see C<EVFLAG_NOSIGMASK>).
		2399
		2400	While this does not matter for the signal disposition (libev never
		2401	sets signals to C<SIG_IGN>, so handlers will be reset to C<SIG_DFL> on
		2402	C<execve>), this matters for the signal mask: many programs do not expect
		2403	certain signals to be blocked.
		2404
		2405	This means that before calling C<exec> (from the child) you should reset
		2406	the signal mask to whatever "default" you expect (all clear is a good
		2407	choice usually).
		2408
		2409	The simplest way to ensure that the signal mask is reset in the child is
		2410	to install a fork handler with C<pthread_atfork> that resets it. That will
		2411	catch fork calls done by libraries (such as the libc) as well.
		2412
		2413	In current versions of libev, the signal will not be blocked indefinitely
		2414	unless you use the C<signalfd> API (C<EV_SIGNALFD>). While this reduces
		2415	the window of opportunity for problems, it will not go away, as libev
		2416	I<has> to modify the signal mask, at least temporarily.
		2417
		2418	So I can't stress this enough: I<If you do not reset your signal mask when
		2419	you expect it to be empty, you have a race condition in your code>. This
		2420	is not a libev-specific thing, this is true for most event libraries.
		2421
		2422	=head3 The special problem of threads signal handling
		2423
		2424	POSIX threads has problematic signal handling semantics, specifically,
		2425	a lot of functionality (sigfd, sigwait etc.) only really works if all
		2426	threads in a process block signals, which is hard to achieve.
		2427
		2428	When you want to use sigwait (or mix libev signal handling with your own
		2429	for the same signals), you can tackle this problem by globally blocking
		2430	all signals before creating any threads (or creating them with a fully set
		2431	sigprocmask) and also specifying the C<EVFLAG_NOSIGMASK> when creating
		2432	loops. Then designate one thread as "signal receiver thread" which handles
		2433	these signals. You can pass on any signals that libev might be interested
		2434	in by calling C<ev_feed_signal>.
1978		2435
1979	=head3 Watcher-Specific Functions and Data Members	2436	=head3 Watcher-Specific Functions and Data Members
1980		2437
1981	=over 4	2438	=over 4
1982		2439
…		…
1998	Example: Try to exit cleanly on SIGINT.	2455	Example: Try to exit cleanly on SIGINT.
1999		2456
2000	static void	2457	static void
2001	sigint_cb (struct ev_loop *loop, ev_signal *w, int revents)	2458	sigint_cb (struct ev_loop *loop, ev_signal *w, int revents)
2002	{	2459	{
2003	ev_unloop (loop, EVUNLOOP_ALL);	2460	ev_break (loop, EVBREAK_ALL);
2004	}	2461	}
2005		2462
2006	ev_signal signal_watcher;	2463	ev_signal signal_watcher;
2007	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);	2464	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
2008	ev_signal_start (loop, &signal_watcher);	2465	ev_signal_start (loop, &signal_watcher);
…		…
2020	in the next callback invocation is not.	2477	in the next callback invocation is not.
2021		2478
2022	Only the default event loop is capable of handling signals, and therefore	2479	Only the default event loop is capable of handling signals, and therefore
2023	you can only register child watchers in the default event loop.	2480	you can only register child watchers in the default event loop.
2024		2481
		2482	Due to some design glitches inside libev, child watchers will always be
		2483	handled at maximum priority (their priority is set to C<EV_MAXPRI> by
		2484	libev)
		2485
2025	=head3 Process Interaction	2486	=head3 Process Interaction
2026		2487
2027	Libev grabs C<SIGCHLD> as soon as the default event loop is	2488	Libev grabs C<SIGCHLD> as soon as the default event loop is
2028	initialised. This is necessary to guarantee proper behaviour even if	2489	initialised. This is necessary to guarantee proper behaviour even if the
2029	the first child watcher is started after the child exits. The occurrence	2490	first child watcher is started after the child exits. The occurrence
2030	of C<SIGCHLD> is recorded asynchronously, but child reaping is done	2491	of C<SIGCHLD> is recorded asynchronously, but child reaping is done
2031	synchronously as part of the event loop processing. Libev always reaps all	2492	synchronously as part of the event loop processing. Libev always reaps all
2032	children, even ones not watched.	2493	children, even ones not watched.
2033		2494
2034	=head3 Overriding the Built-In Processing	2495	=head3 Overriding the Built-In Processing
…		…
2044	=head3 Stopping the Child Watcher	2505	=head3 Stopping the Child Watcher
2045		2506
2046	Currently, the child watcher never gets stopped, even when the	2507	Currently, the child watcher never gets stopped, even when the
2047	child terminates, so normally one needs to stop the watcher in the	2508	child terminates, so normally one needs to stop the watcher in the
2048	callback. Future versions of libev might stop the watcher automatically	2509	callback. Future versions of libev might stop the watcher automatically
2049	when a child exit is detected.	2510	when a child exit is detected (calling C<ev_child_stop> twice is not a
		2511	problem).
2050		2512
2051	=head3 Watcher-Specific Functions and Data Members	2513	=head3 Watcher-Specific Functions and Data Members
2052		2514
2053	=over 4	2515	=over 4
2054		2516
…		…
2389		2851
2390	Prepare and check watchers are usually (but not always) used in pairs:	2852	Prepare and check watchers are usually (but not always) used in pairs:
2391	prepare watchers get invoked before the process blocks and check watchers	2853	prepare watchers get invoked before the process blocks and check watchers
2392	afterwards.	2854	afterwards.
2393		2855
2394	You I<must not> call C<ev_loop> or similar functions that enter	2856	You I<must not> call C<ev_run> or similar functions that enter
2395	the current event loop from either C<ev_prepare> or C<ev_check>	2857	the current event loop from either C<ev_prepare> or C<ev_check>
2396	watchers. Other loops than the current one are fine, however. The	2858	watchers. Other loops than the current one are fine, however. The
2397	rationale behind this is that you do not need to check for recursion in	2859	rationale behind this is that you do not need to check for recursion in
2398	those watchers, i.e. the sequence will always be C<ev_prepare>, blocking,	2860	those watchers, i.e. the sequence will always be C<ev_prepare>, blocking,
2399	C<ev_check> so if you have one watcher of each kind they will always be	2861	C<ev_check> so if you have one watcher of each kind they will always be
…		…
2567		3029
2568	if (timeout >= 0)	3030	if (timeout >= 0)
2569	// create/start timer	3031	// create/start timer
2570		3032
2571	// poll	3033	// poll
2572	ev_loop (EV_A_ 0);	3034	ev_run (EV_A_ 0);
2573		3035
2574	// stop timer again	3036	// stop timer again
2575	if (timeout >= 0)	3037	if (timeout >= 0)
2576	ev_timer_stop (EV_A_ &to);	3038	ev_timer_stop (EV_A_ &to);
2577		3039
…		…
2655	if you do not want that, you need to temporarily stop the embed watcher).	3117	if you do not want that, you need to temporarily stop the embed watcher).
2656		3118
2657	=item ev_embed_sweep (loop, ev_embed *)	3119	=item ev_embed_sweep (loop, ev_embed *)
2658		3120
2659	Make a single, non-blocking sweep over the embedded loop. This works	3121	Make a single, non-blocking sweep over the embedded loop. This works
2660	similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most	3122	similarly to C<ev_run (embedded_loop, EVRUN_NOWAIT)>, but in the most
2661	appropriate way for embedded loops.	3123	appropriate way for embedded loops.
2662		3124
2663	=item struct ev_loop *other [read-only]	3125	=item struct ev_loop *other [read-only]
2664		3126
2665	The embedded event loop.	3127	The embedded event loop.
…		…
2725	C<ev_default_fork> cheats and calls it in the wrong process, the fork	3187	C<ev_default_fork> cheats and calls it in the wrong process, the fork
2726	handlers will be invoked, too, of course.	3188	handlers will be invoked, too, of course.
2727		3189
2728	=head3 The special problem of life after fork - how is it possible?	3190	=head3 The special problem of life after fork - how is it possible?
2729		3191
2730	Most uses of C<fork()> consist of forking, then some simple calls to ste	3192	Most uses of C<fork()> consist of forking, then some simple calls to set
2731	up/change the process environment, followed by a call to C<exec()>. This	3193	up/change the process environment, followed by a call to C<exec()>. This
2732	sequence should be handled by libev without any problems.	3194	sequence should be handled by libev without any problems.
2733		3195
2734	This changes when the application actually wants to do event handling	3196	This changes when the application actually wants to do event handling
2735	in the child, or both parent in child, in effect "continuing" after the	3197	in the child, or both parent in child, in effect "continuing" after the
…		…
2751	disadvantage of having to use multiple event loops (which do not support	3213	disadvantage of having to use multiple event loops (which do not support
2752	signal watchers).	3214	signal watchers).
2753		3215
2754	When this is not possible, or you want to use the default loop for	3216	When this is not possible, or you want to use the default loop for
2755	other reasons, then in the process that wants to start "fresh", call	3217	other reasons, then in the process that wants to start "fresh", call
2756	C<ev_default_destroy ()> followed by C<ev_default_loop (...)>. Destroying	3218	C<ev_loop_destroy (EV_DEFAULT)> followed by C<ev_default_loop (...)>.
2757	the default loop will "orphan" (not stop) all registered watchers, so you	3219	Destroying the default loop will "orphan" (not stop) all registered
2758	have to be careful not to execute code that modifies those watchers. Note	3220	watchers, so you have to be careful not to execute code that modifies
2759	also that in that case, you have to re-register any signal watchers.	3221	those watchers. Note also that in that case, you have to re-register any
		3222	signal watchers.
2760		3223
2761	=head3 Watcher-Specific Functions and Data Members	3224	=head3 Watcher-Specific Functions and Data Members
2762		3225
2763	=over 4	3226	=over 4
2764		3227
2765	=item ev_fork_init (ev_signal *, callback)	3228	=item ev_fork_init (ev_fork *, callback)
2766		3229
2767	Initialises and configures the fork watcher - it has no parameters of any	3230	Initialises and configures the fork watcher - it has no parameters of any
2768	kind. There is a C<ev_fork_set> macro, but using it is utterly pointless,	3231	kind. There is a C<ev_fork_set> macro, but using it is utterly pointless,
2769	believe me.	3232	really.
2770		3233
2771	=back	3234	=back
2772		3235
2773		3236
		3237	=head2 C<ev_cleanup> - even the best things end
		3238
		3239	Cleanup watchers are called just before the event loop is being destroyed
		3240	by a call to C<ev_loop_destroy>.
		3241
		3242	While there is no guarantee that the event loop gets destroyed, cleanup
		3243	watchers provide a convenient method to install cleanup hooks for your
		3244	program, worker threads and so on - you just to make sure to destroy the
		3245	loop when you want them to be invoked.
		3246
		3247	Cleanup watchers are invoked in the same way as any other watcher. Unlike
		3248	all other watchers, they do not keep a reference to the event loop (which
		3249	makes a lot of sense if you think about it). Like all other watchers, you
		3250	can call libev functions in the callback, except C<ev_cleanup_start>.
		3251
		3252	=head3 Watcher-Specific Functions and Data Members
		3253
		3254	=over 4
		3255
		3256	=item ev_cleanup_init (ev_cleanup *, callback)
		3257
		3258	Initialises and configures the cleanup watcher - it has no parameters of
		3259	any kind. There is a C<ev_cleanup_set> macro, but using it is utterly
		3260	pointless, I assure you.
		3261
		3262	=back
		3263
		3264	Example: Register an atexit handler to destroy the default loop, so any
		3265	cleanup functions are called.
		3266
		3267	static void
		3268	program_exits (void)
		3269	{
		3270	ev_loop_destroy (EV_DEFAULT_UC);
		3271	}
		3272
		3273	...
		3274	atexit (program_exits);
		3275
		3276
2774	=head2 C<ev_async> - how to wake up another event loop	3277	=head2 C<ev_async> - how to wake up an event loop
2775		3278
2776	In general, you cannot use an C<ev_loop> from multiple threads or other	3279	In general, you cannot use an C<ev_loop> from multiple threads or other
2777	asynchronous sources such as signal handlers (as opposed to multiple event	3280	asynchronous sources such as signal handlers (as opposed to multiple event
2778	loops - those are of course safe to use in different threads).	3281	loops - those are of course safe to use in different threads).
2779		3282
2780	Sometimes, however, you need to wake up another event loop you do not	3283	Sometimes, however, you need to wake up an event loop you do not control,
2781	control, for example because it belongs to another thread. This is what	3284	for example because it belongs to another thread. This is what C<ev_async>
2782	C<ev_async> watchers do: as long as the C<ev_async> watcher is active, you	3285	watchers do: as long as the C<ev_async> watcher is active, you can signal
2783	can signal it by calling C<ev_async_send>, which is thread- and signal	3286	it by calling C<ev_async_send>, which is thread- and signal safe.
2784	safe.
2785		3287
2786	This functionality is very similar to C<ev_signal> watchers, as signals,	3288	This functionality is very similar to C<ev_signal> watchers, as signals,
2787	too, are asynchronous in nature, and signals, too, will be compressed	3289	too, are asynchronous in nature, and signals, too, will be compressed
2788	(i.e. the number of callback invocations may be less than the number of	3290	(i.e. the number of callback invocations may be less than the number of
2789	C<ev_async_sent> calls).	3291	C<ev_async_sent> calls). In fact, you could use signal watchers as a kind
2790		3292	of "global async watchers" by using a watcher on an otherwise unused
2791	Unlike C<ev_signal> watchers, C<ev_async> works with any event loop, not	3293	signal, and C<ev_feed_signal> to signal this watcher from another thread,
2792	just the default loop.	3294	even without knowing which loop owns the signal.
2793		3295
2794	=head3 Queueing	3296	=head3 Queueing
2795		3297
2796	C<ev_async> does not support queueing of data in any way. The reason	3298	C<ev_async> does not support queueing of data in any way. The reason
2797	is that the author does not know of a simple (or any) algorithm for a	3299	is that the author does not know of a simple (or any) algorithm for a
2798	multiple-writer-single-reader queue that works in all cases and doesn't	3300	multiple-writer-single-reader queue that works in all cases and doesn't
2799	need elaborate support such as pthreads.	3301	need elaborate support such as pthreads or unportable memory access
		3302	semantics.
2800		3303
2801	That means that if you want to queue data, you have to provide your own	3304	That means that if you want to queue data, you have to provide your own
2802	queue. But at least I can tell you how to implement locking around your	3305	queue. But at least I can tell you how to implement locking around your
2803	queue:	3306	queue:
2804		3307
…		…
2888	trust me.	3391	trust me.
2889		3392
2890	=item ev_async_send (loop, ev_async *)	3393	=item ev_async_send (loop, ev_async *)
2891		3394
2892	Sends/signals/activates the given C<ev_async> watcher, that is, feeds	3395	Sends/signals/activates the given C<ev_async> watcher, that is, feeds
2893	an C<EV_ASYNC> event on the watcher into the event loop. Unlike	3396	an C<EV_ASYNC> event on the watcher into the event loop, and instantly
		3397	returns.
		3398
2894	C<ev_feed_event>, this call is safe to do from other threads, signal or	3399	Unlike C<ev_feed_event>, this call is safe to do from other threads,
2895	similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding	3400	signal or similar contexts (see the discussion of C<EV_ATOMIC_T> in the
2896	section below on what exactly this means).	3401	embedding section below on what exactly this means).
2897		3402
2898	Note that, as with other watchers in libev, multiple events might get	3403	Note that, as with other watchers in libev, multiple events might get
2899	compressed into a single callback invocation (another way to look at this	3404	compressed into a single callback invocation (another way to look at
2900	is that C<ev_async> watchers are level-triggered, set on C<ev_async_send>,	3405	this is that C<ev_async> watchers are level-triggered: they are set on
2901	reset when the event loop detects that).	3406	C<ev_async_send>, reset when the event loop detects that).
2902		3407
2903	This call incurs the overhead of a system call only once per event loop	3408	This call incurs the overhead of at most one extra system call per event
2904	iteration, so while the overhead might be noticeable, it doesn't apply to	3409	loop iteration, if the event loop is blocked, and no syscall at all if
2905	repeated calls to C<ev_async_send> for the same event loop.	3410	the event loop (or your program) is processing events. That means that
		3411	repeated calls are basically free (there is no need to avoid calls for
		3412	performance reasons) and that the overhead becomes smaller (typically
		3413	zero) under load.
2906		3414
2907	=item bool = ev_async_pending (ev_async *)	3415	=item bool = ev_async_pending (ev_async *)
2908		3416
2909	Returns a non-zero value when C<ev_async_send> has been called on the	3417	Returns a non-zero value when C<ev_async_send> has been called on the
2910	watcher but the event has not yet been processed (or even noted) by the	3418	watcher but the event has not yet been processed (or even noted) by the
…		…
2943		3451
2944	If C<timeout> is less than 0, then no timeout watcher will be	3452	If C<timeout> is less than 0, then no timeout watcher will be
2945	started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and	3453	started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and
2946	repeat = 0) will be started. C<0> is a valid timeout.	3454	repeat = 0) will be started. C<0> is a valid timeout.
2947		3455
2948	The callback has the type C<void (*cb)(int revents, void *arg)> and gets	3456	The callback has the type C<void (*cb)(int revents, void *arg)> and is
2949	passed an C<revents> set like normal event callbacks (a combination of	3457	passed an C<revents> set like normal event callbacks (a combination of
2950	C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg>	3458	C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMER>) and the C<arg>
2951	value passed to C<ev_once>. Note that it is possible to receive I<both>	3459	value passed to C<ev_once>. Note that it is possible to receive I<both>
2952	a timeout and an io event at the same time - you probably should give io	3460	a timeout and an io event at the same time - you probably should give io
2953	events precedence.	3461	events precedence.
2954		3462
2955	Example: wait up to ten seconds for data to appear on STDIN_FILENO.	3463	Example: wait up to ten seconds for data to appear on STDIN_FILENO.
2956		3464
2957	static void stdin_ready (int revents, void *arg)	3465	static void stdin_ready (int revents, void *arg)
2958	{	3466	{
2959	if (revents & EV_READ)	3467	if (revents & EV_READ)
2960	/* stdin might have data for us, joy! */;	3468	/* stdin might have data for us, joy! */;
2961	else if (revents & EV_TIMEOUT)	3469	else if (revents & EV_TIMER)
2962	/* doh, nothing entered */;	3470	/* doh, nothing entered */;
2963	}	3471	}
2964		3472
2965	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);	3473	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
2966		3474
2967	=item ev_feed_event (struct ev_loop *, watcher *, int revents)
2968
2969	Feeds the given event set into the event loop, as if the specified event
2970	had happened for the specified watcher (which must be a pointer to an
2971	initialised but not necessarily started event watcher).
2972
2973	=item ev_feed_fd_event (struct ev_loop *, int fd, int revents)	3475	=item ev_feed_fd_event (loop, int fd, int revents)
2974		3476
2975	Feed an event on the given fd, as if a file descriptor backend detected	3477	Feed an event on the given fd, as if a file descriptor backend detected
2976	the given events it.	3478	the given events it.
2977		3479
2978	=item ev_feed_signal_event (struct ev_loop *loop, int signum)	3480	=item ev_feed_signal_event (loop, int signum)
2979		3481
2980	Feed an event as if the given signal occurred (C<loop> must be the default	3482	Feed an event as if the given signal occurred. See also C<ev_feed_signal>,
2981	loop!).	3483	which is async-safe.
2982		3484
2983	=back	3485	=back
		3486
		3487
		3488	=head1 COMMON OR USEFUL IDIOMS (OR BOTH)
		3489
		3490	This section explains some common idioms that are not immediately
		3491	obvious. Note that examples are sprinkled over the whole manual, and this
		3492	section only contains stuff that wouldn't fit anywhere else.
		3493
		3494	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
		3495
		3496	Each watcher has, by default, a C<void *data> member that you can read
		3497	or modify at any time: libev will completely ignore it. This can be used
		3498	to associate arbitrary data with your watcher. If you need more data and
		3499	don't want to allocate memory separately and store a pointer to it in that
		3500	data member, you can also "subclass" the watcher type and provide your own
		3501	data:
		3502
		3503	struct my_io
		3504	{
		3505	ev_io io;
		3506	int otherfd;
		3507	void *somedata;
		3508	struct whatever *mostinteresting;
		3509	};
		3510
		3511	...
		3512	struct my_io w;
		3513	ev_io_init (&w.io, my_cb, fd, EV_READ);
		3514
		3515	And since your callback will be called with a pointer to the watcher, you
		3516	can cast it back to your own type:
		3517
		3518	static void my_cb (struct ev_loop *loop, ev_io *w_, int revents)
		3519	{
		3520	struct my_io *w = (struct my_io *)w_;
		3521	...
		3522	}
		3523
		3524	More interesting and less C-conformant ways of casting your callback
		3525	function type instead have been omitted.
		3526
		3527	=head2 BUILDING YOUR OWN COMPOSITE WATCHERS
		3528
		3529	Another common scenario is to use some data structure with multiple
		3530	embedded watchers, in effect creating your own watcher that combines
		3531	multiple libev event sources into one "super-watcher":
		3532
		3533	struct my_biggy
		3534	{
		3535	int some_data;
		3536	ev_timer t1;
		3537	ev_timer t2;
		3538	}
		3539
		3540	In this case getting the pointer to C<my_biggy> is a bit more
		3541	complicated: Either you store the address of your C<my_biggy> struct in
		3542	the C<data> member of the watcher (for woozies or C++ coders), or you need
		3543	to use some pointer arithmetic using C<offsetof> inside your watchers (for
		3544	real programmers):
		3545
		3546	#include <stddef.h>
		3547
		3548	static void
		3549	t1_cb (EV_P_ ev_timer *w, int revents)
		3550	{
		3551	struct my_biggy big = (struct my_biggy *)
		3552	(((char *)w) - offsetof (struct my_biggy, t1));
		3553	}
		3554
		3555	static void
		3556	t2_cb (EV_P_ ev_timer *w, int revents)
		3557	{
		3558	struct my_biggy big = (struct my_biggy *)
		3559	(((char *)w) - offsetof (struct my_biggy, t2));
		3560	}
		3561
		3562	=head2 MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS
		3563
		3564	Often (especially in GUI toolkits) there are places where you have
		3565	I<modal> interaction, which is most easily implemented by recursively
		3566	invoking C<ev_run>.
		3567
		3568	This brings the problem of exiting - a callback might want to finish the
		3569	main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but
		3570	a modal "Are you sure?" dialog is still waiting), or just the nested one
		3571	and not the main one (e.g. user clocked "Ok" in a modal dialog), or some
		3572	other combination: In these cases, C<ev_break> will not work alone.
		3573
		3574	The solution is to maintain "break this loop" variable for each C<ev_run>
		3575	invocation, and use a loop around C<ev_run> until the condition is
		3576	triggered, using C<EVRUN_ONCE>:
		3577
		3578	// main loop
		3579	int exit_main_loop = 0;
		3580
		3581	while (!exit_main_loop)
		3582	ev_run (EV_DEFAULT_ EVRUN_ONCE);
		3583
		3584	// in a model watcher
		3585	int exit_nested_loop = 0;
		3586
		3587	while (!exit_nested_loop)
		3588	ev_run (EV_A_ EVRUN_ONCE);
		3589
		3590	To exit from any of these loops, just set the corresponding exit variable:
		3591
		3592	// exit modal loop
		3593	exit_nested_loop = 1;
		3594
		3595	// exit main program, after modal loop is finished
		3596	exit_main_loop = 1;
		3597
		3598	// exit both
		3599	exit_main_loop = exit_nested_loop = 1;
		3600
		3601	=head2 THREAD LOCKING EXAMPLE
		3602
		3603	Here is a fictitious example of how to run an event loop in a different
		3604	thread from where callbacks are being invoked and watchers are
		3605	created/added/removed.
		3606
		3607	For a real-world example, see the C<EV::Loop::Async> perl module,
		3608	which uses exactly this technique (which is suited for many high-level
		3609	languages).
		3610
		3611	The example uses a pthread mutex to protect the loop data, a condition
		3612	variable to wait for callback invocations, an async watcher to notify the
		3613	event loop thread and an unspecified mechanism to wake up the main thread.
		3614
		3615	First, you need to associate some data with the event loop:
		3616
		3617	typedef struct {
		3618	mutex_t lock; /* global loop lock */
		3619	ev_async async_w;
		3620	thread_t tid;
		3621	cond_t invoke_cv;
		3622	} userdata;
		3623
		3624	void prepare_loop (EV_P)
		3625	{
		3626	// for simplicity, we use a static userdata struct.
		3627	static userdata u;
		3628
		3629	ev_async_init (&u->async_w, async_cb);
		3630	ev_async_start (EV_A_ &u->async_w);
		3631
		3632	pthread_mutex_init (&u->lock, 0);
		3633	pthread_cond_init (&u->invoke_cv, 0);
		3634
		3635	// now associate this with the loop
		3636	ev_set_userdata (EV_A_ u);
		3637	ev_set_invoke_pending_cb (EV_A_ l_invoke);
		3638	ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
		3639
		3640	// then create the thread running ev_run
		3641	pthread_create (&u->tid, 0, l_run, EV_A);
		3642	}
		3643
		3644	The callback for the C<ev_async> watcher does nothing: the watcher is used
		3645	solely to wake up the event loop so it takes notice of any new watchers
		3646	that might have been added:
		3647
		3648	static void
		3649	async_cb (EV_P_ ev_async *w, int revents)
		3650	{
		3651	// just used for the side effects
		3652	}
		3653
		3654	The C<l_release> and C<l_acquire> callbacks simply unlock/lock the mutex
		3655	protecting the loop data, respectively.
		3656
		3657	static void
		3658	l_release (EV_P)
		3659	{
		3660	userdata *u = ev_userdata (EV_A);
		3661	pthread_mutex_unlock (&u->lock);
		3662	}
		3663
		3664	static void
		3665	l_acquire (EV_P)
		3666	{
		3667	userdata *u = ev_userdata (EV_A);
		3668	pthread_mutex_lock (&u->lock);
		3669	}
		3670
		3671	The event loop thread first acquires the mutex, and then jumps straight
		3672	into C<ev_run>:
		3673
		3674	void *
		3675	l_run (void *thr_arg)
		3676	{
		3677	struct ev_loop *loop = (struct ev_loop *)thr_arg;
		3678
		3679	l_acquire (EV_A);
		3680	pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
		3681	ev_run (EV_A_ 0);
		3682	l_release (EV_A);
		3683
		3684	return 0;
		3685	}
		3686
		3687	Instead of invoking all pending watchers, the C<l_invoke> callback will
		3688	signal the main thread via some unspecified mechanism (signals? pipe
		3689	writes? C<Async::Interrupt>?) and then waits until all pending watchers
		3690	have been called (in a while loop because a) spurious wakeups are possible
		3691	and b) skipping inter-thread-communication when there are no pending
		3692	watchers is very beneficial):
		3693
		3694	static void
		3695	l_invoke (EV_P)
		3696	{
		3697	userdata *u = ev_userdata (EV_A);
		3698
		3699	while (ev_pending_count (EV_A))
		3700	{
		3701	wake_up_other_thread_in_some_magic_or_not_so_magic_way ();
		3702	pthread_cond_wait (&u->invoke_cv, &u->lock);
		3703	}
		3704	}
		3705
		3706	Now, whenever the main thread gets told to invoke pending watchers, it
		3707	will grab the lock, call C<ev_invoke_pending> and then signal the loop
		3708	thread to continue:
		3709
		3710	static void
		3711	real_invoke_pending (EV_P)
		3712	{
		3713	userdata *u = ev_userdata (EV_A);
		3714
		3715	pthread_mutex_lock (&u->lock);
		3716	ev_invoke_pending (EV_A);
		3717	pthread_cond_signal (&u->invoke_cv);
		3718	pthread_mutex_unlock (&u->lock);
		3719	}
		3720
		3721	Whenever you want to start/stop a watcher or do other modifications to an
		3722	event loop, you will now have to lock:
		3723
		3724	ev_timer timeout_watcher;
		3725	userdata *u = ev_userdata (EV_A);
		3726
		3727	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
		3728
		3729	pthread_mutex_lock (&u->lock);
		3730	ev_timer_start (EV_A_ &timeout_watcher);
		3731	ev_async_send (EV_A_ &u->async_w);
		3732	pthread_mutex_unlock (&u->lock);
		3733
		3734	Note that sending the C<ev_async> watcher is required because otherwise
		3735	an event loop currently blocking in the kernel will have no knowledge
		3736	about the newly added timer. By waking up the loop it will pick up any new
		3737	watchers in the next event loop iteration.
		3738
		3739	=head2 THREADS, COROUTINES, CONTINUATIONS, QUEUES... INSTEAD OF CALLBACKS
		3740
		3741	While the overhead of a callback that e.g. schedules a thread is small, it
		3742	is still an overhead. If you embed libev, and your main usage is with some
		3743	kind of threads or coroutines, you might want to customise libev so that
		3744	doesn't need callbacks anymore.
		3745
		3746	Imagine you have coroutines that you can switch to using a function
		3747	C<switch_to (coro)>, that libev runs in a coroutine called C<libev_coro>
		3748	and that due to some magic, the currently active coroutine is stored in a
		3749	global called C<current_coro>. Then you can build your own "wait for libev
		3750	event" primitive by changing C<EV_CB_DECLARE> and C<EV_CB_INVOKE> (note
		3751	the differing C<;> conventions):
		3752
		3753	#define EV_CB_DECLARE(type) struct my_coro *cb;
		3754	#define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb)
		3755
		3756	That means instead of having a C callback function, you store the
		3757	coroutine to switch to in each watcher, and instead of having libev call
		3758	your callback, you instead have it switch to that coroutine.
		3759
		3760	A coroutine might now wait for an event with a function called
		3761	C<wait_for_event>. (the watcher needs to be started, as always, but it doesn't
		3762	matter when, or whether the watcher is active or not when this function is
		3763	called):
		3764
		3765	void
		3766	wait_for_event (ev_watcher *w)
		3767	{
		3768	ev_cb_set (w) = current_coro;
		3769	switch_to (libev_coro);
		3770	}
		3771
		3772	That basically suspends the coroutine inside C<wait_for_event> and
		3773	continues the libev coroutine, which, when appropriate, switches back to
		3774	this or any other coroutine. I am sure if you sue this your own :)
		3775
		3776	You can do similar tricks if you have, say, threads with an event queue -
		3777	instead of storing a coroutine, you store the queue object and instead of
		3778	switching to a coroutine, you push the watcher onto the queue and notify
		3779	any waiters.
		3780
		3781	To embed libev, see L<EMBEDDING>, but in short, it's easiest to create two
		3782	files, F<my_ev.h> and F<my_ev.c> that include the respective libev files:
		3783
		3784	// my_ev.h
		3785	#define EV_CB_DECLARE(type) struct my_coro *cb;
		3786	#define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb);
		3787	#include "../libev/ev.h"
		3788
		3789	// my_ev.c
		3790	#define EV_H "my_ev.h"
		3791	#include "../libev/ev.c"
		3792
		3793	And then use F<my_ev.h> when you would normally use F<ev.h>, and compile
		3794	F<my_ev.c> into your project. When properly specifying include paths, you
		3795	can even use F<ev.h> as header file name directly.
2984		3796
2985		3797
2986	=head1 LIBEVENT EMULATION	3798	=head1 LIBEVENT EMULATION
2987		3799
2988	Libev offers a compatibility emulation layer for libevent. It cannot	3800	Libev offers a compatibility emulation layer for libevent. It cannot
2989	emulate the internals of libevent, so here are some usage hints:	3801	emulate the internals of libevent, so here are some usage hints:
2990		3802
2991	=over 4	3803	=over 4
		3804
		3805	=item * Only the libevent-1.4.1-beta API is being emulated.
		3806
		3807	This was the newest libevent version available when libev was implemented,
		3808	and is still mostly unchanged in 2010.
2992		3809
2993	=item * Use it by including <event.h>, as usual.	3810	=item * Use it by including <event.h>, as usual.
2994		3811
2995	=item * The following members are fully supported: ev_base, ev_callback,	3812	=item * The following members are fully supported: ev_base, ev_callback,
2996	ev_arg, ev_fd, ev_res, ev_events.	3813	ev_arg, ev_fd, ev_res, ev_events.
…		…
3002	=item * Priorities are not currently supported. Initialising priorities	3819	=item * Priorities are not currently supported. Initialising priorities
3003	will fail and all watchers will have the same priority, even though there	3820	will fail and all watchers will have the same priority, even though there
3004	is an ev_pri field.	3821	is an ev_pri field.
3005		3822
3006	=item * In libevent, the last base created gets the signals, in libev, the	3823	=item * In libevent, the last base created gets the signals, in libev, the
3007	first base created (== the default loop) gets the signals.	3824	base that registered the signal gets the signals.
3008		3825
3009	=item * Other members are not supported.	3826	=item * Other members are not supported.
3010		3827
3011	=item * The libev emulation is I<not> ABI compatible to libevent, you need	3828	=item * The libev emulation is I<not> ABI compatible to libevent, you need
3012	to use the libev header file and library.	3829	to use the libev header file and library.
…		…
3031	Care has been taken to keep the overhead low. The only data member the C++	3848	Care has been taken to keep the overhead low. The only data member the C++
3032	classes add (compared to plain C-style watchers) is the event loop pointer	3849	classes add (compared to plain C-style watchers) is the event loop pointer
3033	that the watcher is associated with (or no additional members at all if	3850	that the watcher is associated with (or no additional members at all if
3034	you disable C<EV_MULTIPLICITY> when embedding libev).	3851	you disable C<EV_MULTIPLICITY> when embedding libev).
3035		3852
3036	Currently, functions, and static and non-static member functions can be	3853	Currently, functions, static and non-static member functions and classes
3037	used as callbacks. Other types should be easy to add as long as they only	3854	with C<operator ()> can be used as callbacks. Other types should be easy
3038	need one additional pointer for context. If you need support for other	3855	to add as long as they only need one additional pointer for context. If
3039	types of functors please contact the author (preferably after implementing	3856	you need support for other types of functors please contact the author
3040	it).	3857	(preferably after implementing it).
3041		3858
3042	Here is a list of things available in the C<ev> namespace:	3859	Here is a list of things available in the C<ev> namespace:
3043		3860
3044	=over 4	3861	=over 4
3045		3862
…		…
3063		3880
3064	=over 4	3881	=over 4
3065		3882
3066	=item ev::TYPE::TYPE ()	3883	=item ev::TYPE::TYPE ()
3067		3884
3068	=item ev::TYPE::TYPE (struct ev_loop *)	3885	=item ev::TYPE::TYPE (loop)
3069		3886
3070	=item ev::TYPE::~TYPE	3887	=item ev::TYPE::~TYPE
3071		3888
3072	The constructor (optionally) takes an event loop to associate the watcher	3889	The constructor (optionally) takes an event loop to associate the watcher
3073	with. If it is omitted, it will use C<EV_DEFAULT>.	3890	with. If it is omitted, it will use C<EV_DEFAULT>.
…		…
3106	myclass obj;	3923	myclass obj;
3107	ev::io iow;	3924	ev::io iow;
3108	iow.set <myclass, &myclass::io_cb> (&obj);	3925	iow.set <myclass, &myclass::io_cb> (&obj);
3109		3926
3110	=item w->set (object *)	3927	=item w->set (object *)
3111
3112	This is an B<experimental> feature that might go away in a future version.
3113		3928
3114	This is a variation of a method callback - leaving out the method to call	3929	This is a variation of a method callback - leaving out the method to call
3115	will default the method to C<operator ()>, which makes it possible to use	3930	will default the method to C<operator ()>, which makes it possible to use
3116	functor objects without having to manually specify the C<operator ()> all	3931	functor objects without having to manually specify the C<operator ()> all
3117	the time. Incidentally, you can then also leave out the template argument	3932	the time. Incidentally, you can then also leave out the template argument
…		…
3150	Example: Use a plain function as callback.	3965	Example: Use a plain function as callback.
3151		3966
3152	static void io_cb (ev::io &w, int revents) { }	3967	static void io_cb (ev::io &w, int revents) { }
3153	iow.set <io_cb> ();	3968	iow.set <io_cb> ();
3154		3969
3155	=item w->set (struct ev_loop *)	3970	=item w->set (loop)
3156		3971
3157	Associates a different C<struct ev_loop> with this watcher. You can only	3972	Associates a different C<struct ev_loop> with this watcher. You can only
3158	do this when the watcher is inactive (and not pending either).	3973	do this when the watcher is inactive (and not pending either).
3159		3974
3160	=item w->set ([arguments])	3975	=item w->set ([arguments])
3161		3976
3162	Basically the same as C<ev_TYPE_set>, with the same arguments. Must be	3977	Basically the same as C<ev_TYPE_set>, with the same arguments. Either this
3163	called at least once. Unlike the C counterpart, an active watcher gets	3978	method or a suitable start method must be called at least once. Unlike the
3164	automatically stopped and restarted when reconfiguring it with this	3979	C counterpart, an active watcher gets automatically stopped and restarted
3165	method.	3980	when reconfiguring it with this method.
3166		3981
3167	=item w->start ()	3982	=item w->start ()
3168		3983
3169	Starts the watcher. Note that there is no C<loop> argument, as the	3984	Starts the watcher. Note that there is no C<loop> argument, as the
3170	constructor already stores the event loop.	3985	constructor already stores the event loop.
3171		3986
		3987	=item w->start ([arguments])
		3988
		3989	Instead of calling C<set> and C<start> methods separately, it is often
		3990	convenient to wrap them in one call. Uses the same type of arguments as
		3991	the configure C<set> method of the watcher.
		3992
3172	=item w->stop ()	3993	=item w->stop ()
3173		3994
3174	Stops the watcher if it is active. Again, no C<loop> argument.	3995	Stops the watcher if it is active. Again, no C<loop> argument.
3175		3996
3176	=item w->again () (C<ev::timer>, C<ev::periodic> only)	3997	=item w->again () (C<ev::timer>, C<ev::periodic> only)
…		…
3188		4009
3189	=back	4010	=back
3190		4011
3191	=back	4012	=back
3192		4013
3193	Example: Define a class with an IO and idle watcher, start one of them in	4014	Example: Define a class with two I/O and idle watchers, start the I/O
3194	the constructor.	4015	watchers in the constructor.
3195		4016
3196	class myclass	4017	class myclass
3197	{	4018	{
3198	ev::io io ; void io_cb (ev::io &w, int revents);	4019	ev::io io ; void io_cb (ev::io &w, int revents);
		4020	ev::io io2 ; void io2_cb (ev::io &w, int revents);
3199	ev::idle idle; void idle_cb (ev::idle &w, int revents);	4021	ev::idle idle; void idle_cb (ev::idle &w, int revents);
3200		4022
3201	myclass (int fd)	4023	myclass (int fd)
3202	{	4024	{
3203	io .set <myclass, &myclass::io_cb > (this);	4025	io .set <myclass, &myclass::io_cb > (this);
		4026	io2 .set <myclass, &myclass::io2_cb > (this);
3204	idle.set <myclass, &myclass::idle_cb> (this);	4027	idle.set <myclass, &myclass::idle_cb> (this);
3205		4028
3206	io.start (fd, ev::READ);	4029	io.set (fd, ev::WRITE); // configure the watcher
		4030	io.start (); // start it whenever convenient
		4031
		4032	io2.start (fd, ev::READ); // set + start in one call
3207	}	4033	}
3208	};	4034	};
3209		4035
3210		4036
3211	=head1 OTHER LANGUAGE BINDINGS	4037	=head1 OTHER LANGUAGE BINDINGS
…		…
3250	L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>.	4076	L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>.
3251		4077
3252	=item D	4078	=item D
3253		4079
3254	Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to	4080	Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to
3255	be found at L<http://proj.llucax.com.ar/wiki/evd>.	4081	be found at L<http://www.llucax.com.ar/proj/ev.d/index.html>.
3256		4082
3257	=item Ocaml	4083	=item Ocaml
3258		4084
3259	Erkki Seppala has written Ocaml bindings for libev, to be found at	4085	Erkki Seppala has written Ocaml bindings for libev, to be found at
3260	L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.	4086	L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.
		4087
		4088	=item Lua
		4089
		4090	Brian Maher has written a partial interface to libev for lua (at the
		4091	time of this writing, only C<ev_io> and C<ev_timer>), to be found at
		4092	L<http://github.com/brimworks/lua-ev>.
3261		4093
3262	=back	4094	=back
3263		4095
3264		4096
3265	=head1 MACRO MAGIC	4097	=head1 MACRO MAGIC
…		…
3279	loop argument"). The C<EV_A> form is used when this is the sole argument,	4111	loop argument"). The C<EV_A> form is used when this is the sole argument,
3280	C<EV_A_> is used when other arguments are following. Example:	4112	C<EV_A_> is used when other arguments are following. Example:
3281		4113
3282	ev_unref (EV_A);	4114	ev_unref (EV_A);
3283	ev_timer_add (EV_A_ watcher);	4115	ev_timer_add (EV_A_ watcher);
3284	ev_loop (EV_A_ 0);	4116	ev_run (EV_A_ 0);
3285		4117
3286	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,	4118	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,
3287	which is often provided by the following macro.	4119	which is often provided by the following macro.
3288		4120
3289	=item C<EV_P>, C<EV_P_>	4121	=item C<EV_P>, C<EV_P_>
…		…
3302	suitable for use with C<EV_A>.	4134	suitable for use with C<EV_A>.
3303		4135
3304	=item C<EV_DEFAULT>, C<EV_DEFAULT_>	4136	=item C<EV_DEFAULT>, C<EV_DEFAULT_>
3305		4137
3306	Similar to the other two macros, this gives you the value of the default	4138	Similar to the other two macros, this gives you the value of the default
3307	loop, if multiple loops are supported ("ev loop default").	4139	loop, if multiple loops are supported ("ev loop default"). The default loop
		4140	will be initialised if it isn't already initialised.
		4141
		4142	For non-multiplicity builds, these macros do nothing, so you always have
		4143	to initialise the loop somewhere.
3308		4144
3309	=item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_>	4145	=item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_>
3310		4146
3311	Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the	4147	Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the
3312	default loop has been initialised (C<UC> == unchecked). Their behaviour	4148	default loop has been initialised (C<UC> == unchecked). Their behaviour
…		…
3329	}	4165	}
3330		4166
3331	ev_check check;	4167	ev_check check;
3332	ev_check_init (&check, check_cb);	4168	ev_check_init (&check, check_cb);
3333	ev_check_start (EV_DEFAULT_ &check);	4169	ev_check_start (EV_DEFAULT_ &check);
3334	ev_loop (EV_DEFAULT_ 0);	4170	ev_run (EV_DEFAULT_ 0);
3335		4171
3336	=head1 EMBEDDING	4172	=head1 EMBEDDING
3337		4173
3338	Libev can (and often is) directly embedded into host	4174	Libev can (and often is) directly embedded into host
3339	applications. Examples of applications that embed it include the Deliantra	4175	applications. Examples of applications that embed it include the Deliantra
…		…
3419	libev.m4	4255	libev.m4
3420		4256
3421	=head2 PREPROCESSOR SYMBOLS/MACROS	4257	=head2 PREPROCESSOR SYMBOLS/MACROS
3422		4258
3423	Libev can be configured via a variety of preprocessor symbols you have to	4259	Libev can be configured via a variety of preprocessor symbols you have to
3424	define before including any of its files. The default in the absence of	4260	define before including (or compiling) any of its files. The default in
3425	autoconf is documented for every option.	4261	the absence of autoconf is documented for every option.
		4262
		4263	Symbols marked with "(h)" do not change the ABI, and can have different
		4264	values when compiling libev vs. including F<ev.h>, so it is permissible
		4265	to redefine them before including F<ev.h> without breaking compatibility
		4266	to a compiled library. All other symbols change the ABI, which means all
		4267	users of libev and the libev code itself must be compiled with compatible
		4268	settings.
3426		4269
3427	=over 4	4270	=over 4
3428		4271
		4272	=item EV_COMPAT3 (h)
		4273
		4274	Backwards compatibility is a major concern for libev. This is why this
		4275	release of libev comes with wrappers for the functions and symbols that
		4276	have been renamed between libev version 3 and 4.
		4277
		4278	You can disable these wrappers (to test compatibility with future
		4279	versions) by defining C<EV_COMPAT3> to C<0> when compiling your
		4280	sources. This has the additional advantage that you can drop the C<struct>
		4281	from C<struct ev_loop> declarations, as libev will provide an C<ev_loop>
		4282	typedef in that case.
		4283
		4284	In some future version, the default for C<EV_COMPAT3> will become C<0>,
		4285	and in some even more future version the compatibility code will be
		4286	removed completely.
		4287
3429	=item EV_STANDALONE	4288	=item EV_STANDALONE (h)
3430		4289
3431	Must always be C<1> if you do not use autoconf configuration, which	4290	Must always be C<1> if you do not use autoconf configuration, which
3432	keeps libev from including F<config.h>, and it also defines dummy	4291	keeps libev from including F<config.h>, and it also defines dummy
3433	implementations for some libevent functions (such as logging, which is not	4292	implementations for some libevent functions (such as logging, which is not
3434	supported). It will also not define any of the structs usually found in	4293	supported). It will also not define any of the structs usually found in
3435	F<event.h> that are not directly supported by the libev core alone.	4294	F<event.h> that are not directly supported by the libev core alone.
3436		4295
3437	In stanbdalone mode, libev will still try to automatically deduce the	4296	In standalone mode, libev will still try to automatically deduce the
3438	configuration, but has to be more conservative.	4297	configuration, but has to be more conservative.
		4298
		4299	=item EV_USE_FLOOR
		4300
		4301	If defined to be C<1>, libev will use the C<floor ()> function for its
		4302	periodic reschedule calculations, otherwise libev will fall back on a
		4303	portable (slower) implementation. If you enable this, you usually have to
		4304	link against libm or something equivalent. Enabling this when the C<floor>
		4305	function is not available will fail, so the safe default is to not enable
		4306	this.
3439		4307
3440	=item EV_USE_MONOTONIC	4308	=item EV_USE_MONOTONIC
3441		4309
3442	If defined to be C<1>, libev will try to detect the availability of the	4310	If defined to be C<1>, libev will try to detect the availability of the
3443	monotonic clock option at both compile time and runtime. Otherwise no	4311	monotonic clock option at both compile time and runtime. Otherwise no
…		…
3507	be used is the winsock select). This means that it will call	4375	be used is the winsock select). This means that it will call
3508	C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise,	4376	C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise,
3509	it is assumed that all these functions actually work on fds, even	4377	it is assumed that all these functions actually work on fds, even
3510	on win32. Should not be defined on non-win32 platforms.	4378	on win32. Should not be defined on non-win32 platforms.
3511		4379
3512	=item EV_FD_TO_WIN32_HANDLE	4380	=item EV_FD_TO_WIN32_HANDLE(fd)
3513		4381
3514	If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map	4382	If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map
3515	file descriptors to socket handles. When not defining this symbol (the	4383	file descriptors to socket handles. When not defining this symbol (the
3516	default), then libev will call C<_get_osfhandle>, which is usually	4384	default), then libev will call C<_get_osfhandle>, which is usually
3517	correct. In some cases, programs use their own file descriptor management,	4385	correct. In some cases, programs use their own file descriptor management,
3518	in which case they can provide this function to map fds to socket handles.	4386	in which case they can provide this function to map fds to socket handles.
		4387
		4388	=item EV_WIN32_HANDLE_TO_FD(handle)
		4389
		4390	If C<EV_SELECT_IS_WINSOCKET> then libev maps handles to file descriptors
		4391	using the standard C<_open_osfhandle> function. For programs implementing
		4392	their own fd to handle mapping, overwriting this function makes it easier
		4393	to do so. This can be done by defining this macro to an appropriate value.
		4394
		4395	=item EV_WIN32_CLOSE_FD(fd)
		4396
		4397	If programs implement their own fd to handle mapping on win32, then this
		4398	macro can be used to override the C<close> function, useful to unregister
		4399	file descriptors again. Note that the replacement function has to close
		4400	the underlying OS handle.
3519		4401
3520	=item EV_USE_POLL	4402	=item EV_USE_POLL
3521		4403
3522	If defined to be C<1>, libev will compile in support for the C<poll>(2)	4404	If defined to be C<1>, libev will compile in support for the C<poll>(2)
3523	backend. Otherwise it will be enabled on non-win32 platforms. It	4405	backend. Otherwise it will be enabled on non-win32 platforms. It
…		…
3562	indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.	4444	indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
3563		4445
3564	=item EV_ATOMIC_T	4446	=item EV_ATOMIC_T
3565		4447
3566	Libev requires an integer type (suitable for storing C<0> or C<1>) whose	4448	Libev requires an integer type (suitable for storing C<0> or C<1>) whose
3567	access is atomic with respect to other threads or signal contexts. No such	4449	access is atomic and serialised with respect to other threads or signal
3568	type is easily found in the C language, so you can provide your own type	4450	contexts. No such type is easily found in the C language, so you can
3569	that you know is safe for your purposes. It is used both for signal handler "locking"	4451	provide your own type that you know is safe for your purposes. It is used
3570	as well as for signal and thread safety in C<ev_async> watchers.	4452	both for signal handler "locking" as well as for signal and thread safety
		4453	in C<ev_async> watchers.
3571		4454
3572	In the absence of this define, libev will use C<sig_atomic_t volatile>	4455	In the absence of this define, libev will use C<sig_atomic_t volatile>
3573	(from F<signal.h>), which is usually good enough on most platforms.	4456	(from F<signal.h>), which is usually good enough on most platforms,
		4457	although strictly speaking using a type that also implies a memory fence
		4458	is required.
3574		4459
3575	=item EV_H	4460	=item EV_H (h)
3576		4461
3577	The name of the F<ev.h> header file used to include it. The default if	4462	The name of the F<ev.h> header file used to include it. The default if
3578	undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be	4463	undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be
3579	used to virtually rename the F<ev.h> header file in case of conflicts.	4464	used to virtually rename the F<ev.h> header file in case of conflicts.
3580		4465
3581	=item EV_CONFIG_H	4466	=item EV_CONFIG_H (h)
3582		4467
3583	If C<EV_STANDALONE> isn't C<1>, this variable can be used to override	4468	If C<EV_STANDALONE> isn't C<1>, this variable can be used to override
3584	F<ev.c>'s idea of where to find the F<config.h> file, similarly to	4469	F<ev.c>'s idea of where to find the F<config.h> file, similarly to
3585	C<EV_H>, above.	4470	C<EV_H>, above.
3586		4471
3587	=item EV_EVENT_H	4472	=item EV_EVENT_H (h)
3588		4473
3589	Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea	4474	Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea
3590	of how the F<event.h> header can be found, the default is C<"event.h">.	4475	of how the F<event.h> header can be found, the default is C<"event.h">.
3591		4476
3592	=item EV_PROTOTYPES	4477	=item EV_PROTOTYPES (h)
3593		4478
3594	If defined to be C<0>, then F<ev.h> will not define any function	4479	If defined to be C<0>, then F<ev.h> will not define any function
3595	prototypes, but still define all the structs and other symbols. This is	4480	prototypes, but still define all the structs and other symbols. This is
3596	occasionally useful if you want to provide your own wrapper functions	4481	occasionally useful if you want to provide your own wrapper functions
3597	around libev functions.	4482	around libev functions.
…		…
3602	will have the C<struct ev_loop *> as first argument, and you can create	4487	will have the C<struct ev_loop *> as first argument, and you can create
3603	additional independent event loops. Otherwise there will be no support	4488	additional independent event loops. Otherwise there will be no support
3604	for multiple event loops and there is no first event loop pointer	4489	for multiple event loops and there is no first event loop pointer
3605	argument. Instead, all functions act on the single default loop.	4490	argument. Instead, all functions act on the single default loop.
3606		4491
		4492	Note that C<EV_DEFAULT> and C<EV_DEFAULT_> will no longer provide a
		4493	default loop when multiplicity is switched off - you always have to
		4494	initialise the loop manually in this case.
		4495
3607	=item EV_MINPRI	4496	=item EV_MINPRI
3608		4497
3609	=item EV_MAXPRI	4498	=item EV_MAXPRI
3610		4499
3611	The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to	4500	The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to
…		…
3619	fine.	4508	fine.
3620		4509
3621	If your embedding application does not need any priorities, defining these	4510	If your embedding application does not need any priorities, defining these
3622	both to C<0> will save some memory and CPU.	4511	both to C<0> will save some memory and CPU.
3623		4512
3624	=item EV_PERIODIC_ENABLE	4513	=item EV_PERIODIC_ENABLE, EV_IDLE_ENABLE, EV_EMBED_ENABLE, EV_STAT_ENABLE,
		4514	EV_PREPARE_ENABLE, EV_CHECK_ENABLE, EV_FORK_ENABLE, EV_SIGNAL_ENABLE,
		4515	EV_ASYNC_ENABLE, EV_CHILD_ENABLE.
3625		4516
3626	If undefined or defined to be C<1>, then periodic timers are supported. If	4517	If undefined or defined to be C<1> (and the platform supports it), then
3627	defined to be C<0>, then they are not. Disabling them saves a few kB of	4518	the respective watcher type is supported. If defined to be C<0>, then it
3628	code.	4519	is not. Disabling watcher types mainly saves code size.
3629		4520
3630	=item EV_IDLE_ENABLE	4521	=item EV_FEATURES
3631
3632	If undefined or defined to be C<1>, then idle watchers are supported. If
3633	defined to be C<0>, then they are not. Disabling them saves a few kB of
3634	code.
3635
3636	=item EV_EMBED_ENABLE
3637
3638	If undefined or defined to be C<1>, then embed watchers are supported. If
3639	defined to be C<0>, then they are not. Embed watchers rely on most other
3640	watcher types, which therefore must not be disabled.
3641
3642	=item EV_STAT_ENABLE
3643
3644	If undefined or defined to be C<1>, then stat watchers are supported. If
3645	defined to be C<0>, then they are not.
3646
3647	=item EV_FORK_ENABLE
3648
3649	If undefined or defined to be C<1>, then fork watchers are supported. If
3650	defined to be C<0>, then they are not.
3651
3652	=item EV_ASYNC_ENABLE
3653
3654	If undefined or defined to be C<1>, then async watchers are supported. If
3655	defined to be C<0>, then they are not.
3656
3657	=item EV_MINIMAL
3658		4522
3659	If you need to shave off some kilobytes of code at the expense of some	4523	If you need to shave off some kilobytes of code at the expense of some
3660	speed, define this symbol to C<1>. Currently this is used to override some	4524	speed (but with the full API), you can define this symbol to request
3661	inlining decisions, saves roughly 30% code size on amd64. It also selects a	4525	certain subsets of functionality. The default is to enable all features
3662	much smaller 2-heap for timer management over the default 4-heap.	4526	that can be enabled on the platform.
		4527
		4528	A typical way to use this symbol is to define it to C<0> (or to a bitset
		4529	with some broad features you want) and then selectively re-enable
		4530	additional parts you want, for example if you want everything minimal,
		4531	but multiple event loop support, async and child watchers and the poll
		4532	backend, use this:
		4533
		4534	#define EV_FEATURES 0
		4535	#define EV_MULTIPLICITY 1
		4536	#define EV_USE_POLL 1
		4537	#define EV_CHILD_ENABLE 1
		4538	#define EV_ASYNC_ENABLE 1
		4539
		4540	The actual value is a bitset, it can be a combination of the following
		4541	values:
		4542
		4543	=over 4
		4544
		4545	=item C<1> - faster/larger code
		4546
		4547	Use larger code to speed up some operations.
		4548
		4549	Currently this is used to override some inlining decisions (enlarging the
		4550	code size by roughly 30% on amd64).
		4551
		4552	When optimising for size, use of compiler flags such as C<-Os> with
		4553	gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of
		4554	assertions.
		4555
		4556	=item C<2> - faster/larger data structures
		4557
		4558	Replaces the small 2-heap for timer management by a faster 4-heap, larger
		4559	hash table sizes and so on. This will usually further increase code size
		4560	and can additionally have an effect on the size of data structures at
		4561	runtime.
		4562
		4563	=item C<4> - full API configuration
		4564
		4565	This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and
		4566	enables multiplicity (C<EV_MULTIPLICITY>=1).
		4567
		4568	=item C<8> - full API
		4569
		4570	This enables a lot of the "lesser used" API functions. See C<ev.h> for
		4571	details on which parts of the API are still available without this
		4572	feature, and do not complain if this subset changes over time.
		4573
		4574	=item C<16> - enable all optional watcher types
		4575
		4576	Enables all optional watcher types. If you want to selectively enable
		4577	only some watcher types other than I/O and timers (e.g. prepare,
		4578	embed, async, child...) you can enable them manually by defining
		4579	C<EV_watchertype_ENABLE> to C<1> instead.
		4580
		4581	=item C<32> - enable all backends
		4582
		4583	This enables all backends - without this feature, you need to enable at
		4584	least one backend manually (C<EV_USE_SELECT> is a good choice).
		4585
		4586	=item C<64> - enable OS-specific "helper" APIs
		4587
		4588	Enable inotify, eventfd, signalfd and similar OS-specific helper APIs by
		4589	default.
		4590
		4591	=back
		4592
		4593	Compiling with C<gcc -Os -DEV_STANDALONE -DEV_USE_EPOLL=1 -DEV_FEATURES=0>
		4594	reduces the compiled size of libev from 24.7Kb code/2.8Kb data to 6.5Kb
		4595	code/0.3Kb data on my GNU/Linux amd64 system, while still giving you I/O
		4596	watchers, timers and monotonic clock support.
		4597
		4598	With an intelligent-enough linker (gcc+binutils are intelligent enough
		4599	when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by
		4600	your program might be left out as well - a binary starting a timer and an
		4601	I/O watcher then might come out at only 5Kb.
		4602
		4603	=item EV_AVOID_STDIO
		4604
		4605	If this is set to C<1> at compiletime, then libev will avoid using stdio
		4606	functions (printf, scanf, perror etc.). This will increase the code size
		4607	somewhat, but if your program doesn't otherwise depend on stdio and your
		4608	libc allows it, this avoids linking in the stdio library which is quite
		4609	big.
		4610
		4611	Note that error messages might become less precise when this option is
		4612	enabled.
		4613
		4614	=item EV_NSIG
		4615
		4616	The highest supported signal number, +1 (or, the number of
		4617	signals): Normally, libev tries to deduce the maximum number of signals
		4618	automatically, but sometimes this fails, in which case it can be
		4619	specified. Also, using a lower number than detected (C<32> should be
		4620	good for about any system in existence) can save some memory, as libev
		4621	statically allocates some 12-24 bytes per signal number.
3663		4622
3664	=item EV_PID_HASHSIZE	4623	=item EV_PID_HASHSIZE
3665		4624
3666	C<ev_child> watchers use a small hash table to distribute workload by	4625	C<ev_child> watchers use a small hash table to distribute workload by
3667	pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more	4626	pid. The default size is C<16> (or C<1> with C<EV_FEATURES> disabled),
3668	than enough. If you need to manage thousands of children you might want to	4627	usually more than enough. If you need to manage thousands of children you
3669	increase this value (I<must> be a power of two).	4628	might want to increase this value (I<must> be a power of two).
3670		4629
3671	=item EV_INOTIFY_HASHSIZE	4630	=item EV_INOTIFY_HASHSIZE
3672		4631
3673	C<ev_stat> watchers use a small hash table to distribute workload by	4632	C<ev_stat> watchers use a small hash table to distribute workload by
3674	inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>),	4633	inotify watch id. The default size is C<16> (or C<1> with C<EV_FEATURES>
3675	usually more than enough. If you need to manage thousands of C<ev_stat>	4634	disabled), usually more than enough. If you need to manage thousands of
3676	watchers you might want to increase this value (I<must> be a power of	4635	C<ev_stat> watchers you might want to increase this value (I<must> be a
3677	two).	4636	power of two).
3678		4637
3679	=item EV_USE_4HEAP	4638	=item EV_USE_4HEAP
3680		4639
3681	Heaps are not very cache-efficient. To improve the cache-efficiency of the	4640	Heaps are not very cache-efficient. To improve the cache-efficiency of the
3682	timer and periodics heaps, libev uses a 4-heap when this symbol is defined	4641	timer and periodics heaps, libev uses a 4-heap when this symbol is defined
3683	to C<1>. The 4-heap uses more complicated (longer) code but has noticeably	4642	to C<1>. The 4-heap uses more complicated (longer) code but has noticeably
3684	faster performance with many (thousands) of watchers.	4643	faster performance with many (thousands) of watchers.
3685		4644
3686	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>	4645	The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
3687	(disabled).	4646	will be C<0>.
3688		4647
3689	=item EV_HEAP_CACHE_AT	4648	=item EV_HEAP_CACHE_AT
3690		4649
3691	Heaps are not very cache-efficient. To improve the cache-efficiency of the	4650	Heaps are not very cache-efficient. To improve the cache-efficiency of the
3692	timer and periodics heaps, libev can cache the timestamp (I<at>) within	4651	timer and periodics heaps, libev can cache the timestamp (I<at>) within
3693	the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>),	4652	the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>),
3694	which uses 8-12 bytes more per watcher and a few hundred bytes more code,	4653	which uses 8-12 bytes more per watcher and a few hundred bytes more code,
3695	but avoids random read accesses on heap changes. This improves performance	4654	but avoids random read accesses on heap changes. This improves performance
3696	noticeably with many (hundreds) of watchers.	4655	noticeably with many (hundreds) of watchers.
3697		4656
3698	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>	4657	The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
3699	(disabled).	4658	will be C<0>.
3700		4659
3701	=item EV_VERIFY	4660	=item EV_VERIFY
3702		4661
3703	Controls how much internal verification (see C<ev_loop_verify ()>) will	4662	Controls how much internal verification (see C<ev_verify ()>) will
3704	be done: If set to C<0>, no internal verification code will be compiled	4663	be done: If set to C<0>, no internal verification code will be compiled
3705	in. If set to C<1>, then verification code will be compiled in, but not	4664	in. If set to C<1>, then verification code will be compiled in, but not
3706	called. If set to C<2>, then the internal verification code will be	4665	called. If set to C<2>, then the internal verification code will be
3707	called once per loop, which can slow down libev. If set to C<3>, then the	4666	called once per loop, which can slow down libev. If set to C<3>, then the
3708	verification code will be called very frequently, which will slow down	4667	verification code will be called very frequently, which will slow down
3709	libev considerably.	4668	libev considerably.
3710		4669
3711	The default is C<1>, unless C<EV_MINIMAL> is set, in which case it will be	4670	The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
3712	C<0>.	4671	will be C<0>.
3713		4672
3714	=item EV_COMMON	4673	=item EV_COMMON
3715		4674
3716	By default, all watchers have a C<void *data> member. By redefining	4675	By default, all watchers have a C<void *data> member. By redefining
3717	this macro to a something else you can include more and other types of	4676	this macro to something else you can include more and other types of
3718	members. You have to define it each time you include one of the files,	4677	members. You have to define it each time you include one of the files,
3719	though, and it must be identical each time.	4678	though, and it must be identical each time.
3720		4679
3721	For example, the perl EV module uses something like this:	4680	For example, the perl EV module uses something like this:
3722		4681
…		…
3775	file.	4734	file.
3776		4735
3777	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file	4736	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file
3778	that everybody includes and which overrides some configure choices:	4737	that everybody includes and which overrides some configure choices:
3779		4738
3780	#define EV_MINIMAL 1	4739	#define EV_FEATURES 8
3781	#define EV_USE_POLL 0	4740	#define EV_USE_SELECT 1
3782	#define EV_MULTIPLICITY 0
3783	#define EV_PERIODIC_ENABLE 0	4741	#define EV_PREPARE_ENABLE 1
		4742	#define EV_IDLE_ENABLE 1
3784	#define EV_STAT_ENABLE 0	4743	#define EV_SIGNAL_ENABLE 1
3785	#define EV_FORK_ENABLE 0	4744	#define EV_CHILD_ENABLE 1
		4745	#define EV_USE_STDEXCEPT 0
3786	#define EV_CONFIG_H <config.h>	4746	#define EV_CONFIG_H <config.h>
3787	#define EV_MINPRI 0
3788	#define EV_MAXPRI 0
3789		4747
3790	#include "ev++.h"	4748	#include "ev++.h"
3791		4749
3792	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:	4750	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
3793		4751
3794	#include "ev_cpp.h"	4752	#include "ev_cpp.h"
3795	#include "ev.c"	4753	#include "ev.c"
3796		4754
3797	=head1 INTERACTION WITH OTHER PROGRAMS OR LIBRARIES	4755	=head1 INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT
3798		4756
3799	=head2 THREADS AND COROUTINES	4757	=head2 THREADS AND COROUTINES
3800		4758
3801	=head3 THREADS	4759	=head3 THREADS
3802		4760
…		…
3853	default loop and triggering an C<ev_async> watcher from the default loop	4811	default loop and triggering an C<ev_async> watcher from the default loop
3854	watcher callback into the event loop interested in the signal.	4812	watcher callback into the event loop interested in the signal.
3855		4813
3856	=back	4814	=back
3857		4815
		4816	See also L<THREAD LOCKING EXAMPLE>.
		4817
3858	=head3 COROUTINES	4818	=head3 COROUTINES
3859		4819
3860	Libev is very accommodating to coroutines ("cooperative threads"):	4820	Libev is very accommodating to coroutines ("cooperative threads"):
3861	libev fully supports nesting calls to its functions from different	4821	libev fully supports nesting calls to its functions from different
3862	coroutines (e.g. you can call C<ev_loop> on the same loop from two	4822	coroutines (e.g. you can call C<ev_run> on the same loop from two
3863	different coroutines, and switch freely between both coroutines running the	4823	different coroutines, and switch freely between both coroutines running
3864	loop, as long as you don't confuse yourself). The only exception is that	4824	the loop, as long as you don't confuse yourself). The only exception is
3865	you must not do this from C<ev_periodic> reschedule callbacks.	4825	that you must not do this from C<ev_periodic> reschedule callbacks.
3866		4826
3867	Care has been taken to ensure that libev does not keep local state inside	4827	Care has been taken to ensure that libev does not keep local state inside
3868	C<ev_loop>, and other calls do not usually allow for coroutine switches as	4828	C<ev_run>, and other calls do not usually allow for coroutine switches as
3869	they do not call any callbacks.	4829	they do not call any callbacks.
3870		4830
3871	=head2 COMPILER WARNINGS	4831	=head2 COMPILER WARNINGS
3872		4832
3873	Depending on your compiler and compiler settings, you might get no or a	4833	Depending on your compiler and compiler settings, you might get no or a
…		…
3884	maintainable.	4844	maintainable.
3885		4845
3886	And of course, some compiler warnings are just plain stupid, or simply	4846	And of course, some compiler warnings are just plain stupid, or simply
3887	wrong (because they don't actually warn about the condition their message	4847	wrong (because they don't actually warn about the condition their message
3888	seems to warn about). For example, certain older gcc versions had some	4848	seems to warn about). For example, certain older gcc versions had some
3889	warnings that resulted an extreme number of false positives. These have	4849	warnings that resulted in an extreme number of false positives. These have
3890	been fixed, but some people still insist on making code warn-free with	4850	been fixed, but some people still insist on making code warn-free with
3891	such buggy versions.	4851	such buggy versions.
3892		4852
3893	While libev is written to generate as few warnings as possible,	4853	While libev is written to generate as few warnings as possible,
3894	"warn-free" code is not a goal, and it is recommended not to build libev	4854	"warn-free" code is not a goal, and it is recommended not to build libev
…		…
3930	I suggest using suppression lists.	4890	I suggest using suppression lists.
3931		4891
3932		4892
3933	=head1 PORTABILITY NOTES	4893	=head1 PORTABILITY NOTES
3934		4894
		4895	=head2 GNU/LINUX 32 BIT LIMITATIONS
		4896
		4897	GNU/Linux is the only common platform that supports 64 bit file/large file
		4898	interfaces but I<disables> them by default.
		4899
		4900	That means that libev compiled in the default environment doesn't support
		4901	files larger than 2GiB or so, which mainly affects C<ev_stat> watchers.
		4902
		4903	Unfortunately, many programs try to work around this GNU/Linux issue
		4904	by enabling the large file API, which makes them incompatible with the
		4905	standard libev compiled for their system.
		4906
		4907	Likewise, libev cannot enable the large file API itself as this would
		4908	suddenly make it incompatible to the default compile time environment,
		4909	i.e. all programs not using special compile switches.
		4910
		4911	=head2 OS/X AND DARWIN BUGS
		4912
		4913	The whole thing is a bug if you ask me - basically any system interface
		4914	you touch is broken, whether it is locales, poll, kqueue or even the
		4915	OpenGL drivers.
		4916
		4917	=head3 C<kqueue> is buggy
		4918
		4919	The kqueue syscall is broken in all known versions - most versions support
		4920	only sockets, many support pipes.
		4921
		4922	Libev tries to work around this by not using C<kqueue> by default on this
		4923	rotten platform, but of course you can still ask for it when creating a
		4924	loop - embedding a socket-only kqueue loop into a select-based one is
		4925	probably going to work well.
		4926
		4927	=head3 C<poll> is buggy
		4928
		4929	Instead of fixing C<kqueue>, Apple replaced their (working) C<poll>
		4930	implementation by something calling C<kqueue> internally around the 10.5.6
		4931	release, so now C<kqueue> I<and> C<poll> are broken.
		4932
		4933	Libev tries to work around this by not using C<poll> by default on
		4934	this rotten platform, but of course you can still ask for it when creating
		4935	a loop.
		4936
		4937	=head3 C<select> is buggy
		4938
		4939	All that's left is C<select>, and of course Apple found a way to fuck this
		4940	one up as well: On OS/X, C<select> actively limits the number of file
		4941	descriptors you can pass in to 1024 - your program suddenly crashes when
		4942	you use more.
		4943
		4944	There is an undocumented "workaround" for this - defining
		4945	C<_DARWIN_UNLIMITED_SELECT>, which libev tries to use, so select I<should>
		4946	work on OS/X.
		4947
		4948	=head2 SOLARIS PROBLEMS AND WORKAROUNDS
		4949
		4950	=head3 C<errno> reentrancy
		4951
		4952	The default compile environment on Solaris is unfortunately so
		4953	thread-unsafe that you can't even use components/libraries compiled
		4954	without C<-D_REENTRANT> in a threaded program, which, of course, isn't
		4955	defined by default. A valid, if stupid, implementation choice.
		4956
		4957	If you want to use libev in threaded environments you have to make sure
		4958	it's compiled with C<_REENTRANT> defined.
		4959
		4960	=head3 Event port backend
		4961
		4962	The scalable event interface for Solaris is called "event
		4963	ports". Unfortunately, this mechanism is very buggy in all major
		4964	releases. If you run into high CPU usage, your program freezes or you get
		4965	a large number of spurious wakeups, make sure you have all the relevant
		4966	and latest kernel patches applied. No, I don't know which ones, but there
		4967	are multiple ones to apply, and afterwards, event ports actually work
		4968	great.
		4969
		4970	If you can't get it to work, you can try running the program by setting
		4971	the environment variable C<LIBEV_FLAGS=3> to only allow C<poll> and
		4972	C<select> backends.
		4973
		4974	=head2 AIX POLL BUG
		4975
		4976	AIX unfortunately has a broken C<poll.h> header. Libev works around
		4977	this by trying to avoid the poll backend altogether (i.e. it's not even
		4978	compiled in), which normally isn't a big problem as C<select> works fine
		4979	with large bitsets on AIX, and AIX is dead anyway.
		4980
3935	=head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS	4981	=head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS
		4982
		4983	=head3 General issues
3936		4984
3937	Win32 doesn't support any of the standards (e.g. POSIX) that libev	4985	Win32 doesn't support any of the standards (e.g. POSIX) that libev
3938	requires, and its I/O model is fundamentally incompatible with the POSIX	4986	requires, and its I/O model is fundamentally incompatible with the POSIX
3939	model. Libev still offers limited functionality on this platform in	4987	model. Libev still offers limited functionality on this platform in
3940	the form of the C<EVBACKEND_SELECT> backend, and only supports socket	4988	the form of the C<EVBACKEND_SELECT> backend, and only supports socket
3941	descriptors. This only applies when using Win32 natively, not when using	4989	descriptors. This only applies when using Win32 natively, not when using
3942	e.g. cygwin.	4990	e.g. cygwin. Actually, it only applies to the microsofts own compilers,
		4991	as every compiler comes with a slightly differently broken/incompatible
		4992	environment.
3943		4993
3944	Lifting these limitations would basically require the full	4994	Lifting these limitations would basically require the full
3945	re-implementation of the I/O system. If you are into these kinds of	4995	re-implementation of the I/O system. If you are into this kind of thing,
3946	things, then note that glib does exactly that for you in a very portable	4996	then note that glib does exactly that for you in a very portable way (note
3947	way (note also that glib is the slowest event library known to man).	4997	also that glib is the slowest event library known to man).
3948		4998
3949	There is no supported compilation method available on windows except	4999	There is no supported compilation method available on windows except
3950	embedding it into other applications.	5000	embedding it into other applications.
3951		5001
3952	Sensible signal handling is officially unsupported by Microsoft - libev	5002	Sensible signal handling is officially unsupported by Microsoft - libev
…		…
3980	you do I<not> compile the F<ev.c> or any other embedded source files!):	5030	you do I<not> compile the F<ev.c> or any other embedded source files!):
3981		5031
3982	#include "evwrap.h"	5032	#include "evwrap.h"
3983	#include "ev.c"	5033	#include "ev.c"
3984		5034
3985	=over 4
3986
3987	=item The winsocket select function	5035	=head3 The winsocket C<select> function
3988		5036
3989	The winsocket C<select> function doesn't follow POSIX in that it	5037	The winsocket C<select> function doesn't follow POSIX in that it
3990	requires socket I<handles> and not socket I<file descriptors> (it is	5038	requires socket I<handles> and not socket I<file descriptors> (it is
3991	also extremely buggy). This makes select very inefficient, and also	5039	also extremely buggy). This makes select very inefficient, and also
3992	requires a mapping from file descriptors to socket handles (the Microsoft	5040	requires a mapping from file descriptors to socket handles (the Microsoft
…		…
4001	#define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */	5049	#define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */
4002		5050
4003	Note that winsockets handling of fd sets is O(n), so you can easily get a	5051	Note that winsockets handling of fd sets is O(n), so you can easily get a
4004	complexity in the O(n²) range when using win32.	5052	complexity in the O(n²) range when using win32.
4005		5053
4006	=item Limited number of file descriptors	5054	=head3 Limited number of file descriptors
4007		5055
4008	Windows has numerous arbitrary (and low) limits on things.	5056	Windows has numerous arbitrary (and low) limits on things.
4009		5057
4010	Early versions of winsocket's select only supported waiting for a maximum	5058	Early versions of winsocket's select only supported waiting for a maximum
4011	of C<64> handles (probably owning to the fact that all windows kernels	5059	of C<64> handles (probably owning to the fact that all windows kernels
…		…
4026	runtime libraries. This might get you to about C<512> or C<2048> sockets	5074	runtime libraries. This might get you to about C<512> or C<2048> sockets
4027	(depending on windows version and/or the phase of the moon). To get more,	5075	(depending on windows version and/or the phase of the moon). To get more,
4028	you need to wrap all I/O functions and provide your own fd management, but	5076	you need to wrap all I/O functions and provide your own fd management, but
4029	the cost of calling select (O(n²)) will likely make this unworkable.	5077	the cost of calling select (O(n²)) will likely make this unworkable.
4030		5078
4031	=back
4032
4033	=head2 PORTABILITY REQUIREMENTS	5079	=head2 PORTABILITY REQUIREMENTS
4034		5080
4035	In addition to a working ISO-C implementation and of course the	5081	In addition to a working ISO-C implementation and of course the
4036	backend-specific APIs, libev relies on a few additional extensions:	5082	backend-specific APIs, libev relies on a few additional extensions:
4037		5083
…		…
4043	Libev assumes not only that all watcher pointers have the same internal	5089	Libev assumes not only that all watcher pointers have the same internal
4044	structure (guaranteed by POSIX but not by ISO C for example), but it also	5090	structure (guaranteed by POSIX but not by ISO C for example), but it also
4045	assumes that the same (machine) code can be used to call any watcher	5091	assumes that the same (machine) code can be used to call any watcher
4046	callback: The watcher callbacks have different type signatures, but libev	5092	callback: The watcher callbacks have different type signatures, but libev
4047	calls them using an C<ev_watcher *> internally.	5093	calls them using an C<ev_watcher *> internally.
		5094
		5095	=item pointer accesses must be thread-atomic
		5096
		5097	Accessing a pointer value must be atomic, it must both be readable and
		5098	writable in one piece - this is the case on all current architectures.
4048		5099
4049	=item C<sig_atomic_t volatile> must be thread-atomic as well	5100	=item C<sig_atomic_t volatile> must be thread-atomic as well
4050		5101
4051	The type C<sig_atomic_t volatile> (or whatever is defined as	5102	The type C<sig_atomic_t volatile> (or whatever is defined as
4052	C<EV_ATOMIC_T>) must be atomic with respect to accesses from different	5103	C<EV_ATOMIC_T>) must be atomic with respect to accesses from different
…		…
4075	watchers.	5126	watchers.
4076		5127
4077	=item C<double> must hold a time value in seconds with enough accuracy	5128	=item C<double> must hold a time value in seconds with enough accuracy
4078		5129
4079	The type C<double> is used to represent timestamps. It is required to	5130	The type C<double> is used to represent timestamps. It is required to
4080	have at least 51 bits of mantissa (and 9 bits of exponent), which is good	5131	have at least 51 bits of mantissa (and 9 bits of exponent), which is
4081	enough for at least into the year 4000. This requirement is fulfilled by	5132	good enough for at least into the year 4000 with millisecond accuracy
		5133	(the design goal for libev). This requirement is overfulfilled by
4082	implementations implementing IEEE 754, which is basically all existing	5134	implementations using IEEE 754, which is basically all existing ones.
		5135
4083	ones. With IEEE 754 doubles, you get microsecond accuracy until at least	5136	With IEEE 754 doubles, you get microsecond accuracy until at least the
4084	2200.	5137	year 2255 (and millisecond accuracy till the year 287396 - by then, libev
		5138	is either obsolete or somebody patched it to use C<long double> or
		5139	something like that, just kidding).
4085		5140
4086	=back	5141	=back
4087		5142
4088	If you know of other additional requirements drop me a note.	5143	If you know of other additional requirements drop me a note.
4089		5144
…		…
4151	=item Processing ev_async_send: O(number_of_async_watchers)	5206	=item Processing ev_async_send: O(number_of_async_watchers)
4152		5207
4153	=item Processing signals: O(max_signal_number)	5208	=item Processing signals: O(max_signal_number)
4154		5209
4155	Sending involves a system call I<iff> there were no other C<ev_async_send>	5210	Sending involves a system call I<iff> there were no other C<ev_async_send>
4156	calls in the current loop iteration. Checking for async and signal events	5211	calls in the current loop iteration and the loop is currently
		5212	blocked. Checking for async and signal events involves iterating over all
4157	involves iterating over all running async watchers or all signal numbers.	5213	running async watchers or all signal numbers.
4158		5214
4159	=back	5215	=back
4160		5216
4161		5217
		5218	=head1 PORTING FROM LIBEV 3.X TO 4.X
		5219
		5220	The major version 4 introduced some incompatible changes to the API.
		5221
		5222	At the moment, the C<ev.h> header file provides compatibility definitions
		5223	for all changes, so most programs should still compile. The compatibility
		5224	layer might be removed in later versions of libev, so better update to the
		5225	new API early than late.
		5226
		5227	=over 4
		5228
		5229	=item C<EV_COMPAT3> backwards compatibility mechanism
		5230
		5231	The backward compatibility mechanism can be controlled by
		5232	C<EV_COMPAT3>. See L<PREPROCESSOR SYMBOLS/MACROS> in the L<EMBEDDING>
		5233	section.
		5234
		5235	=item C<ev_default_destroy> and C<ev_default_fork> have been removed
		5236
		5237	These calls can be replaced easily by their C<ev_loop_xxx> counterparts:
		5238
		5239	ev_loop_destroy (EV_DEFAULT_UC);
		5240	ev_loop_fork (EV_DEFAULT);
		5241
		5242	=item function/symbol renames
		5243
		5244	A number of functions and symbols have been renamed:
		5245
		5246	ev_loop => ev_run
		5247	EVLOOP_NONBLOCK => EVRUN_NOWAIT
		5248	EVLOOP_ONESHOT => EVRUN_ONCE
		5249
		5250	ev_unloop => ev_break
		5251	EVUNLOOP_CANCEL => EVBREAK_CANCEL
		5252	EVUNLOOP_ONE => EVBREAK_ONE
		5253	EVUNLOOP_ALL => EVBREAK_ALL
		5254
		5255	EV_TIMEOUT => EV_TIMER
		5256
		5257	ev_loop_count => ev_iteration
		5258	ev_loop_depth => ev_depth
		5259	ev_loop_verify => ev_verify
		5260
		5261	Most functions working on C<struct ev_loop> objects don't have an
		5262	C<ev_loop_> prefix, so it was removed; C<ev_loop>, C<ev_unloop> and
		5263	associated constants have been renamed to not collide with the C<struct
		5264	ev_loop> anymore and C<EV_TIMER> now follows the same naming scheme
		5265	as all other watcher types. Note that C<ev_loop_fork> is still called
		5266	C<ev_loop_fork> because it would otherwise clash with the C<ev_fork>
		5267	typedef.
		5268
		5269	=item C<EV_MINIMAL> mechanism replaced by C<EV_FEATURES>
		5270
		5271	The preprocessor symbol C<EV_MINIMAL> has been replaced by a different
		5272	mechanism, C<EV_FEATURES>. Programs using C<EV_MINIMAL> usually compile
		5273	and work, but the library code will of course be larger.
		5274
		5275	=back
		5276
		5277
4162	=head1 GLOSSARY	5278	=head1 GLOSSARY
4163		5279
4164	=over 4	5280	=over 4
4165		5281
4166	=item active	5282	=item active
4167		5283
4168	A watcher is active as long as it has been started (has been attached to	5284	A watcher is active as long as it has been started and not yet stopped.
4169	an event loop) but not yet stopped (disassociated from the event loop).	5285	See L<WATCHER STATES> for details.
4170		5286
4171	=item application	5287	=item application
4172		5288
4173	In this document, an application is whatever is using libev.	5289	In this document, an application is whatever is using libev.
		5290
		5291	=item backend
		5292
		5293	The part of the code dealing with the operating system interfaces.
4174		5294
4175	=item callback	5295	=item callback
4176		5296
4177	The address of a function that is called when some event has been	5297	The address of a function that is called when some event has been
4178	detected. Callbacks are being passed the event loop, the watcher that	5298	detected. Callbacks are being passed the event loop, the watcher that
4179	received the event, and the actual event bitset.	5299	received the event, and the actual event bitset.
4180		5300
4181	=item callback invocation	5301	=item callback/watcher invocation
4182		5302
4183	The act of calling the callback associated with a watcher.	5303	The act of calling the callback associated with a watcher.
4184		5304
4185	=item event	5305	=item event
4186		5306
4187	A change of state of some external event, such as data now being available	5307	A change of state of some external event, such as data now being available
4188	for reading on a file descriptor, time having passed or simply not having	5308	for reading on a file descriptor, time having passed or simply not having
4189	any other events happening anymore.	5309	any other events happening anymore.
4190		5310
4191	In libev, events are represented as single bits (such as C<EV_READ> or	5311	In libev, events are represented as single bits (such as C<EV_READ> or
4192	C<EV_TIMEOUT>).	5312	C<EV_TIMER>).
4193		5313
4194	=item event library	5314	=item event library
4195		5315
4196	A software package implementing an event model and loop.	5316	A software package implementing an event model and loop.
4197		5317
…		…
4205	The model used to describe how an event loop handles and processes	5325	The model used to describe how an event loop handles and processes
4206	watchers and events.	5326	watchers and events.
4207		5327
4208	=item pending	5328	=item pending
4209		5329
4210	A watcher is pending as soon as the corresponding event has been detected,	5330	A watcher is pending as soon as the corresponding event has been
4211	and stops being pending as soon as the watcher will be invoked or its	5331	detected. See L<WATCHER STATES> for details.
4212	pending status is explicitly cleared by the application.
4213
4214	A watcher can be pending, but not active. Stopping a watcher also clears
4215	its pending status.
4216		5332
4217	=item real time	5333	=item real time
4218		5334
4219	The physical time that is observed. It is apparently strictly monotonic :)	5335	The physical time that is observed. It is apparently strictly monotonic :)
4220		5336
4221	=item wall-clock time	5337	=item wall-clock time
4222		5338
4223	The time and date as shown on clocks. Unlike real time, it can actually	5339	The time and date as shown on clocks. Unlike real time, it can actually
4224	be wrong and jump forwards and backwards, e.g. when the you adjust your	5340	be wrong and jump forwards and backwards, e.g. when you adjust your
4225	clock.	5341	clock.
4226		5342
4227	=item watcher	5343	=item watcher
4228		5344
4229	A data structure that describes interest in certain events. Watchers need	5345	A data structure that describes interest in certain events. Watchers need
4230	to be started (attached to an event loop) before they can receive events.	5346	to be started (attached to an event loop) before they can receive events.
4231		5347
4232	=item watcher invocation
4233
4234	The act of calling the callback associated with a watcher.
4235
4236	=back	5348	=back
4237		5349
4238	=head1 AUTHOR	5350	=head1 AUTHOR
4239		5351
4240	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson.	5352	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael
		5353	Magnusson and Emanuele Giaquinta, and minor corrections by many others.
4241		5354

Diff Legend

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