ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.65 by ayin, Sat Dec 1 15:38:54 2007 UTC vs.
Revision 1.112 by root, Wed Dec 26 08:06:09 2007 UTC

…		…
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	#include <ev.h>	7	#include <ev.h>
8		8
9	=head1 EXAMPLE PROGRAM	9	=head2 EXAMPLE PROGRAM
10		10
11	#include <ev.h>	11	#include <ev.h>
12		12
13	ev_io stdin_watcher;	13	ev_io stdin_watcher;
14	ev_timer timeout_watcher;	14	ev_timer timeout_watcher;
…		…
48	return 0;	48	return 0;
49	}	49	}
50		50
51	=head1 DESCRIPTION	51	=head1 DESCRIPTION
52		52
		53	The newest version of this document is also available as a html-formatted
		54	web page you might find easier to navigate when reading it for the first
		55	time: L<http://cvs.schmorp.de/libev/ev.html>.
		56
53	Libev is an event loop: you register interest in certain events (such as a	57	Libev is an event loop: you register interest in certain events (such as a
54	file descriptor being readable or a timeout occuring), and it will manage	58	file descriptor being readable or a timeout occurring), and it will manage
55	these event sources and provide your program with events.	59	these event sources and provide your program with events.
56		60
57	To do this, it must take more or less complete control over your process	61	To do this, it must take more or less complete control over your process
58	(or thread) by executing the I<event loop> handler, and will then	62	(or thread) by executing the I<event loop> handler, and will then
59	communicate events via a callback mechanism.	63	communicate events via a callback mechanism.
…		…
61	You register interest in certain events by registering so-called I<event	65	You register interest in certain events by registering so-called I<event
62	watchers>, which are relatively small C structures you initialise with the	66	watchers>, which are relatively small C structures you initialise with the
63	details of the event, and then hand it over to libev by I<starting> the	67	details of the event, and then hand it over to libev by I<starting> the
64	watcher.	68	watcher.
65		69
66	=head1 FEATURES	70	=head2 FEATURES
67		71
68	Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the	72	Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the
69	BSD-specific C<kqueue> and the Solaris-specific event port mechanisms	73	BSD-specific C<kqueue> and the Solaris-specific event port mechanisms
70	for file descriptor events (C<ev_io>), the Linux C<inotify> interface	74	for file descriptor events (C<ev_io>), the Linux C<inotify> interface
71	(for C<ev_stat>), relative timers (C<ev_timer>), absolute timers	75	(for C<ev_stat>), relative timers (C<ev_timer>), absolute timers
…		…
78		82
79	It also is quite fast (see this	83	It also is quite fast (see this
80	L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent	84	L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent
81	for example).	85	for example).
82		86
83	=head1 CONVENTIONS	87	=head2 CONVENTIONS
84		88
85	Libev is very configurable. In this manual the default configuration will	89	Libev is very configurable. In this manual the default configuration will
86	be described, which supports multiple event loops. For more info about	90	be described, which supports multiple event loops. For more info about
87	various configuration options please have a look at B<EMBED> section in	91	various configuration options please have a look at B<EMBED> section in
88	this manual. If libev was configured without support for multiple event	92	this manual. If libev was configured without support for multiple event
89	loops, then all functions taking an initial argument of name C<loop>	93	loops, then all functions taking an initial argument of name C<loop>
90	(which is always of type C<struct ev_loop *>) will not have this argument.	94	(which is always of type C<struct ev_loop *>) will not have this argument.
91		95
92	=head1 TIME REPRESENTATION	96	=head2 TIME REPRESENTATION
93		97
94	Libev represents time as a single floating point number, representing the	98	Libev represents time as a single floating point number, representing the
95	(fractional) number of seconds since the (POSIX) epoch (somewhere near	99	(fractional) number of seconds since the (POSIX) epoch (somewhere near
96	the beginning of 1970, details are complicated, don't ask). This type is	100	the beginning of 1970, details are complicated, don't ask). This type is
97	called C<ev_tstamp>, which is what you should use too. It usually aliases	101	called C<ev_tstamp>, which is what you should use too. It usually aliases
98	to the C<double> type in C, and when you need to do any calculations on	102	to the C<double> type in C, and when you need to do any calculations on
99	it, you should treat it as such.	103	it, you should treat it as some floatingpoint value. Unlike the name
		104	component C<stamp> might indicate, it is also used for time differences
		105	throughout libev.
100		106
101	=head1 GLOBAL FUNCTIONS	107	=head1 GLOBAL FUNCTIONS
102		108
103	These functions can be called anytime, even before initialising the	109	These functions can be called anytime, even before initialising the
104	library in any way.	110	library in any way.
…		…
109		115
110	Returns the current time as libev would use it. Please note that the	116	Returns the current time as libev would use it. Please note that the
111	C<ev_now> function is usually faster and also often returns the timestamp	117	C<ev_now> function is usually faster and also often returns the timestamp
112	you actually want to know.	118	you actually want to know.
113		119
		120	=item ev_sleep (ev_tstamp interval)
		121
		122	Sleep for the given interval: The current thread will be blocked until
		123	either it is interrupted or the given time interval has passed. Basically
		124	this is a subsecond-resolution C<sleep ()>.
		125
114	=item int ev_version_major ()	126	=item int ev_version_major ()
115		127
116	=item int ev_version_minor ()	128	=item int ev_version_minor ()
117		129
118	You can find out the major and minor version numbers of the library	130	You can find out the major and minor ABI version numbers of the library
119	you linked against by calling the functions C<ev_version_major> and	131	you linked against by calling the functions C<ev_version_major> and
120	C<ev_version_minor>. If you want, you can compare against the global	132	C<ev_version_minor>. If you want, you can compare against the global
121	symbols C<EV_VERSION_MAJOR> and C<EV_VERSION_MINOR>, which specify the	133	symbols C<EV_VERSION_MAJOR> and C<EV_VERSION_MINOR>, which specify the
122	version of the library your program was compiled against.	134	version of the library your program was compiled against.
123		135
		136	These version numbers refer to the ABI version of the library, not the
		137	release version.
		138
124	Usually, it's a good idea to terminate if the major versions mismatch,	139	Usually, it's a good idea to terminate if the major versions mismatch,
125	as this indicates an incompatible change. Minor versions are usually	140	as this indicates an incompatible change. Minor versions are usually
126	compatible to older versions, so a larger minor version alone is usually	141	compatible to older versions, so a larger minor version alone is usually
127	not a problem.	142	not a problem.
128		143
129	Example: Make sure we haven't accidentally been linked against the wrong	144	Example: Make sure we haven't accidentally been linked against the wrong
130	version.	145	version.
…		…
291	=item C<EVBACKEND_SELECT> (value 1, portable select backend)	306	=item C<EVBACKEND_SELECT> (value 1, portable select backend)
292		307
293	This is your standard select(2) backend. Not I<completely> standard, as	308	This is your standard select(2) backend. Not I<completely> standard, as
294	libev tries to roll its own fd_set with no limits on the number of fds,	309	libev tries to roll its own fd_set with no limits on the number of fds,
295	but if that fails, expect a fairly low limit on the number of fds when	310	but if that fails, expect a fairly low limit on the number of fds when
296	using this backend. It doesn't scale too well (O(highest_fd)), but its usually	311	using this backend. It doesn't scale too well (O(highest_fd)), but its
297	the fastest backend for a low number of fds.	312	usually the fastest backend for a low number of (low-numbered :) fds.
		313
		314	To get good performance out of this backend you need a high amount of
		315	parallelity (most of the file descriptors should be busy). If you are
		316	writing a server, you should C<accept ()> in a loop to accept as many
		317	connections as possible during one iteration. You might also want to have
		318	a look at C<ev_set_io_collect_interval ()> to increase the amount of
		319	readyness notifications you get per iteration.
298		320
299	=item C<EVBACKEND_POLL> (value 2, poll backend, available everywhere except on windows)	321	=item C<EVBACKEND_POLL> (value 2, poll backend, available everywhere except on windows)
300		322
301	And this is your standard poll(2) backend. It's more complicated than	323	And this is your standard poll(2) backend. It's more complicated
302	select, but handles sparse fds better and has no artificial limit on the	324	than select, but handles sparse fds better and has no artificial
303	number of fds you can use (except it will slow down considerably with a	325	limit on the number of fds you can use (except it will slow down
304	lot of inactive fds). It scales similarly to select, i.e. O(total_fds).	326	considerably with a lot of inactive fds). It scales similarly to select,
		327	i.e. O(total_fds). See the entry for C<EVBACKEND_SELECT>, above, for
		328	performance tips.
305		329
306	=item C<EVBACKEND_EPOLL> (value 4, Linux)	330	=item C<EVBACKEND_EPOLL> (value 4, Linux)
307		331
308	For few fds, this backend is a bit little slower than poll and select,	332	For few fds, this backend is a bit little slower than poll and select,
309	but it scales phenomenally better. While poll and select usually scale like	333	but it scales phenomenally better. While poll and select usually scale
310	O(total_fds) where n is the total number of fds (or the highest fd), epoll scales	334	like O(total_fds) where n is the total number of fds (or the highest fd),
311	either O(1) or O(active_fds).	335	epoll scales either O(1) or O(active_fds). The epoll design has a number
		336	of shortcomings, such as silently dropping events in some hard-to-detect
		337	cases and rewiring a syscall per fd change, no fork support and bad
		338	support for dup.
312		339
313	While stopping and starting an I/O watcher in the same iteration will	340	While stopping, setting and starting an I/O watcher in the same iteration
314	result in some caching, there is still a syscall per such incident	341	will result in some caching, there is still a syscall per such incident
315	(because the fd could point to a different file description now), so its	342	(because the fd could point to a different file description now), so its
316	best to avoid that. Also, dup()ed file descriptors might not work very	343	best to avoid that. Also, C<dup ()>'ed file descriptors might not work
317	well if you register events for both fds.	344	very well if you register events for both fds.
318		345
319	Please note that epoll sometimes generates spurious notifications, so you	346	Please note that epoll sometimes generates spurious notifications, so you
320	need to use non-blocking I/O or other means to avoid blocking when no data	347	need to use non-blocking I/O or other means to avoid blocking when no data
321	(or space) is available.	348	(or space) is available.
322		349
		350	Best performance from this backend is achieved by not unregistering all
		351	watchers for a file descriptor until it has been closed, if possible, i.e.
		352	keep at least one watcher active per fd at all times.
		353
		354	While nominally embeddeble in other event loops, this feature is broken in
		355	all kernel versions tested so far.
		356
323	=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)	357	=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)
324		358
325	Kqueue deserves special mention, as at the time of this writing, it	359	Kqueue deserves special mention, as at the time of this writing, it
326	was broken on all BSDs except NetBSD (usually it doesn't work with	360	was broken on all BSDs except NetBSD (usually it doesn't work reliably
327	anything but sockets and pipes, except on Darwin, where of course its	361	with anything but sockets and pipes, except on Darwin, where of course
328	completely useless). For this reason its not being "autodetected"	362	it's completely useless). For this reason it's not being "autodetected"
329	unless you explicitly specify it explicitly in the flags (i.e. using	363	unless you explicitly specify it explicitly in the flags (i.e. using
330	C<EVBACKEND_KQUEUE>).	364	C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough)
		365	system like NetBSD.
		366
		367	You still can embed kqueue into a normal poll or select backend and use it
		368	only for sockets (after having made sure that sockets work with kqueue on
		369	the target platform). See C<ev_embed> watchers for more info.
331		370
332	It scales in the same way as the epoll backend, but the interface to the	371	It scales in the same way as the epoll backend, but the interface to the
333	kernel is more efficient (which says nothing about its actual speed, of	372	kernel is more efficient (which says nothing about its actual speed, of
334	course). While starting and stopping an I/O watcher does not cause an	373	course). While stopping, setting and starting an I/O watcher does never
335	extra syscall as with epoll, it still adds up to four event changes per	374	cause an extra syscall as with C<EVBACKEND_EPOLL>, it still adds up to
336	incident, so its best to avoid that.	375	two event changes per incident, support for C<fork ()> is very bad and it
		376	drops fds silently in similarly hard-to-detect cases.
		377
		378	This backend usually performs well under most conditions.
		379
		380	While nominally embeddable in other event loops, this doesn't work
		381	everywhere, so you might need to test for this. And since it is broken
		382	almost everywhere, you should only use it when you have a lot of sockets
		383	(for which it usually works), by embedding it into another event loop
		384	(e.g. C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>) and using it only for
		385	sockets.
337		386
338	=item C<EVBACKEND_DEVPOLL> (value 16, Solaris 8)	387	=item C<EVBACKEND_DEVPOLL> (value 16, Solaris 8)
339		388
340	This is not implemented yet (and might never be).	389	This is not implemented yet (and might never be, unless you send me an
		390	implementation). According to reports, C</dev/poll> only supports sockets
		391	and is not embeddable, which would limit the usefulness of this backend
		392	immensely.
341		393
342	=item C<EVBACKEND_PORT> (value 32, Solaris 10)	394	=item C<EVBACKEND_PORT> (value 32, Solaris 10)
343		395
344	This uses the Solaris 10 port mechanism. As with everything on Solaris,	396	This uses the Solaris 10 event port mechanism. As with everything on Solaris,
345	it's really slow, but it still scales very well (O(active_fds)).	397	it's really slow, but it still scales very well (O(active_fds)).
346		398
347	Please note that solaris ports can result in a lot of spurious	399	Please note that solaris event ports can deliver a lot of spurious
348	notifications, so you need to use non-blocking I/O or other means to avoid	400	notifications, so you need to use non-blocking I/O or other means to avoid
349	blocking when no data (or space) is available.	401	blocking when no data (or space) is available.
		402
		403	While this backend scales well, it requires one system call per active
		404	file descriptor per loop iteration. For small and medium numbers of file
		405	descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend
		406	might perform better.
350		407
351	=item C<EVBACKEND_ALL>	408	=item C<EVBACKEND_ALL>
352		409
353	Try all backends (even potentially broken ones that wouldn't be tried	410	Try all backends (even potentially broken ones that wouldn't be tried
354	with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as	411	with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as
355	C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>.	412	C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>.
		413
		414	It is definitely not recommended to use this flag.
356		415
357	=back	416	=back
358		417
359	If one or more of these are ored into the flags value, then only these	418	If one or more of these are ored into the flags value, then only these
360	backends will be tried (in the reverse order as given here). If none are	419	backends will be tried (in the reverse order as given here). If none are
…		…
395	Destroys the default loop again (frees all memory and kernel state	454	Destroys the default loop again (frees all memory and kernel state
396	etc.). None of the active event watchers will be stopped in the normal	455	etc.). None of the active event watchers will be stopped in the normal
397	sense, so e.g. C<ev_is_active> might still return true. It is your	456	sense, so e.g. C<ev_is_active> might still return true. It is your
398	responsibility to either stop all watchers cleanly yoursef I<before>	457	responsibility to either stop all watchers cleanly yoursef I<before>
399	calling this function, or cope with the fact afterwards (which is usually	458	calling this function, or cope with the fact afterwards (which is usually
400	the easiest thing, youc na just ignore the watchers and/or C<free ()> them	459	the easiest thing, you can just ignore the watchers and/or C<free ()> them
401	for example).	460	for example).
		461
		462	Note that certain global state, such as signal state, will not be freed by
		463	this function, and related watchers (such as signal and child watchers)
		464	would need to be stopped manually.
		465
		466	In general it is not advisable to call this function except in the
		467	rare occasion where you really need to free e.g. the signal handling
		468	pipe fds. If you need dynamically allocated loops it is better to use
		469	C<ev_loop_new> and C<ev_loop_destroy>).
402		470
403	=item ev_loop_destroy (loop)	471	=item ev_loop_destroy (loop)
404		472
405	Like C<ev_default_destroy>, but destroys an event loop created by an	473	Like C<ev_default_destroy>, but destroys an event loop created by an
406	earlier call to C<ev_loop_new>.	474	earlier call to C<ev_loop_new>.
…		…
430		498
431	Like C<ev_default_fork>, but acts on an event loop created by	499	Like C<ev_default_fork>, but acts on an event loop created by
432	C<ev_loop_new>. Yes, you have to call this on every allocated event loop	500	C<ev_loop_new>. Yes, you have to call this on every allocated event loop
433	after fork, and how you do this is entirely your own problem.	501	after fork, and how you do this is entirely your own problem.
434		502
		503	=item unsigned int ev_loop_count (loop)
		504
		505	Returns the count of loop iterations for the loop, which is identical to
		506	the number of times libev did poll for new events. It starts at C<0> and
		507	happily wraps around with enough iterations.
		508
		509	This value can sometimes be useful as a generation counter of sorts (it
		510	"ticks" the number of loop iterations), as it roughly corresponds with
		511	C<ev_prepare> and C<ev_check> calls.
		512
435	=item unsigned int ev_backend (loop)	513	=item unsigned int ev_backend (loop)
436		514
437	Returns one of the C<EVBACKEND_*> flags indicating the event backend in	515	Returns one of the C<EVBACKEND_*> flags indicating the event backend in
438	use.	516	use.
439		517
…		…
441		519
442	Returns the current "event loop time", which is the time the event loop	520	Returns the current "event loop time", which is the time the event loop
443	received events and started processing them. This timestamp does not	521	received events and started processing them. This timestamp does not
444	change as long as callbacks are being processed, and this is also the base	522	change as long as callbacks are being processed, and this is also the base
445	time used for relative timers. You can treat it as the timestamp of the	523	time used for relative timers. You can treat it as the timestamp of the
446	event occuring (or more correctly, libev finding out about it).	524	event occurring (or more correctly, libev finding out about it).
447		525
448	=item ev_loop (loop, int flags)	526	=item ev_loop (loop, int flags)
449		527
450	Finally, this is it, the event handler. This function usually is called	528	Finally, this is it, the event handler. This function usually is called
451	after you initialised all your watchers and you want to start handling	529	after you initialised all your watchers and you want to start handling
…		…
472	libev watchers. However, a pair of C<ev_prepare>/C<ev_check> watchers is	550	libev watchers. However, a pair of C<ev_prepare>/C<ev_check> watchers is
473	usually a better approach for this kind of thing.	551	usually a better approach for this kind of thing.
474		552
475	Here are the gory details of what C<ev_loop> does:	553	Here are the gory details of what C<ev_loop> does:
476		554
		555	- Before the first iteration, call any pending watchers.
477	* If there are no active watchers (reference count is zero), return.	556	* If there are no active watchers (reference count is zero), return.
478	- Queue prepare watchers and then call all outstanding watchers.	557	- Queue all prepare watchers and then call all outstanding watchers.
479	- If we have been forked, recreate the kernel state.	558	- If we have been forked, recreate the kernel state.
480	- Update the kernel state with all outstanding changes.	559	- Update the kernel state with all outstanding changes.
481	- Update the "event loop time".	560	- Update the "event loop time".
482	- Calculate for how long to block.	561	- Calculate for how long to block.
483	- Block the process, waiting for any events.	562	- Block the process, waiting for any events.
…		…
534	Example: For some weird reason, unregister the above signal handler again.	613	Example: For some weird reason, unregister the above signal handler again.
535		614
536	ev_ref (loop);	615	ev_ref (loop);
537	ev_signal_stop (loop, &exitsig);	616	ev_signal_stop (loop, &exitsig);
538		617
		618	=item ev_set_io_collect_interval (loop, ev_tstamp interval)
		619
		620	=item ev_set_timeout_collect_interval (loop, ev_tstamp interval)
		621
		622	These advanced functions influence the time that libev will spend waiting
		623	for events. Both are by default C<0>, meaning that libev will try to
		624	invoke timer/periodic callbacks and I/O callbacks with minimum latency.
		625
		626	Setting these to a higher value (the C<interval> I<must> be >= C<0>)
		627	allows libev to delay invocation of I/O and timer/periodic callbacks to
		628	increase efficiency of loop iterations.
		629
		630	The background is that sometimes your program runs just fast enough to
		631	handle one (or very few) event(s) per loop iteration. While this makes
		632	the program responsive, it also wastes a lot of CPU time to poll for new
		633	events, especially with backends like C<select ()> which have a high
		634	overhead for the actual polling but can deliver many events at once.
		635
		636	By setting a higher I<io collect interval> you allow libev to spend more
		637	time collecting I/O events, so you can handle more events per iteration,
		638	at the cost of increasing latency. Timeouts (both C<ev_periodic> and
		639	C<ev_timer>) will be not affected. Setting this to a non-null value will
		640	introduce an additional C<ev_sleep ()> call into most loop iterations.
		641
		642	Likewise, by setting a higher I<timeout collect interval> you allow libev
		643	to spend more time collecting timeouts, at the expense of increased
		644	latency (the watcher callback will be called later). C<ev_io> watchers
		645	will not be affected. Setting this to a non-null value will not introduce
		646	any overhead in libev.
		647
		648	Many (busy) programs can usually benefit by setting the io collect
		649	interval to a value near C<0.1> or so, which is often enough for
		650	interactive servers (of course not for games), likewise for timeouts. It
		651	usually doesn't make much sense to set it to a lower value than C<0.01>,
		652	as this approsaches the timing granularity of most systems.
		653
539	=back	654	=back
540		655
541		656
542	=head1 ANATOMY OF A WATCHER	657	=head1 ANATOMY OF A WATCHER
543		658
…		…
722	=item bool ev_is_pending (ev_TYPE *watcher)	837	=item bool ev_is_pending (ev_TYPE *watcher)
723		838
724	Returns a true value iff the watcher is pending, (i.e. it has outstanding	839	Returns a true value iff the watcher is pending, (i.e. it has outstanding
725	events but its callback has not yet been invoked). As long as a watcher	840	events but its callback has not yet been invoked). As long as a watcher
726	is pending (but not active) you must not call an init function on it (but	841	is pending (but not active) you must not call an init function on it (but
727	C<ev_TYPE_set> is safe) and you must make sure the watcher is available to	842	C<ev_TYPE_set> is safe), you must not change its priority, and you must
728	libev (e.g. you cnanot C<free ()> it).	843	make sure the watcher is available to libev (e.g. you cannot C<free ()>
		844	it).
729		845
730	=item callback ev_cb (ev_TYPE *watcher)	846	=item callback ev_cb (ev_TYPE *watcher)
731		847
732	Returns the callback currently set on the watcher.	848	Returns the callback currently set on the watcher.
733		849
734	=item ev_cb_set (ev_TYPE *watcher, callback)	850	=item ev_cb_set (ev_TYPE *watcher, callback)
735		851
736	Change the callback. You can change the callback at virtually any time	852	Change the callback. You can change the callback at virtually any time
737	(modulo threads).	853	(modulo threads).
		854
		855	=item ev_set_priority (ev_TYPE *watcher, priority)
		856
		857	=item int ev_priority (ev_TYPE *watcher)
		858
		859	Set and query the priority of the watcher. The priority is a small
		860	integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>
		861	(default: C<-2>). Pending watchers with higher priority will be invoked
		862	before watchers with lower priority, but priority will not keep watchers
		863	from being executed (except for C<ev_idle> watchers).
		864
		865	This means that priorities are I<only> used for ordering callback
		866	invocation after new events have been received. This is useful, for
		867	example, to reduce latency after idling, or more often, to bind two
		868	watchers on the same event and make sure one is called first.
		869
		870	If you need to suppress invocation when higher priority events are pending
		871	you need to look at C<ev_idle> watchers, which provide this functionality.
		872
		873	You I<must not> change the priority of a watcher as long as it is active or
		874	pending.
		875
		876	The default priority used by watchers when no priority has been set is
		877	always C<0>, which is supposed to not be too high and not be too low :).
		878
		879	Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is
		880	fine, as long as you do not mind that the priority value you query might
		881	or might not have been adjusted to be within valid range.
		882
		883	=item ev_invoke (loop, ev_TYPE *watcher, int revents)
		884
		885	Invoke the C<watcher> with the given C<loop> and C<revents>. Neither
		886	C<loop> nor C<revents> need to be valid as long as the watcher callback
		887	can deal with that fact.
		888
		889	=item int ev_clear_pending (loop, ev_TYPE *watcher)
		890
		891	If the watcher is pending, this function returns clears its pending status
		892	and returns its C<revents> bitset (as if its callback was invoked). If the
		893	watcher isn't pending it does nothing and returns C<0>.
738		894
739	=back	895	=back
740		896
741		897
742	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER	898	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
…		…
827	In general you can register as many read and/or write event watchers per	983	In general you can register as many read and/or write event watchers per
828	fd as you want (as long as you don't confuse yourself). Setting all file	984	fd as you want (as long as you don't confuse yourself). Setting all file
829	descriptors to non-blocking mode is also usually a good idea (but not	985	descriptors to non-blocking mode is also usually a good idea (but not
830	required if you know what you are doing).	986	required if you know what you are doing).
831		987
832	You have to be careful with dup'ed file descriptors, though. Some backends
833	(the linux epoll backend is a notable example) cannot handle dup'ed file
834	descriptors correctly if you register interest in two or more fds pointing
835	to the same underlying file/socket/etc. description (that is, they share
836	the same underlying "file open").
837
838	If you must do this, then force the use of a known-to-be-good backend	988	If you must do this, then force the use of a known-to-be-good backend
839	(at the time of this writing, this includes only C<EVBACKEND_SELECT> and	989	(at the time of this writing, this includes only C<EVBACKEND_SELECT> and
840	C<EVBACKEND_POLL>).	990	C<EVBACKEND_POLL>).
841		991
842	Another thing you have to watch out for is that it is quite easy to	992	Another thing you have to watch out for is that it is quite easy to
…		…
848	it is best to always use non-blocking I/O: An extra C<read>(2) returning	998	it is best to always use non-blocking I/O: An extra C<read>(2) returning
849	C<EAGAIN> is far preferable to a program hanging until some data arrives.	999	C<EAGAIN> is far preferable to a program hanging until some data arrives.
850		1000
851	If you cannot run the fd in non-blocking mode (for example you should not	1001	If you cannot run the fd in non-blocking mode (for example you should not
852	play around with an Xlib connection), then you have to seperately re-test	1002	play around with an Xlib connection), then you have to seperately re-test
853	wether a file descriptor is really ready with a known-to-be good interface	1003	whether a file descriptor is really ready with a known-to-be good interface
854	such as poll (fortunately in our Xlib example, Xlib already does this on	1004	such as poll (fortunately in our Xlib example, Xlib already does this on
855	its own, so its quite safe to use).	1005	its own, so its quite safe to use).
		1006
		1007	=head3 The special problem of disappearing file descriptors
		1008
		1009	Some backends (e.g. kqueue, epoll) need to be told about closing a file
		1010	descriptor (either by calling C<close> explicitly or by any other means,
		1011	such as C<dup>). The reason is that you register interest in some file
		1012	descriptor, but when it goes away, the operating system will silently drop
		1013	this interest. If another file descriptor with the same number then is
		1014	registered with libev, there is no efficient way to see that this is, in
		1015	fact, a different file descriptor.
		1016
		1017	To avoid having to explicitly tell libev about such cases, libev follows
		1018	the following policy: Each time C<ev_io_set> is being called, libev
		1019	will assume that this is potentially a new file descriptor, otherwise
		1020	it is assumed that the file descriptor stays the same. That means that
		1021	you I<have> to call C<ev_io_set> (or C<ev_io_init>) when you change the
		1022	descriptor even if the file descriptor number itself did not change.
		1023
		1024	This is how one would do it normally anyway, the important point is that
		1025	the libev application should not optimise around libev but should leave
		1026	optimisations to libev.
		1027
		1028	=head3 The special problem of dup'ed file descriptors
		1029
		1030	Some backends (e.g. epoll), cannot register events for file descriptors,
		1031	but only events for the underlying file descriptions. That means when you
		1032	have C<dup ()>'ed file descriptors or weirder constellations, and register
		1033	events for them, only one file descriptor might actually receive events.
		1034
		1035	There is no workaround possible except not registering events
		1036	for potentially C<dup ()>'ed file descriptors, or to resort to
		1037	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
		1038
		1039	=head3 The special problem of fork
		1040
		1041	Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit
		1042	useless behaviour. Libev fully supports fork, but needs to be told about
		1043	it in the child.
		1044
		1045	To support fork in your programs, you either have to call
		1046	C<ev_default_fork ()> or C<ev_loop_fork ()> after a fork in the child,
		1047	enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or
		1048	C<EVBACKEND_POLL>.
		1049
		1050
		1051	=head3 Watcher-Specific Functions
856		1052
857	=over 4	1053	=over 4
858		1054
859	=item ev_io_init (ev_io *, callback, int fd, int events)	1055	=item ev_io_init (ev_io *, callback, int fd, int events)
860		1056
…		…
871	=item int events [read-only]	1067	=item int events [read-only]
872		1068
873	The events being watched.	1069	The events being watched.
874		1070
875	=back	1071	=back
		1072
		1073	=head3 Examples
876		1074
877	Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well	1075	Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well
878	readable, but only once. Since it is likely line-buffered, you could	1076	readable, but only once. Since it is likely line-buffered, you could
879	attempt to read a whole line in the callback.	1077	attempt to read a whole line in the callback.
880		1078
…		…
913	ev_timer_set (&timer, after + ev_now () - ev_time (), 0.);	1111	ev_timer_set (&timer, after + ev_now () - ev_time (), 0.);
914		1112
915	The callback is guarenteed to be invoked only when its timeout has passed,	1113	The callback is guarenteed to be invoked only when its timeout has passed,
916	but if multiple timers become ready during the same loop iteration then	1114	but if multiple timers become ready during the same loop iteration then
917	order of execution is undefined.	1115	order of execution is undefined.
		1116
		1117	=head3 Watcher-Specific Functions and Data Members
918		1118
919	=over 4	1119	=over 4
920		1120
921	=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)	1121	=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
922		1122
…		…
976	or C<ev_timer_again> is called and determines the next timeout (if any),	1176	or C<ev_timer_again> is called and determines the next timeout (if any),
977	which is also when any modifications are taken into account.	1177	which is also when any modifications are taken into account.
978		1178
979	=back	1179	=back
980		1180
		1181	=head3 Examples
		1182
981	Example: Create a timer that fires after 60 seconds.	1183	Example: Create a timer that fires after 60 seconds.
982		1184
983	static void	1185	static void
984	one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents)	1186	one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents)
985	{	1187	{
…		…
1018	but on wallclock time (absolute time). You can tell a periodic watcher	1220	but on wallclock time (absolute time). You can tell a periodic watcher
1019	to trigger "at" some specific point in time. For example, if you tell a	1221	to trigger "at" some specific point in time. For example, if you tell a
1020	periodic watcher to trigger in 10 seconds (by specifiying e.g. C<ev_now ()	1222	periodic watcher to trigger in 10 seconds (by specifiying e.g. C<ev_now ()
1021	+ 10.>) and then reset your system clock to the last year, then it will	1223	+ 10.>) and then reset your system clock to the last year, then it will
1022	take a year to trigger the event (unlike an C<ev_timer>, which would trigger	1224	take a year to trigger the event (unlike an C<ev_timer>, which would trigger
1023	roughly 10 seconds later and of course not if you reset your system time	1225	roughly 10 seconds later).
1024	again).
1025		1226
1026	They can also be used to implement vastly more complex timers, such as	1227	They can also be used to implement vastly more complex timers, such as
1027	triggering an event on eahc midnight, local time.	1228	triggering an event on each midnight, local time or other, complicated,
		1229	rules.
1028		1230
1029	As with timers, the callback is guarenteed to be invoked only when the	1231	As with timers, the callback is guarenteed to be invoked only when the
1030	time (C<at>) has been passed, but if multiple periodic timers become ready	1232	time (C<at>) has been passed, but if multiple periodic timers become ready
1031	during the same loop iteration then order of execution is undefined.	1233	during the same loop iteration then order of execution is undefined.
1032		1234
		1235	=head3 Watcher-Specific Functions and Data Members
		1236
1033	=over 4	1237	=over 4
1034		1238
1035	=item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)	1239	=item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)
1036		1240
1037	=item ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)	1241	=item ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)
…		…
1039	Lots of arguments, lets sort it out... There are basically three modes of	1243	Lots of arguments, lets sort it out... There are basically three modes of
1040	operation, and we will explain them from simplest to complex:	1244	operation, and we will explain them from simplest to complex:
1041		1245
1042	=over 4	1246	=over 4
1043		1247
1044	=item * absolute timer (interval = reschedule_cb = 0)	1248	=item * absolute timer (at = time, interval = reschedule_cb = 0)
1045		1249
1046	In this configuration the watcher triggers an event at the wallclock time	1250	In this configuration the watcher triggers an event at the wallclock time
1047	C<at> and doesn't repeat. It will not adjust when a time jump occurs,	1251	C<at> and doesn't repeat. It will not adjust when a time jump occurs,
1048	that is, if it is to be run at January 1st 2011 then it will run when the	1252	that is, if it is to be run at January 1st 2011 then it will run when the
1049	system time reaches or surpasses this time.	1253	system time reaches or surpasses this time.
1050		1254
1051	=item * non-repeating interval timer (interval > 0, reschedule_cb = 0)	1255	=item * non-repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)
1052		1256
1053	In this mode the watcher will always be scheduled to time out at the next	1257	In this mode the watcher will always be scheduled to time out at the next
1054	C<at + N * interval> time (for some integer N) and then repeat, regardless	1258	C<at + N * interval> time (for some integer N, which can also be negative)
1055	of any time jumps.	1259	and then repeat, regardless of any time jumps.
1056		1260
1057	This can be used to create timers that do not drift with respect to system	1261	This can be used to create timers that do not drift with respect to system
1058	time:	1262	time:
1059		1263
1060	ev_periodic_set (&periodic, 0., 3600., 0);	1264	ev_periodic_set (&periodic, 0., 3600., 0);
…		…
1066		1270
1067	Another way to think about it (for the mathematically inclined) is that	1271	Another way to think about it (for the mathematically inclined) is that
1068	C<ev_periodic> will try to run the callback in this mode at the next possible	1272	C<ev_periodic> will try to run the callback in this mode at the next possible
1069	time where C<time = at (mod interval)>, regardless of any time jumps.	1273	time where C<time = at (mod interval)>, regardless of any time jumps.
1070		1274
		1275	For numerical stability it is preferable that the C<at> value is near
		1276	C<ev_now ()> (the current time), but there is no range requirement for
		1277	this value.
		1278
1071	=item * manual reschedule mode (reschedule_cb = callback)	1279	=item * manual reschedule mode (at and interval ignored, reschedule_cb = callback)
1072		1280
1073	In this mode the values for C<interval> and C<at> are both being	1281	In this mode the values for C<interval> and C<at> are both being
1074	ignored. Instead, each time the periodic watcher gets scheduled, the	1282	ignored. Instead, each time the periodic watcher gets scheduled, the
1075	reschedule callback will be called with the watcher as first, and the	1283	reschedule callback will be called with the watcher as first, and the
1076	current time as second argument.	1284	current time as second argument.
1077		1285
1078	NOTE: I<This callback MUST NOT stop or destroy any periodic watcher,	1286	NOTE: I<This callback MUST NOT stop or destroy any periodic watcher,
1079	ever, or make any event loop modifications>. If you need to stop it,	1287	ever, or make any event loop modifications>. If you need to stop it,
1080	return C<now + 1e30> (or so, fudge fudge) and stop it afterwards (e.g. by	1288	return C<now + 1e30> (or so, fudge fudge) and stop it afterwards (e.g. by
1081	starting a prepare watcher).	1289	starting an C<ev_prepare> watcher, which is legal).
1082		1290
1083	Its prototype is C<ev_tstamp (*reschedule_cb)(struct ev_periodic *w,	1291	Its prototype is C<ev_tstamp (*reschedule_cb)(struct ev_periodic *w,
1084	ev_tstamp now)>, e.g.:	1292	ev_tstamp now)>, e.g.:
1085		1293
1086	static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)	1294	static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)
…		…
1109	Simply stops and restarts the periodic watcher again. This is only useful	1317	Simply stops and restarts the periodic watcher again. This is only useful
1110	when you changed some parameters or the reschedule callback would return	1318	when you changed some parameters or the reschedule callback would return
1111	a different time than the last time it was called (e.g. in a crond like	1319	a different time than the last time it was called (e.g. in a crond like
1112	program when the crontabs have changed).	1320	program when the crontabs have changed).
1113		1321
		1322	=item ev_tstamp offset [read-write]
		1323
		1324	When repeating, this contains the offset value, otherwise this is the
		1325	absolute point in time (the C<at> value passed to C<ev_periodic_set>).
		1326
		1327	Can be modified any time, but changes only take effect when the periodic
		1328	timer fires or C<ev_periodic_again> is being called.
		1329
1114	=item ev_tstamp interval [read-write]	1330	=item ev_tstamp interval [read-write]
1115		1331
1116	The current interval value. Can be modified any time, but changes only	1332	The current interval value. Can be modified any time, but changes only
1117	take effect when the periodic timer fires or C<ev_periodic_again> is being	1333	take effect when the periodic timer fires or C<ev_periodic_again> is being
1118	called.	1334	called.
…		…
1121		1337
1122	The current reschedule callback, or C<0>, if this functionality is	1338	The current reschedule callback, or C<0>, if this functionality is
1123	switched off. Can be changed any time, but changes only take effect when	1339	switched off. Can be changed any time, but changes only take effect when
1124	the periodic timer fires or C<ev_periodic_again> is being called.	1340	the periodic timer fires or C<ev_periodic_again> is being called.
1125		1341
		1342	=item ev_tstamp at [read-only]
		1343
		1344	When active, contains the absolute time that the watcher is supposed to
		1345	trigger next.
		1346
1126	=back	1347	=back
		1348
		1349	=head3 Examples
1127		1350
1128	Example: Call a callback every hour, or, more precisely, whenever the	1351	Example: Call a callback every hour, or, more precisely, whenever the
1129	system clock is divisible by 3600. The callback invocation times have	1352	system clock is divisible by 3600. The callback invocation times have
1130	potentially a lot of jittering, but good long-term stability.	1353	potentially a lot of jittering, but good long-term stability.
1131		1354
…		…
1171	with the kernel (thus it coexists with your own signal handlers as long	1394	with the kernel (thus it coexists with your own signal handlers as long
1172	as you don't register any with libev). Similarly, when the last signal	1395	as you don't register any with libev). Similarly, when the last signal
1173	watcher for a signal is stopped libev will reset the signal handler to	1396	watcher for a signal is stopped libev will reset the signal handler to
1174	SIG_DFL (regardless of what it was set to before).	1397	SIG_DFL (regardless of what it was set to before).
1175		1398
		1399	=head3 Watcher-Specific Functions and Data Members
		1400
1176	=over 4	1401	=over 4
1177		1402
1178	=item ev_signal_init (ev_signal *, callback, int signum)	1403	=item ev_signal_init (ev_signal *, callback, int signum)
1179		1404
1180	=item ev_signal_set (ev_signal *, int signum)	1405	=item ev_signal_set (ev_signal *, int signum)
…		…
1191		1416
1192	=head2 C<ev_child> - watch out for process status changes	1417	=head2 C<ev_child> - watch out for process status changes
1193		1418
1194	Child watchers trigger when your process receives a SIGCHLD in response to	1419	Child watchers trigger when your process receives a SIGCHLD in response to
1195	some child status changes (most typically when a child of yours dies).	1420	some child status changes (most typically when a child of yours dies).
		1421
		1422	=head3 Watcher-Specific Functions and Data Members
1196		1423
1197	=over 4	1424	=over 4
1198		1425
1199	=item ev_child_init (ev_child *, callback, int pid)	1426	=item ev_child_init (ev_child *, callback, int pid)
1200		1427
…		…
1219		1446
1220	The process exit/trace status caused by C<rpid> (see your systems	1447	The process exit/trace status caused by C<rpid> (see your systems
1221	C<waitpid> and C<sys/wait.h> documentation for details).	1448	C<waitpid> and C<sys/wait.h> documentation for details).
1222		1449
1223	=back	1450	=back
		1451
		1452	=head3 Examples
1224		1453
1225	Example: Try to exit cleanly on SIGINT and SIGTERM.	1454	Example: Try to exit cleanly on SIGINT and SIGTERM.
1226		1455
1227	static void	1456	static void
1228	sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)	1457	sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)
…		…
1269	semantics of C<ev_stat> watchers, which means that libev sometimes needs	1498	semantics of C<ev_stat> watchers, which means that libev sometimes needs
1270	to fall back to regular polling again even with inotify, but changes are	1499	to fall back to regular polling again even with inotify, but changes are
1271	usually detected immediately, and if the file exists there will be no	1500	usually detected immediately, and if the file exists there will be no
1272	polling.	1501	polling.
1273		1502
		1503	=head3 Inotify
		1504
		1505	When C<inotify (7)> support has been compiled into libev (generally only
		1506	available on Linux) and present at runtime, it will be used to speed up
		1507	change detection where possible. The inotify descriptor will be created lazily
		1508	when the first C<ev_stat> watcher is being started.
		1509
		1510	Inotify presense does not change the semantics of C<ev_stat> watchers
		1511	except that changes might be detected earlier, and in some cases, to avoid
		1512	making regular C<stat> calls. Even in the presense of inotify support
		1513	there are many cases where libev has to resort to regular C<stat> polling.
		1514
		1515	(There is no support for kqueue, as apparently it cannot be used to
		1516	implement this functionality, due to the requirement of having a file
		1517	descriptor open on the object at all times).
		1518
		1519	=head3 The special problem of stat time resolution
		1520
		1521	The C<stat ()> syscall only supports full-second resolution portably, and
		1522	even on systems where the resolution is higher, many filesystems still
		1523	only support whole seconds.
		1524
		1525	That means that, if the time is the only thing that changes, you might
		1526	miss updates: on the first update, C<ev_stat> detects a change and calls
		1527	your callback, which does something. When there is another update within
		1528	the same second, C<ev_stat> will be unable to detect it.
		1529
		1530	The solution to this is to delay acting on a change for a second (or till
		1531	the next second boundary), using a roughly one-second delay C<ev_timer>
		1532	(C<ev_timer_set (w, 0., 1.01); ev_timer_again (loop, w)>). The C<.01>
		1533	is added to work around small timing inconsistencies of some operating
		1534	systems.
		1535
		1536	=head3 Watcher-Specific Functions and Data Members
		1537
1274	=over 4	1538	=over 4
1275		1539
1276	=item ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)	1540	=item ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)
1277		1541
1278	=item ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)	1542	=item ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)
…		…
1313	=item const char *path [read-only]	1577	=item const char *path [read-only]
1314		1578
1315	The filesystem path that is being watched.	1579	The filesystem path that is being watched.
1316		1580
1317	=back	1581	=back
		1582
		1583	=head3 Examples
1318		1584
1319	Example: Watch C</etc/passwd> for attribute changes.	1585	Example: Watch C</etc/passwd> for attribute changes.
1320		1586
1321	static void	1587	static void
1322	passwd_cb (struct ev_loop *loop, ev_stat *w, int revents)	1588	passwd_cb (struct ev_loop *loop, ev_stat *w, int revents)
…		…
1335	}	1601	}
1336		1602
1337	...	1603	...
1338	ev_stat passwd;	1604	ev_stat passwd;
1339		1605
1340	ev_stat_init (&passwd, passwd_cb, "/etc/passwd");	1606	ev_stat_init (&passwd, passwd_cb, "/etc/passwd", 0.);
1341	ev_stat_start (loop, &passwd);	1607	ev_stat_start (loop, &passwd);
1342		1608
		1609	Example: Like above, but additionally use a one-second delay so we do not
		1610	miss updates (however, frequent updates will delay processing, too, so
		1611	one might do the work both on C<ev_stat> callback invocation I<and> on
		1612	C<ev_timer> callback invocation).
		1613
		1614	static ev_stat passwd;
		1615	static ev_timer timer;
		1616
		1617	static void
		1618	timer_cb (EV_P_ ev_timer *w, int revents)
		1619	{
		1620	ev_timer_stop (EV_A_ w);
		1621
		1622	/* now it's one second after the most recent passwd change */
		1623	}
		1624
		1625	static void
		1626	stat_cb (EV_P_ ev_stat *w, int revents)
		1627	{
		1628	/* reset the one-second timer */
		1629	ev_timer_again (EV_A_ &timer);
		1630	}
		1631
		1632	...
		1633	ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.);
		1634	ev_stat_start (loop, &passwd);
		1635	ev_timer_init (&timer, timer_cb, 0., 1.01);
		1636
1343		1637
1344	=head2 C<ev_idle> - when you've got nothing better to do...	1638	=head2 C<ev_idle> - when you've got nothing better to do...
1345		1639
1346	Idle watchers trigger events when there are no other events are pending	1640	Idle watchers trigger events when no other events of the same or higher
1347	(prepare, check and other idle watchers do not count). That is, as long	1641	priority are pending (prepare, check and other idle watchers do not
1348	as your process is busy handling sockets or timeouts (or even signals,	1642	count).
1349	imagine) it will not be triggered. But when your process is idle all idle	1643
1350	watchers are being called again and again, once per event loop iteration -	1644	That is, as long as your process is busy handling sockets or timeouts
		1645	(or even signals, imagine) of the same or higher priority it will not be
		1646	triggered. But when your process is idle (or only lower-priority watchers
		1647	are pending), the idle watchers are being called once per event loop
1351	until stopped, that is, or your process receives more events and becomes	1648	iteration - until stopped, that is, or your process receives more events
1352	busy.	1649	and becomes busy again with higher priority stuff.
1353		1650
1354	The most noteworthy effect is that as long as any idle watchers are	1651	The most noteworthy effect is that as long as any idle watchers are
1355	active, the process will not block when waiting for new events.	1652	active, the process will not block when waiting for new events.
1356		1653
1357	Apart from keeping your process non-blocking (which is a useful	1654	Apart from keeping your process non-blocking (which is a useful
1358	effect on its own sometimes), idle watchers are a good place to do	1655	effect on its own sometimes), idle watchers are a good place to do
1359	"pseudo-background processing", or delay processing stuff to after the	1656	"pseudo-background processing", or delay processing stuff to after the
1360	event loop has handled all outstanding events.	1657	event loop has handled all outstanding events.
1361		1658
		1659	=head3 Watcher-Specific Functions and Data Members
		1660
1362	=over 4	1661	=over 4
1363		1662
1364	=item ev_idle_init (ev_signal *, callback)	1663	=item ev_idle_init (ev_signal *, callback)
1365		1664
1366	Initialises and configures the idle watcher - it has no parameters of any	1665	Initialises and configures the idle watcher - it has no parameters of any
1367	kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,	1666	kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,
1368	believe me.	1667	believe me.
1369		1668
1370	=back	1669	=back
		1670
		1671	=head3 Examples
1371		1672
1372	Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the	1673	Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the
1373	callback, free it. Also, use no error checking, as usual.	1674	callback, free it. Also, use no error checking, as usual.
1374		1675
1375	static void	1676	static void
…		…
1423	with priority higher than or equal to the event loop and one coroutine	1724	with priority higher than or equal to the event loop and one coroutine
1424	of lower priority, but only once, using idle watchers to keep the event	1725	of lower priority, but only once, using idle watchers to keep the event
1425	loop from blocking if lower-priority coroutines are active, thus mapping	1726	loop from blocking if lower-priority coroutines are active, thus mapping
1426	low-priority coroutines to idle/background tasks).	1727	low-priority coroutines to idle/background tasks).
1427		1728
		1729	It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>)
		1730	priority, to ensure that they are being run before any other watchers
		1731	after the poll. Also, C<ev_check> watchers (and C<ev_prepare> watchers,
		1732	too) should not activate ("feed") events into libev. While libev fully
		1733	supports this, they will be called before other C<ev_check> watchers
		1734	did their job. As C<ev_check> watchers are often used to embed other
		1735	(non-libev) event loops those other event loops might be in an unusable
		1736	state until their C<ev_check> watcher ran (always remind yourself to
		1737	coexist peacefully with others).
		1738
		1739	=head3 Watcher-Specific Functions and Data Members
		1740
1428	=over 4	1741	=over 4
1429		1742
1430	=item ev_prepare_init (ev_prepare *, callback)	1743	=item ev_prepare_init (ev_prepare *, callback)
1431		1744
1432	=item ev_check_init (ev_check *, callback)	1745	=item ev_check_init (ev_check *, callback)
…		…
1435	parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>	1748	parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>
1436	macros, but using them is utterly, utterly and completely pointless.	1749	macros, but using them is utterly, utterly and completely pointless.
1437		1750
1438	=back	1751	=back
1439		1752
1440	Example: To include a library such as adns, you would add IO watchers	1753	=head3 Examples
1441	and a timeout watcher in a prepare handler, as required by libadns, and	1754
		1755	There are a number of principal ways to embed other event loops or modules
		1756	into libev. Here are some ideas on how to include libadns into libev
		1757	(there is a Perl module named C<EV::ADNS> that does this, which you could
		1758	use for an actually working example. Another Perl module named C<EV::Glib>
		1759	embeds a Glib main context into libev, and finally, C<Glib::EV> embeds EV
		1760	into the Glib event loop).
		1761
		1762	Method 1: Add IO watchers and a timeout watcher in a prepare handler,
1442	in a check watcher, destroy them and call into libadns. What follows is	1763	and in a check watcher, destroy them and call into libadns. What follows
1443	pseudo-code only of course:	1764	is pseudo-code only of course. This requires you to either use a low
		1765	priority for the check watcher or use C<ev_clear_pending> explicitly, as
		1766	the callbacks for the IO/timeout watchers might not have been called yet.
1444		1767
1445	static ev_io iow [nfd];	1768	static ev_io iow [nfd];
1446	static ev_timer tw;	1769	static ev_timer tw;
1447		1770
1448	static void	1771	static void
1449	io_cb (ev_loop *loop, ev_io *w, int revents)	1772	io_cb (ev_loop *loop, ev_io *w, int revents)
1450	{	1773	{
1451	// set the relevant poll flags
1452	// could also call adns_processreadable etc. here
1453	struct pollfd *fd = (struct pollfd *)w->data;
1454	if (revents & EV_READ ) fd->revents |= fd->events & POLLIN;
1455	if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT;
1456	}	1774	}
1457		1775
1458	// create io watchers for each fd and a timer before blocking	1776	// create io watchers for each fd and a timer before blocking
1459	static void	1777	static void
1460	adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents)	1778	adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents)
…		…
1466		1784
1467	/* the callback is illegal, but won't be called as we stop during check */	1785	/* the callback is illegal, but won't be called as we stop during check */
1468	ev_timer_init (&tw, 0, timeout * 1e-3);	1786	ev_timer_init (&tw, 0, timeout * 1e-3);
1469	ev_timer_start (loop, &tw);	1787	ev_timer_start (loop, &tw);
1470		1788
1471	// create on ev_io per pollfd	1789	// create one ev_io per pollfd
1472	for (int i = 0; i < nfd; ++i)	1790	for (int i = 0; i < nfd; ++i)
1473	{	1791	{
1474	ev_io_init (iow + i, io_cb, fds [i].fd,	1792	ev_io_init (iow + i, io_cb, fds [i].fd,
1475	((fds [i].events & POLLIN ? EV_READ : 0)	1793	((fds [i].events & POLLIN ? EV_READ : 0)
1476	| (fds [i].events & POLLOUT ? EV_WRITE : 0)));	1794	| (fds [i].events & POLLOUT ? EV_WRITE : 0)));
1477		1795
1478	fds [i].revents = 0;	1796	fds [i].revents = 0;
1479	iow [i].data = fds + i;
1480	ev_io_start (loop, iow + i);	1797	ev_io_start (loop, iow + i);
1481	}	1798	}
1482	}	1799	}
1483		1800
1484	// stop all watchers after blocking	1801	// stop all watchers after blocking
…		…
1486	adns_check_cb (ev_loop *loop, ev_check *w, int revents)	1803	adns_check_cb (ev_loop *loop, ev_check *w, int revents)
1487	{	1804	{
1488	ev_timer_stop (loop, &tw);	1805	ev_timer_stop (loop, &tw);
1489		1806
1490	for (int i = 0; i < nfd; ++i)	1807	for (int i = 0; i < nfd; ++i)
		1808	{
		1809	// set the relevant poll flags
		1810	// could also call adns_processreadable etc. here
		1811	struct pollfd *fd = fds + i;
		1812	int revents = ev_clear_pending (iow + i);
		1813	if (revents & EV_READ ) fd->revents |= fd->events & POLLIN;
		1814	if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT;
		1815
		1816	// now stop the watcher
1491	ev_io_stop (loop, iow + i);	1817	ev_io_stop (loop, iow + i);
		1818	}
1492		1819
1493	adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));	1820	adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));
		1821	}
		1822
		1823	Method 2: This would be just like method 1, but you run C<adns_afterpoll>
		1824	in the prepare watcher and would dispose of the check watcher.
		1825
		1826	Method 3: If the module to be embedded supports explicit event
		1827	notification (adns does), you can also make use of the actual watcher
		1828	callbacks, and only destroy/create the watchers in the prepare watcher.
		1829
		1830	static void
		1831	timer_cb (EV_P_ ev_timer *w, int revents)
		1832	{
		1833	adns_state ads = (adns_state)w->data;
		1834	update_now (EV_A);
		1835
		1836	adns_processtimeouts (ads, &tv_now);
		1837	}
		1838
		1839	static void
		1840	io_cb (EV_P_ ev_io *w, int revents)
		1841	{
		1842	adns_state ads = (adns_state)w->data;
		1843	update_now (EV_A);
		1844
		1845	if (revents & EV_READ ) adns_processreadable (ads, w->fd, &tv_now);
		1846	if (revents & EV_WRITE) adns_processwriteable (ads, w->fd, &tv_now);
		1847	}
		1848
		1849	// do not ever call adns_afterpoll
		1850
		1851	Method 4: Do not use a prepare or check watcher because the module you
		1852	want to embed is too inflexible to support it. Instead, youc na override
		1853	their poll function. The drawback with this solution is that the main
		1854	loop is now no longer controllable by EV. The C<Glib::EV> module does
		1855	this.
		1856
		1857	static gint
		1858	event_poll_func (GPollFD *fds, guint nfds, gint timeout)
		1859	{
		1860	int got_events = 0;
		1861
		1862	for (n = 0; n < nfds; ++n)
		1863	// create/start io watcher that sets the relevant bits in fds[n] and increment got_events
		1864
		1865	if (timeout >= 0)
		1866	// create/start timer
		1867
		1868	// poll
		1869	ev_loop (EV_A_ 0);
		1870
		1871	// stop timer again
		1872	if (timeout >= 0)
		1873	ev_timer_stop (EV_A_ &to);
		1874
		1875	// stop io watchers again - their callbacks should have set
		1876	for (n = 0; n < nfds; ++n)
		1877	ev_io_stop (EV_A_ iow [n]);
		1878
		1879	return got_events;
1494	}	1880	}
1495		1881
1496		1882
1497	=head2 C<ev_embed> - when one backend isn't enough...	1883	=head2 C<ev_embed> - when one backend isn't enough...
1498		1884
…		…
1541	portable one.	1927	portable one.
1542		1928
1543	So when you want to use this feature you will always have to be prepared	1929	So when you want to use this feature you will always have to be prepared
1544	that you cannot get an embeddable loop. The recommended way to get around	1930	that you cannot get an embeddable loop. The recommended way to get around
1545	this is to have a separate variables for your embeddable loop, try to	1931	this is to have a separate variables for your embeddable loop, try to
1546	create it, and if that fails, use the normal loop for everything:	1932	create it, and if that fails, use the normal loop for everything.
		1933
		1934	=head3 Watcher-Specific Functions and Data Members
		1935
		1936	=over 4
		1937
		1938	=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)
		1939
		1940	=item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)
		1941
		1942	Configures the watcher to embed the given loop, which must be
		1943	embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be
		1944	invoked automatically, otherwise it is the responsibility of the callback
		1945	to invoke it (it will continue to be called until the sweep has been done,
		1946	if you do not want thta, you need to temporarily stop the embed watcher).
		1947
		1948	=item ev_embed_sweep (loop, ev_embed *)
		1949
		1950	Make a single, non-blocking sweep over the embedded loop. This works
		1951	similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most
		1952	apropriate way for embedded loops.
		1953
		1954	=item struct ev_loop *other [read-only]
		1955
		1956	The embedded event loop.
		1957
		1958	=back
		1959
		1960	=head3 Examples
		1961
		1962	Example: Try to get an embeddable event loop and embed it into the default
		1963	event loop. If that is not possible, use the default loop. The default
		1964	loop is stored in C<loop_hi>, while the mebeddable loop is stored in
		1965	C<loop_lo> (which is C<loop_hi> in the acse no embeddable loop can be
		1966	used).
1547		1967
1548	struct ev_loop *loop_hi = ev_default_init (0);	1968	struct ev_loop *loop_hi = ev_default_init (0);
1549	struct ev_loop *loop_lo = 0;	1969	struct ev_loop *loop_lo = 0;
1550	struct ev_embed embed;	1970	struct ev_embed embed;
1551		1971
…		…
1562	ev_embed_start (loop_hi, &embed);	1982	ev_embed_start (loop_hi, &embed);
1563	}	1983	}
1564	else	1984	else
1565	loop_lo = loop_hi;	1985	loop_lo = loop_hi;
1566		1986
1567	=over 4	1987	Example: Check if kqueue is available but not recommended and create
		1988	a kqueue backend for use with sockets (which usually work with any
		1989	kqueue implementation). Store the kqueue/socket-only event loop in
		1990	C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).
1568		1991
1569	=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)	1992	struct ev_loop *loop = ev_default_init (0);
		1993	struct ev_loop *loop_socket = 0;
		1994	struct ev_embed embed;
		1995
		1996	if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
		1997	if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
		1998	{
		1999	ev_embed_init (&embed, 0, loop_socket);
		2000	ev_embed_start (loop, &embed);
		2001	}
1570		2002
1571	=item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)	2003	if (!loop_socket)
		2004	loop_socket = loop;
1572		2005
1573	Configures the watcher to embed the given loop, which must be	2006	// now use loop_socket for all sockets, and loop for everything else
1574	embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be
1575	invoked automatically, otherwise it is the responsibility of the callback
1576	to invoke it (it will continue to be called until the sweep has been done,
1577	if you do not want thta, you need to temporarily stop the embed watcher).
1578
1579	=item ev_embed_sweep (loop, ev_embed *)
1580
1581	Make a single, non-blocking sweep over the embedded loop. This works
1582	similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most
1583	apropriate way for embedded loops.
1584
1585	=item struct ev_loop *loop [read-only]
1586
1587	The embedded event loop.
1588
1589	=back
1590		2007
1591		2008
1592	=head2 C<ev_fork> - the audacity to resume the event loop after a fork	2009	=head2 C<ev_fork> - the audacity to resume the event loop after a fork
1593		2010
1594	Fork watchers are called when a C<fork ()> was detected (usually because	2011	Fork watchers are called when a C<fork ()> was detected (usually because
…		…
1597	event loop blocks next and before C<ev_check> watchers are being called,	2014	event loop blocks next and before C<ev_check> watchers are being called,
1598	and only in the child after the fork. If whoever good citizen calling	2015	and only in the child after the fork. If whoever good citizen calling
1599	C<ev_default_fork> cheats and calls it in the wrong process, the fork	2016	C<ev_default_fork> cheats and calls it in the wrong process, the fork
1600	handlers will be invoked, too, of course.	2017	handlers will be invoked, too, of course.
1601		2018
		2019	=head3 Watcher-Specific Functions and Data Members
		2020
1602	=over 4	2021	=over 4
1603		2022
1604	=item ev_fork_init (ev_signal *, callback)	2023	=item ev_fork_init (ev_signal *, callback)
1605		2024
1606	Initialises and configures the fork watcher - it has no parameters of any	2025	Initialises and configures the fork watcher - it has no parameters of any
…		…
1702		2121
1703	To use it,	2122	To use it,
1704		2123
1705	#include <ev++.h>	2124	#include <ev++.h>
1706		2125
1707	(it is not installed by default). This automatically includes F<ev.h>	2126	This automatically includes F<ev.h> and puts all of its definitions (many
1708	and puts all of its definitions (many of them macros) into the global	2127	of them macros) into the global namespace. All C++ specific things are
1709	namespace. All C++ specific things are put into the C<ev> namespace.	2128	put into the C<ev> namespace. It should support all the same embedding
		2129	options as F<ev.h>, most notably C<EV_MULTIPLICITY>.
1710		2130
1711	It should support all the same embedding options as F<ev.h>, most notably	2131	Care has been taken to keep the overhead low. The only data member the C++
1712	C<EV_MULTIPLICITY>.	2132	classes add (compared to plain C-style watchers) is the event loop pointer
		2133	that the watcher is associated with (or no additional members at all if
		2134	you disable C<EV_MULTIPLICITY> when embedding libev).
		2135
		2136	Currently, functions, and static and non-static member functions can be
		2137	used as callbacks. Other types should be easy to add as long as they only
		2138	need one additional pointer for context. If you need support for other
		2139	types of functors please contact the author (preferably after implementing
		2140	it).
1713		2141
1714	Here is a list of things available in the C<ev> namespace:	2142	Here is a list of things available in the C<ev> namespace:
1715		2143
1716	=over 4	2144	=over 4
1717		2145
…		…
1733		2161
1734	All of those classes have these methods:	2162	All of those classes have these methods:
1735		2163
1736	=over 4	2164	=over 4
1737		2165
1738	=item ev::TYPE::TYPE (object *, object::method *)	2166	=item ev::TYPE::TYPE ()
1739		2167
1740	=item ev::TYPE::TYPE (object *, object::method *, struct ev_loop *)	2168	=item ev::TYPE::TYPE (struct ev_loop *)
1741		2169
1742	=item ev::TYPE::~TYPE	2170	=item ev::TYPE::~TYPE
1743		2171
1744	The constructor takes a pointer to an object and a method pointer to	2172	The constructor (optionally) takes an event loop to associate the watcher
1745	the event handler callback to call in this class. The constructor calls	2173	with. If it is omitted, it will use C<EV_DEFAULT>.
1746	C<ev_init> for you, which means you have to call the C<set> method	2174
1747	before starting it. If you do not specify a loop then the constructor	2175	The constructor calls C<ev_init> for you, which means you have to call the
1748	automatically associates the default loop with this watcher.	2176	C<set> method before starting it.
		2177
		2178	It will not set a callback, however: You have to call the templated C<set>
		2179	method to set a callback before you can start the watcher.
		2180
		2181	(The reason why you have to use a method is a limitation in C++ which does
		2182	not allow explicit template arguments for constructors).
1749		2183
1750	The destructor automatically stops the watcher if it is active.	2184	The destructor automatically stops the watcher if it is active.
		2185
		2186	=item w->set<class, &class::method> (object *)
		2187
		2188	This method sets the callback method to call. The method has to have a
		2189	signature of C<void (*)(ev_TYPE &, int)>, it receives the watcher as
		2190	first argument and the C<revents> as second. The object must be given as
		2191	parameter and is stored in the C<data> member of the watcher.
		2192
		2193	This method synthesizes efficient thunking code to call your method from
		2194	the C callback that libev requires. If your compiler can inline your
		2195	callback (i.e. it is visible to it at the place of the C<set> call and
		2196	your compiler is good :), then the method will be fully inlined into the
		2197	thunking function, making it as fast as a direct C callback.
		2198
		2199	Example: simple class declaration and watcher initialisation
		2200
		2201	struct myclass
		2202	{
		2203	void io_cb (ev::io &w, int revents) { }
		2204	}
		2205
		2206	myclass obj;
		2207	ev::io iow;
		2208	iow.set <myclass, &myclass::io_cb> (&obj);
		2209
		2210	=item w->set<function> (void *data = 0)
		2211
		2212	Also sets a callback, but uses a static method or plain function as
		2213	callback. The optional C<data> argument will be stored in the watcher's
		2214	C<data> member and is free for you to use.
		2215
		2216	The prototype of the C<function> must be C<void (*)(ev::TYPE &w, int)>.
		2217
		2218	See the method-C<set> above for more details.
		2219
		2220	Example:
		2221
		2222	static void io_cb (ev::io &w, int revents) { }
		2223	iow.set <io_cb> ();
1751		2224
1752	=item w->set (struct ev_loop *)	2225	=item w->set (struct ev_loop *)
1753		2226
1754	Associates a different C<struct ev_loop> with this watcher. You can only	2227	Associates a different C<struct ev_loop> with this watcher. You can only
1755	do this when the watcher is inactive (and not pending either).	2228	do this when the watcher is inactive (and not pending either).
1756		2229
1757	=item w->set ([args])	2230	=item w->set ([args])
1758		2231
1759	Basically the same as C<ev_TYPE_set>, with the same args. Must be	2232	Basically the same as C<ev_TYPE_set>, with the same args. Must be
1760	called at least once. Unlike the C counterpart, an active watcher gets	2233	called at least once. Unlike the C counterpart, an active watcher gets
1761	automatically stopped and restarted.	2234	automatically stopped and restarted when reconfiguring it with this
		2235	method.
1762		2236
1763	=item w->start ()	2237	=item w->start ()
1764		2238
1765	Starts the watcher. Note that there is no C<loop> argument as the	2239	Starts the watcher. Note that there is no C<loop> argument, as the
1766	constructor already takes the loop.	2240	constructor already stores the event loop.
1767		2241
1768	=item w->stop ()	2242	=item w->stop ()
1769		2243
1770	Stops the watcher if it is active. Again, no C<loop> argument.	2244	Stops the watcher if it is active. Again, no C<loop> argument.
1771		2245
1772	=item w->again () C<ev::timer>, C<ev::periodic> only	2246	=item w->again () (C<ev::timer>, C<ev::periodic> only)
1773		2247
1774	For C<ev::timer> and C<ev::periodic>, this invokes the corresponding	2248	For C<ev::timer> and C<ev::periodic>, this invokes the corresponding
1775	C<ev_TYPE_again> function.	2249	C<ev_TYPE_again> function.
1776		2250
1777	=item w->sweep () C<ev::embed> only	2251	=item w->sweep () (C<ev::embed> only)
1778		2252
1779	Invokes C<ev_embed_sweep>.	2253	Invokes C<ev_embed_sweep>.
1780		2254
1781	=item w->update () C<ev::stat> only	2255	=item w->update () (C<ev::stat> only)
1782		2256
1783	Invokes C<ev_stat_stat>.	2257	Invokes C<ev_stat_stat>.
1784		2258
1785	=back	2259	=back
1786		2260
…		…
1796		2270
1797	myclass ();	2271	myclass ();
1798	}	2272	}
1799		2273
1800	myclass::myclass (int fd)	2274	myclass::myclass (int fd)
1801	: io (this, &myclass::io_cb),
1802	idle (this, &myclass::idle_cb)
1803	{	2275	{
		2276	io .set <myclass, &myclass::io_cb > (this);
		2277	idle.set <myclass, &myclass::idle_cb> (this);
		2278
1804	io.start (fd, ev::READ);	2279	io.start (fd, ev::READ);
1805	}	2280	}
1806		2281
1807		2282
1808	=head1 MACRO MAGIC	2283	=head1 MACRO MAGIC
1809		2284
1810	Libev can be compiled with a variety of options, the most fundemantal is	2285	Libev can be compiled with a variety of options, the most fundamantal
1811	C<EV_MULTIPLICITY>. This option determines wether (most) functions and	2286	of which is C<EV_MULTIPLICITY>. This option determines whether (most)
1812	callbacks have an initial C<struct ev_loop *> argument.	2287	functions and callbacks have an initial C<struct ev_loop *> argument.
1813		2288
1814	To make it easier to write programs that cope with either variant, the	2289	To make it easier to write programs that cope with either variant, the
1815	following macros are defined:	2290	following macros are defined:
1816		2291
1817	=over 4	2292	=over 4
…		…
1850	loop, if multiple loops are supported ("ev loop default").	2325	loop, if multiple loops are supported ("ev loop default").
1851		2326
1852	=back	2327	=back
1853		2328
1854	Example: Declare and initialise a check watcher, utilising the above	2329	Example: Declare and initialise a check watcher, utilising the above
1855	macros so it will work regardless of wether multiple loops are supported	2330	macros so it will work regardless of whether multiple loops are supported
1856	or not.	2331	or not.
1857		2332
1858	static void	2333	static void
1859	check_cb (EV_P_ ev_timer *w, int revents)	2334	check_cb (EV_P_ ev_timer *w, int revents)
1860	{	2335	{
…		…
1871	Libev can (and often is) directly embedded into host	2346	Libev can (and often is) directly embedded into host
1872	applications. Examples of applications that embed it include the Deliantra	2347	applications. Examples of applications that embed it include the Deliantra
1873	Game Server, the EV perl module, the GNU Virtual Private Ethernet (gvpe)	2348	Game Server, the EV perl module, the GNU Virtual Private Ethernet (gvpe)
1874	and rxvt-unicode.	2349	and rxvt-unicode.
1875		2350
1876	The goal is to enable you to just copy the neecssary files into your	2351	The goal is to enable you to just copy the necessary files into your
1877	source directory without having to change even a single line in them, so	2352	source directory without having to change even a single line in them, so
1878	you can easily upgrade by simply copying (or having a checked-out copy of	2353	you can easily upgrade by simply copying (or having a checked-out copy of
1879	libev somewhere in your source tree).	2354	libev somewhere in your source tree).
1880		2355
1881	=head2 FILESETS	2356	=head2 FILESETS
…		…
1971		2446
1972	If defined to be C<1>, libev will try to detect the availability of the	2447	If defined to be C<1>, libev will try to detect the availability of the
1973	monotonic clock option at both compiletime and runtime. Otherwise no use	2448	monotonic clock option at both compiletime and runtime. Otherwise no use
1974	of the monotonic clock option will be attempted. If you enable this, you	2449	of the monotonic clock option will be attempted. If you enable this, you
1975	usually have to link against librt or something similar. Enabling it when	2450	usually have to link against librt or something similar. Enabling it when
1976	the functionality isn't available is safe, though, althoguh you have	2451	the functionality isn't available is safe, though, although you have
1977	to make sure you link against any libraries where the C<clock_gettime>	2452	to make sure you link against any libraries where the C<clock_gettime>
1978	function is hiding in (often F<-lrt>).	2453	function is hiding in (often F<-lrt>).
1979		2454
1980	=item EV_USE_REALTIME	2455	=item EV_USE_REALTIME
1981		2456
1982	If defined to be C<1>, libev will try to detect the availability of the	2457	If defined to be C<1>, libev will try to detect the availability of the
1983	realtime clock option at compiletime (and assume its availability at	2458	realtime clock option at compiletime (and assume its availability at
1984	runtime if successful). Otherwise no use of the realtime clock option will	2459	runtime if successful). Otherwise no use of the realtime clock option will
1985	be attempted. This effectively replaces C<gettimeofday> by C<clock_get	2460	be attempted. This effectively replaces C<gettimeofday> by C<clock_get
1986	(CLOCK_REALTIME, ...)> and will not normally affect correctness. See tzhe note about libraries	2461	(CLOCK_REALTIME, ...)> and will not normally affect correctness. See the
1987	in the description of C<EV_USE_MONOTONIC>, though.	2462	note about libraries in the description of C<EV_USE_MONOTONIC>, though.
		2463
		2464	=item EV_USE_NANOSLEEP
		2465
		2466	If defined to be C<1>, libev will assume that C<nanosleep ()> is available
		2467	and will use it for delays. Otherwise it will use C<select ()>.
1988		2468
1989	=item EV_USE_SELECT	2469	=item EV_USE_SELECT
1990		2470
1991	If undefined or defined to be C<1>, libev will compile in support for the	2471	If undefined or defined to be C<1>, libev will compile in support for the
1992	C<select>(2) backend. No attempt at autodetection will be done: if no	2472	C<select>(2) backend. No attempt at autodetection will be done: if no
…		…
2010	wants osf handles on win32 (this is the case when the select to	2490	wants osf handles on win32 (this is the case when the select to
2011	be used is the winsock select). This means that it will call	2491	be used is the winsock select). This means that it will call
2012	C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise,	2492	C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise,
2013	it is assumed that all these functions actually work on fds, even	2493	it is assumed that all these functions actually work on fds, even
2014	on win32. Should not be defined on non-win32 platforms.	2494	on win32. Should not be defined on non-win32 platforms.
		2495
		2496	=item EV_FD_TO_WIN32_HANDLE
		2497
		2498	If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map
		2499	file descriptors to socket handles. When not defining this symbol (the
		2500	default), then libev will call C<_get_osfhandle>, which is usually
		2501	correct. In some cases, programs use their own file descriptor management,
		2502	in which case they can provide this function to map fds to socket handles.
2015		2503
2016	=item EV_USE_POLL	2504	=item EV_USE_POLL
2017		2505
2018	If defined to be C<1>, libev will compile in support for the C<poll>(2)	2506	If defined to be C<1>, libev will compile in support for the C<poll>(2)
2019	backend. Otherwise it will be enabled on non-win32 platforms. It	2507	backend. Otherwise it will be enabled on non-win32 platforms. It
…		…
2056	be detected at runtime.	2544	be detected at runtime.
2057		2545
2058	=item EV_H	2546	=item EV_H
2059		2547
2060	The name of the F<ev.h> header file used to include it. The default if	2548	The name of the F<ev.h> header file used to include it. The default if
2061	undefined is C<< <ev.h> >> in F<event.h> and C<"ev.h"> in F<ev.c>. This	2549	undefined is C<"ev.h"> in F<event.h> and F<ev.c>. This can be used to
2062	can be used to virtually rename the F<ev.h> header file in case of conflicts.	2550	virtually rename the F<ev.h> header file in case of conflicts.
2063		2551
2064	=item EV_CONFIG_H	2552	=item EV_CONFIG_H
2065		2553
2066	If C<EV_STANDALONE> isn't C<1>, this variable can be used to override	2554	If C<EV_STANDALONE> isn't C<1>, this variable can be used to override
2067	F<ev.c>'s idea of where to find the F<config.h> file, similarly to	2555	F<ev.c>'s idea of where to find the F<config.h> file, similarly to
2068	C<EV_H>, above.	2556	C<EV_H>, above.
2069		2557
2070	=item EV_EVENT_H	2558	=item EV_EVENT_H
2071		2559
2072	Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea	2560	Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea
2073	of how the F<event.h> header can be found.	2561	of how the F<event.h> header can be found, the dfeault is C<"event.h">.
2074		2562
2075	=item EV_PROTOTYPES	2563	=item EV_PROTOTYPES
2076		2564
2077	If defined to be C<0>, then F<ev.h> will not define any function	2565	If defined to be C<0>, then F<ev.h> will not define any function
2078	prototypes, but still define all the structs and other symbols. This is	2566	prototypes, but still define all the structs and other symbols. This is
…		…
2085	will have the C<struct ev_loop *> as first argument, and you can create	2573	will have the C<struct ev_loop *> as first argument, and you can create
2086	additional independent event loops. Otherwise there will be no support	2574	additional independent event loops. Otherwise there will be no support
2087	for multiple event loops and there is no first event loop pointer	2575	for multiple event loops and there is no first event loop pointer
2088	argument. Instead, all functions act on the single default loop.	2576	argument. Instead, all functions act on the single default loop.
2089		2577
		2578	=item EV_MINPRI
		2579
		2580	=item EV_MAXPRI
		2581
		2582	The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to
		2583	C<EV_MAXPRI>, but otherwise there are no non-obvious limitations. You can
		2584	provide for more priorities by overriding those symbols (usually defined
		2585	to be C<-2> and C<2>, respectively).
		2586
		2587	When doing priority-based operations, libev usually has to linearly search
		2588	all the priorities, so having many of them (hundreds) uses a lot of space
		2589	and time, so using the defaults of five priorities (-2 .. +2) is usually
		2590	fine.
		2591
		2592	If your embedding app does not need any priorities, defining these both to
		2593	C<0> will save some memory and cpu.
		2594
2090	=item EV_PERIODIC_ENABLE	2595	=item EV_PERIODIC_ENABLE
2091		2596
2092	If undefined or defined to be C<1>, then periodic timers are supported. If	2597	If undefined or defined to be C<1>, then periodic timers are supported. If
		2598	defined to be C<0>, then they are not. Disabling them saves a few kB of
		2599	code.
		2600
		2601	=item EV_IDLE_ENABLE
		2602
		2603	If undefined or defined to be C<1>, then idle watchers are supported. If
2093	defined to be C<0>, then they are not. Disabling them saves a few kB of	2604	defined to be C<0>, then they are not. Disabling them saves a few kB of
2094	code.	2605	code.
2095		2606
2096	=item EV_EMBED_ENABLE	2607	=item EV_EMBED_ENABLE
2097		2608
…		…
2121	than enough. If you need to manage thousands of children you might want to	2632	than enough. If you need to manage thousands of children you might want to
2122	increase this value (I<must> be a power of two).	2633	increase this value (I<must> be a power of two).
2123		2634
2124	=item EV_INOTIFY_HASHSIZE	2635	=item EV_INOTIFY_HASHSIZE
2125		2636
2126	C<ev_staz> watchers use a small hash table to distribute workload by	2637	C<ev_stat> watchers use a small hash table to distribute workload by
2127	inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>),	2638	inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>),
2128	usually more than enough. If you need to manage thousands of C<ev_stat>	2639	usually more than enough. If you need to manage thousands of C<ev_stat>
2129	watchers you might want to increase this value (I<must> be a power of	2640	watchers you might want to increase this value (I<must> be a power of
2130	two).	2641	two).
2131		2642
…		…
2148		2659
2149	=item ev_set_cb (ev, cb)	2660	=item ev_set_cb (ev, cb)
2150		2661
2151	Can be used to change the callback member declaration in each watcher,	2662	Can be used to change the callback member declaration in each watcher,
2152	and the way callbacks are invoked and set. Must expand to a struct member	2663	and the way callbacks are invoked and set. Must expand to a struct member
2153	definition and a statement, respectively. See the F<ev.v> header file for	2664	definition and a statement, respectively. See the F<ev.h> header file for
2154	their default definitions. One possible use for overriding these is to	2665	their default definitions. One possible use for overriding these is to
2155	avoid the C<struct ev_loop *> as first argument in all cases, or to use	2666	avoid the C<struct ev_loop *> as first argument in all cases, or to use
2156	method calls instead of plain function calls in C++.	2667	method calls instead of plain function calls in C++.
		2668
		2669	=head2 EXPORTED API SYMBOLS
		2670
		2671	If you need to re-export the API (e.g. via a dll) and you need a list of
		2672	exported symbols, you can use the provided F<Symbol.*> files which list
		2673	all public symbols, one per line:
		2674
		2675	Symbols.ev for libev proper
		2676	Symbols.event for the libevent emulation
		2677
		2678	This can also be used to rename all public symbols to avoid clashes with
		2679	multiple versions of libev linked together (which is obviously bad in
		2680	itself, but sometimes it is inconvinient to avoid this).
		2681
		2682	A sed command like this will create wrapper C<#define>'s that you need to
		2683	include before including F<ev.h>:
		2684
		2685	<Symbols.ev sed -e "s/.*/#define & myprefix_&/" >wrap.h
		2686
		2687	This would create a file F<wrap.h> which essentially looks like this:
		2688
		2689	#define ev_backend myprefix_ev_backend
		2690	#define ev_check_start myprefix_ev_check_start
		2691	#define ev_check_stop myprefix_ev_check_stop
		2692	...
2157		2693
2158	=head2 EXAMPLES	2694	=head2 EXAMPLES
2159		2695
2160	For a real-world example of a program the includes libev	2696	For a real-world example of a program the includes libev
2161	verbatim, you can have a look at the EV perl module	2697	verbatim, you can have a look at the EV perl module
…		…
2190		2726
2191	In this section the complexities of (many of) the algorithms used inside	2727	In this section the complexities of (many of) the algorithms used inside
2192	libev will be explained. For complexity discussions about backends see the	2728	libev will be explained. For complexity discussions about backends see the
2193	documentation for C<ev_default_init>.	2729	documentation for C<ev_default_init>.
2194		2730
		2731	All of the following are about amortised time: If an array needs to be
		2732	extended, libev needs to realloc and move the whole array, but this
		2733	happens asymptotically never with higher number of elements, so O(1) might
		2734	mean it might do a lengthy realloc operation in rare cases, but on average
		2735	it is much faster and asymptotically approaches constant time.
		2736
2195	=over 4	2737	=over 4
2196		2738
2197	=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers)	2739	=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers)
2198		2740
		2741	This means that, when you have a watcher that triggers in one hour and
		2742	there are 100 watchers that would trigger before that then inserting will
		2743	have to skip roughly seven (C<ld 100>) of these watchers.
		2744
2199	=item Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)	2745	=item Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)
		2746
		2747	That means that changing a timer costs less than removing/adding them
		2748	as only the relative motion in the event queue has to be paid for.
2200		2749
2201	=item Starting io/check/prepare/idle/signal/child watchers: O(1)	2750	=item Starting io/check/prepare/idle/signal/child watchers: O(1)
2202		2751
		2752	These just add the watcher into an array or at the head of a list.
		2753
2203	=item Stopping check/prepare/idle watchers: O(1)	2754	=item Stopping check/prepare/idle watchers: O(1)
2204		2755
2205	=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))	2756	=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))
2206		2757
		2758	These watchers are stored in lists then need to be walked to find the
		2759	correct watcher to remove. The lists are usually short (you don't usually
		2760	have many watchers waiting for the same fd or signal).
		2761
2207	=item Finding the next timer per loop iteration: O(1)	2762	=item Finding the next timer in each loop iteration: O(1)
		2763
		2764	By virtue of using a binary heap, the next timer is always found at the
		2765	beginning of the storage array.
2208		2766
2209	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)	2767	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)
2210		2768
2211	=item Activating one watcher: O(1)	2769	A change means an I/O watcher gets started or stopped, which requires
		2770	libev to recalculate its status (and possibly tell the kernel, depending
		2771	on backend and wether C<ev_io_set> was used).
		2772
		2773	=item Activating one watcher (putting it into the pending state): O(1)
		2774
		2775	=item Priority handling: O(number_of_priorities)
		2776
		2777	Priorities are implemented by allocating some space for each
		2778	priority. When doing priority-based operations, libev usually has to
		2779	linearly search all the priorities, but starting/stopping and activating
		2780	watchers becomes O(1) w.r.t. prioritiy handling.
2212		2781
2213	=back	2782	=back
2214		2783
2215		2784
		2785	=head1 Win32 platform limitations and workarounds
		2786
		2787	Win32 doesn't support any of the standards (e.g. POSIX) that libev
		2788	requires, and its I/O model is fundamentally incompatible with the POSIX
		2789	model. Libev still offers limited functionality on this platform in
		2790	the form of the C<EVBACKEND_SELECT> backend, and only supports socket
		2791	descriptors. This only applies when using Win32 natively, not when using
		2792	e.g. cygwin.
		2793
		2794	There is no supported compilation method available on windows except
		2795	embedding it into other applications.
		2796
		2797	Due to the many, low, and arbitrary limits on the win32 platform and the
		2798	abysmal performance of winsockets, using a large number of sockets is not
		2799	recommended (and not reasonable). If your program needs to use more than
		2800	a hundred or so sockets, then likely it needs to use a totally different
		2801	implementation for windows, as libev offers the POSIX model, which cannot
		2802	be implemented efficiently on windows (microsoft monopoly games).
		2803
		2804	=over 4
		2805
		2806	=item The winsocket select function
		2807
		2808	The winsocket C<select> function doesn't follow POSIX in that it requires
		2809	socket I<handles> and not socket I<file descriptors>. This makes select
		2810	very inefficient, and also requires a mapping from file descriptors
		2811	to socket handles. See the discussion of the C<EV_SELECT_USE_FD_SET>,
		2812	C<EV_SELECT_IS_WINSOCKET> and C<EV_FD_TO_WIN32_HANDLE> preprocessor
		2813	symbols for more info.
		2814
		2815	The configuration for a "naked" win32 using the microsoft runtime
		2816	libraries and raw winsocket select is:
		2817
		2818	#define EV_USE_SELECT 1
		2819	#define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */
		2820
		2821	Note that winsockets handling of fd sets is O(n), so you can easily get a
		2822	complexity in the O(n²) range when using win32.
		2823
		2824	=item Limited number of file descriptors
		2825
		2826	Windows has numerous arbitrary (and low) limits on things. Early versions
		2827	of winsocket's select only supported waiting for a max. of C<64> handles
		2828	(probably owning to the fact that all windows kernels can only wait for
		2829	C<64> things at the same time internally; microsoft recommends spawning a
		2830	chain of threads and wait for 63 handles and the previous thread in each).
		2831
		2832	Newer versions support more handles, but you need to define C<FD_SETSIZE>
		2833	to some high number (e.g. C<2048>) before compiling the winsocket select
		2834	call (which might be in libev or elsewhere, for example, perl does its own
		2835	select emulation on windows).
		2836
		2837	Another limit is the number of file descriptors in the microsoft runtime
		2838	libraries, which by default is C<64> (there must be a hidden I<64> fetish
		2839	or something like this inside microsoft). You can increase this by calling
		2840	C<_setmaxstdio>, which can increase this limit to C<2048> (another
		2841	arbitrary limit), but is broken in many versions of the microsoft runtime
		2842	libraries.
		2843
		2844	This might get you to about C<512> or C<2048> sockets (depending on
		2845	windows version and/or the phase of the moon). To get more, you need to
		2846	wrap all I/O functions and provide your own fd management, but the cost of
		2847	calling select (O(n²)) will likely make this unworkable.
		2848
		2849	=back
		2850
		2851
2216	=head1 AUTHOR	2852	=head1 AUTHOR
2217		2853
2218	Marc Lehmann <libev@schmorp.de>.	2854	Marc Lehmann <libev@schmorp.de>.
2219		2855

Diff Legend

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