ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.53 by root, Tue Nov 27 20:15:02 2007 UTC vs.
Revision 1.99 by root, Sat Dec 22 06:16:36 2007 UTC

…		…
2		2
3	libev - a high performance full-featured event loop written in C	3	libev - a high performance full-featured event loop written in C
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	/* this is the only header you need */
8	#include <ev.h>	7	#include <ev.h>
9		8
10	/* what follows is a fully working example program */	9	=head1 EXAMPLE PROGRAM
		10
		11	#include <ev.h>
		12
11	ev_io stdin_watcher;	13	ev_io stdin_watcher;
12	ev_timer timeout_watcher;	14	ev_timer timeout_watcher;
13		15
14	/* called when data readable on stdin */	16	/* called when data readable on stdin */
15	static void	17	static void
…		…
46	return 0;	48	return 0;
47	}	49	}
48		50
49	=head1 DESCRIPTION	51	=head1 DESCRIPTION
50		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
51	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
52	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
53	these event sources and provide your program with events.	59	these event sources and provide your program with events.
54		60
55	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
56	(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
57	communicate events via a callback mechanism.	63	communicate events via a callback mechanism.
…		…
61	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
62	watcher.	68	watcher.
63		69
64	=head1 FEATURES	70	=head1 FEATURES
65		71
66	Libev supports select, poll, the linux-specific epoll and the bsd-specific	72	Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the
67	kqueue mechanisms for file descriptor events, relative timers, absolute	73	BSD-specific C<kqueue> and the Solaris-specific event port mechanisms
68	timers with customised rescheduling, signal events, process status change	74	for file descriptor events (C<ev_io>), the Linux C<inotify> interface
69	events (related to SIGCHLD), and event watchers dealing with the event	75	(for C<ev_stat>), relative timers (C<ev_timer>), absolute timers
70	loop mechanism itself (idle, prepare and check watchers). It also is quite	76	with customised rescheduling (C<ev_periodic>), synchronous signals
		77	(C<ev_signal>), process status change events (C<ev_child>), and event
		78	watchers dealing with the event loop mechanism itself (C<ev_idle>,
		79	C<ev_embed>, C<ev_prepare> and C<ev_check> watchers) as well as
		80	file watchers (C<ev_stat>) and even limited support for fork events
		81	(C<ev_fork>).
		82
		83	It also is quite fast (see this
71	fast (see this L<benchmark|http://libev.schmorp.de/bench.html> comparing	84	L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent
72	it to libevent for example).	85	for example).
73		86
74	=head1 CONVENTIONS	87	=head1 CONVENTIONS
75		88
76	Libev is very configurable. In this manual the default configuration	89	Libev is very configurable. In this manual the default configuration will
77	will be described, which supports multiple event loops. For more info	90	be described, which supports multiple event loops. For more info about
78	about various configuration options please have a look at the file	91	various configuration options please have a look at B<EMBED> section in
79	F<README.embed> in the libev distribution. If libev was configured without	92	this manual. If libev was configured without support for multiple event
80	support for multiple event loops, then all functions taking an initial	93	loops, then all functions taking an initial argument of name C<loop>
81	argument of name C<loop> (which is always of type C<struct ev_loop *>)	94	(which is always of type C<struct ev_loop *>) will not have this argument.
82	will not have this argument.
83		95
84	=head1 TIME REPRESENTATION	96	=head1 TIME REPRESENTATION
85		97
86	Libev represents time as a single floating point number, representing the	98	Libev represents time as a single floating point number, representing the
87	(fractional) number of seconds since the (POSIX) epoch (somewhere near	99	(fractional) number of seconds since the (POSIX) epoch (somewhere near
88	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
89	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
90	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
91	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.
92		106
93	=head1 GLOBAL FUNCTIONS	107	=head1 GLOBAL FUNCTIONS
94		108
95	These functions can be called anytime, even before initialising the	109	These functions can be called anytime, even before initialising the
96	library in any way.	110	library in any way.
…		…
101		115
102	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
103	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
104	you actually want to know.	118	you actually want to know.
105		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
106	=item int ev_version_major ()	126	=item int ev_version_major ()
107		127
108	=item int ev_version_minor ()	128	=item int ev_version_minor ()
109		129
110	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
111	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
112	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
113	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
114	version of the library your program was compiled against.	134	version of the library your program was compiled against.
115		135
		136	These version numbers refer to the ABI version of the library, not the
		137	release version.
		138
116	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,
117	as this indicates an incompatible change. Minor versions are usually	140	as this indicates an incompatible change. Minor versions are usually
118	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
119	not a problem.	142	not a problem.
120		143
121	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
122	version:	145	version.
123		146
124	assert (("libev version mismatch",	147	assert (("libev version mismatch",
125	ev_version_major () == EV_VERSION_MAJOR	148	ev_version_major () == EV_VERSION_MAJOR
126	&& ev_version_minor () >= EV_VERSION_MINOR));	149	&& ev_version_minor () >= EV_VERSION_MINOR));
127		150
…		…
155	C<ev_embeddable_backends () & ev_supported_backends ()>, likewise for	178	C<ev_embeddable_backends () & ev_supported_backends ()>, likewise for
156	recommended ones.	179	recommended ones.
157		180
158	See the description of C<ev_embed> watchers for more info.	181	See the description of C<ev_embed> watchers for more info.
159		182
160	=item ev_set_allocator (void *(*cb)(void *ptr, size_t size))	183	=item ev_set_allocator (void *(*cb)(void *ptr, long size))
161		184
162	Sets the allocation function to use (the prototype and semantics are	185	Sets the allocation function to use (the prototype is similar - the
163	identical to the realloc C function). It is used to allocate and free	186	semantics is identical - to the realloc C function). It is used to
164	memory (no surprises here). If it returns zero when memory needs to be	187	allocate and free memory (no surprises here). If it returns zero when
165	allocated, the library might abort or take some potentially destructive	188	memory needs to be allocated, the library might abort or take some
166	action. The default is your system realloc function.	189	potentially destructive action. The default is your system realloc
		190	function.
167		191
168	You could override this function in high-availability programs to, say,	192	You could override this function in high-availability programs to, say,
169	free some memory if it cannot allocate memory, to use a special allocator,	193	free some memory if it cannot allocate memory, to use a special allocator,
170	or even to sleep a while and retry until some memory is available.	194	or even to sleep a while and retry until some memory is available.
171		195
172	Example: replace the libev allocator with one that waits a bit and then	196	Example: Replace the libev allocator with one that waits a bit and then
173	retries: better than mine).	197	retries).
174		198
175	static void *	199	static void *
176	persistent_realloc (void *ptr, size_t size)	200	persistent_realloc (void *ptr, size_t size)
177	{	201	{
178	for (;;)	202	for (;;)
…		…
197	callback is set, then libev will expect it to remedy the sitution, no	221	callback is set, then libev will expect it to remedy the sitution, no
198	matter what, when it returns. That is, libev will generally retry the	222	matter what, when it returns. That is, libev will generally retry the
199	requested operation, or, if the condition doesn't go away, do bad stuff	223	requested operation, or, if the condition doesn't go away, do bad stuff
200	(such as abort).	224	(such as abort).
201		225
202	Example: do the same thing as libev does internally:	226	Example: This is basically the same thing that libev does internally, too.
203		227
204	static void	228	static void
205	fatal_error (const char *msg)	229	fatal_error (const char *msg)
206	{	230	{
207	perror (msg);	231	perror (msg);
…		…
257	C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will	281	C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will
258	override the flags completely if it is found in the environment. This is	282	override the flags completely if it is found in the environment. This is
259	useful to try out specific backends to test their performance, or to work	283	useful to try out specific backends to test their performance, or to work
260	around bugs.	284	around bugs.
261		285
		286	=item C<EVFLAG_FORKCHECK>
		287
		288	Instead of calling C<ev_default_fork> or C<ev_loop_fork> manually after
		289	a fork, you can also make libev check for a fork in each iteration by
		290	enabling this flag.
		291
		292	This works by calling C<getpid ()> on every iteration of the loop,
		293	and thus this might slow down your event loop if you do a lot of loop
		294	iterations and little real work, but is usually not noticeable (on my
		295	Linux system for example, C<getpid> is actually a simple 5-insn sequence
		296	without a syscall and thus I<very> fast, but my Linux system also has
		297	C<pthread_atfork> which is even faster).
		298
		299	The big advantage of this flag is that you can forget about fork (and
		300	forget about forgetting to tell libev about forking) when you use this
		301	flag.
		302
		303	This flag setting cannot be overriden or specified in the C<LIBEV_FLAGS>
		304	environment variable.
		305
262	=item C<EVBACKEND_SELECT> (value 1, portable select backend)	306	=item C<EVBACKEND_SELECT> (value 1, portable select backend)
263		307
264	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
265	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,
266	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
…		…
275	lot of inactive fds). It scales similarly to select, i.e. O(total_fds).	319	lot of inactive fds). It scales similarly to select, i.e. O(total_fds).
276		320
277	=item C<EVBACKEND_EPOLL> (value 4, Linux)	321	=item C<EVBACKEND_EPOLL> (value 4, Linux)
278		322
279	For few fds, this backend is a bit little slower than poll and select,	323	For few fds, this backend is a bit little slower than poll and select,
280	but it scales phenomenally better. While poll and select usually scale like	324	but it scales phenomenally better. While poll and select usually scale
281	O(total_fds) where n is the total number of fds (or the highest fd), epoll scales	325	like O(total_fds) where n is the total number of fds (or the highest fd),
282	either O(1) or O(active_fds).	326	epoll scales either O(1) or O(active_fds). The epoll design has a number
		327	of shortcomings, such as silently dropping events in some hard-to-detect
		328	cases and rewiring a syscall per fd change, no fork support and bad
		329	support for dup:
283		330
284	While stopping and starting an I/O watcher in the same iteration will	331	While stopping, setting and starting an I/O watcher in the same iteration
285	result in some caching, there is still a syscall per such incident	332	will result in some caching, there is still a syscall per such incident
286	(because the fd could point to a different file description now), so its	333	(because the fd could point to a different file description now), so its
287	best to avoid that. Also, dup()ed file descriptors might not work very	334	best to avoid that. Also, C<dup ()>'ed file descriptors might not work
288	well if you register events for both fds.	335	very well if you register events for both fds.
289		336
290	Please note that epoll sometimes generates spurious notifications, so you	337	Please note that epoll sometimes generates spurious notifications, so you
291	need to use non-blocking I/O or other means to avoid blocking when no data	338	need to use non-blocking I/O or other means to avoid blocking when no data
292	(or space) is available.	339	(or space) is available.
293		340
294	=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)	341	=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)
295		342
296	Kqueue deserves special mention, as at the time of this writing, it	343	Kqueue deserves special mention, as at the time of this writing, it
297	was broken on all BSDs except NetBSD (usually it doesn't work with	344	was broken on I<all> BSDs (usually it doesn't work with anything but
298	anything but sockets and pipes, except on Darwin, where of course its	345	sockets and pipes, except on Darwin, where of course it's completely
		346	useless. On NetBSD, it seems to work for all the FD types I tested, so it
299	completely useless). For this reason its not being "autodetected"	347	is used by default there). For this reason it's not being "autodetected"
300	unless you explicitly specify it explicitly in the flags (i.e. using	348	unless you explicitly specify it explicitly in the flags (i.e. using
301	C<EVBACKEND_KQUEUE>).	349	C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough)
		350	system like NetBSD.
302		351
303	It scales in the same way as the epoll backend, but the interface to the	352	It scales in the same way as the epoll backend, but the interface to the
304	kernel is more efficient (which says nothing about its actual speed, of	353	kernel is more efficient (which says nothing about its actual speed,
305	course). While starting and stopping an I/O watcher does not cause an	354	of course). While stopping, setting and starting an I/O watcher does
306	extra syscall as with epoll, it still adds up to four event changes per	355	never cause an extra syscall as with epoll, it still adds up to two event
307	incident, so its best to avoid that.	356	changes per incident, support for C<fork ()> is very bad and it drops fds
		357	silently in similarly hard-to-detetc cases.
308		358
309	=item C<EVBACKEND_DEVPOLL> (value 16, Solaris 8)	359	=item C<EVBACKEND_DEVPOLL> (value 16, Solaris 8)
310		360
311	This is not implemented yet (and might never be).	361	This is not implemented yet (and might never be).
312		362
313	=item C<EVBACKEND_PORT> (value 32, Solaris 10)	363	=item C<EVBACKEND_PORT> (value 32, Solaris 10)
314		364
315	This uses the Solaris 10 port mechanism. As with everything on Solaris,	365	This uses the Solaris 10 event port mechanism. As with everything on Solaris,
316	it's really slow, but it still scales very well (O(active_fds)).	366	it's really slow, but it still scales very well (O(active_fds)).
317		367
318	Please note that solaris ports can result in a lot of spurious	368	Please note that solaris event ports can deliver a lot of spurious
319	notifications, so you need to use non-blocking I/O or other means to avoid	369	notifications, so you need to use non-blocking I/O or other means to avoid
320	blocking when no data (or space) is available.	370	blocking when no data (or space) is available.
321		371
322	=item C<EVBACKEND_ALL>	372	=item C<EVBACKEND_ALL>
323		373
…		…
353	Similar to C<ev_default_loop>, but always creates a new event loop that is	403	Similar to C<ev_default_loop>, but always creates a new event loop that is
354	always distinct from the default loop. Unlike the default loop, it cannot	404	always distinct from the default loop. Unlike the default loop, it cannot
355	handle signal and child watchers, and attempts to do so will be greeted by	405	handle signal and child watchers, and attempts to do so will be greeted by
356	undefined behaviour (or a failed assertion if assertions are enabled).	406	undefined behaviour (or a failed assertion if assertions are enabled).
357		407
358	Example: try to create a event loop that uses epoll and nothing else.	408	Example: Try to create a event loop that uses epoll and nothing else.
359		409
360	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);	410	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
361	if (!epoller)	411	if (!epoller)
362	fatal ("no epoll found here, maybe it hides under your chair");	412	fatal ("no epoll found here, maybe it hides under your chair");
363		413
…		…
366	Destroys the default loop again (frees all memory and kernel state	416	Destroys the default loop again (frees all memory and kernel state
367	etc.). None of the active event watchers will be stopped in the normal	417	etc.). None of the active event watchers will be stopped in the normal
368	sense, so e.g. C<ev_is_active> might still return true. It is your	418	sense, so e.g. C<ev_is_active> might still return true. It is your
369	responsibility to either stop all watchers cleanly yoursef I<before>	419	responsibility to either stop all watchers cleanly yoursef I<before>
370	calling this function, or cope with the fact afterwards (which is usually	420	calling this function, or cope with the fact afterwards (which is usually
371	the easiest thing, youc na just ignore the watchers and/or C<free ()> them	421	the easiest thing, you can just ignore the watchers and/or C<free ()> them
372	for example).	422	for example).
		423
		424	Note that certain global state, such as signal state, will not be freed by
		425	this function, and related watchers (such as signal and child watchers)
		426	would need to be stopped manually.
		427
		428	In general it is not advisable to call this function except in the
		429	rare occasion where you really need to free e.g. the signal handling
		430	pipe fds. If you need dynamically allocated loops it is better to use
		431	C<ev_loop_new> and C<ev_loop_destroy>).
373		432
374	=item ev_loop_destroy (loop)	433	=item ev_loop_destroy (loop)
375		434
376	Like C<ev_default_destroy>, but destroys an event loop created by an	435	Like C<ev_default_destroy>, but destroys an event loop created by an
377	earlier call to C<ev_loop_new>.	436	earlier call to C<ev_loop_new>.
…		…
401		460
402	Like C<ev_default_fork>, but acts on an event loop created by	461	Like C<ev_default_fork>, but acts on an event loop created by
403	C<ev_loop_new>. Yes, you have to call this on every allocated event loop	462	C<ev_loop_new>. Yes, you have to call this on every allocated event loop
404	after fork, and how you do this is entirely your own problem.	463	after fork, and how you do this is entirely your own problem.
405		464
		465	=item unsigned int ev_loop_count (loop)
		466
		467	Returns the count of loop iterations for the loop, which is identical to
		468	the number of times libev did poll for new events. It starts at C<0> and
		469	happily wraps around with enough iterations.
		470
		471	This value can sometimes be useful as a generation counter of sorts (it
		472	"ticks" the number of loop iterations), as it roughly corresponds with
		473	C<ev_prepare> and C<ev_check> calls.
		474
406	=item unsigned int ev_backend (loop)	475	=item unsigned int ev_backend (loop)
407		476
408	Returns one of the C<EVBACKEND_*> flags indicating the event backend in	477	Returns one of the C<EVBACKEND_*> flags indicating the event backend in
409	use.	478	use.
410		479
…		…
412		481
413	Returns the current "event loop time", which is the time the event loop	482	Returns the current "event loop time", which is the time the event loop
414	received events and started processing them. This timestamp does not	483	received events and started processing them. This timestamp does not
415	change as long as callbacks are being processed, and this is also the base	484	change as long as callbacks are being processed, and this is also the base
416	time used for relative timers. You can treat it as the timestamp of the	485	time used for relative timers. You can treat it as the timestamp of the
417	event occuring (or more correctly, libev finding out about it).	486	event occurring (or more correctly, libev finding out about it).
418		487
419	=item ev_loop (loop, int flags)	488	=item ev_loop (loop, int flags)
420		489
421	Finally, this is it, the event handler. This function usually is called	490	Finally, this is it, the event handler. This function usually is called
422	after you initialised all your watchers and you want to start handling	491	after you initialised all your watchers and you want to start handling
…		…
443	libev watchers. However, a pair of C<ev_prepare>/C<ev_check> watchers is	512	libev watchers. However, a pair of C<ev_prepare>/C<ev_check> watchers is
444	usually a better approach for this kind of thing.	513	usually a better approach for this kind of thing.
445		514
446	Here are the gory details of what C<ev_loop> does:	515	Here are the gory details of what C<ev_loop> does:
447		516
		517	- Before the first iteration, call any pending watchers.
448	* If there are no active watchers (reference count is zero), return.	518	* If there are no active watchers (reference count is zero), return.
449	- Queue prepare watchers and then call all outstanding watchers.	519	- Queue all prepare watchers and then call all outstanding watchers.
450	- If we have been forked, recreate the kernel state.	520	- If we have been forked, recreate the kernel state.
451	- Update the kernel state with all outstanding changes.	521	- Update the kernel state with all outstanding changes.
452	- Update the "event loop time".	522	- Update the "event loop time".
453	- Calculate for how long to block.	523	- Calculate for how long to block.
454	- Block the process, waiting for any events.	524	- Block the process, waiting for any events.
…		…
462	Signals and child watchers are implemented as I/O watchers, and will	532	Signals and child watchers are implemented as I/O watchers, and will
463	be handled here by queueing them when their watcher gets executed.	533	be handled here by queueing them when their watcher gets executed.
464	- If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK	534	- If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK
465	were used, return, otherwise continue with step *.	535	were used, return, otherwise continue with step *.
466		536
467	Example: queue some jobs and then loop until no events are outsanding	537	Example: Queue some jobs and then loop until no events are outsanding
468	anymore.	538	anymore.
469		539
470	... queue jobs here, make sure they register event watchers as long	540	... queue jobs here, make sure they register event watchers as long
471	... as they still have work to do (even an idle watcher will do..)	541	... as they still have work to do (even an idle watcher will do..)
472	ev_loop (my_loop, 0);	542	ev_loop (my_loop, 0);
…		…
492	visible to the libev user and should not keep C<ev_loop> from exiting if	562	visible to the libev user and should not keep C<ev_loop> from exiting if
493	no event watchers registered by it are active. It is also an excellent	563	no event watchers registered by it are active. It is also an excellent
494	way to do this for generic recurring timers or from within third-party	564	way to do this for generic recurring timers or from within third-party
495	libraries. Just remember to I<unref after start> and I<ref before stop>.	565	libraries. Just remember to I<unref after start> and I<ref before stop>.
496		566
497	Example: create a signal watcher, but keep it from keeping C<ev_loop>	567	Example: Create a signal watcher, but keep it from keeping C<ev_loop>
498	running when nothing else is active.	568	running when nothing else is active.
499		569
500	struct dv_signal exitsig;	570	struct ev_signal exitsig;
501	ev_signal_init (&exitsig, sig_cb, SIGINT);	571	ev_signal_init (&exitsig, sig_cb, SIGINT);
502	ev_signal_start (myloop, &exitsig);	572	ev_signal_start (loop, &exitsig);
503	evf_unref (myloop);	573	evf_unref (loop);
504		574
505	Example: for some weird reason, unregister the above signal handler again.	575	Example: For some weird reason, unregister the above signal handler again.
506		576
507	ev_ref (myloop);	577	ev_ref (loop);
508	ev_signal_stop (myloop, &exitsig);	578	ev_signal_stop (loop, &exitsig);
		579
		580	=item ev_set_io_collect_interval (loop, ev_tstamp interval)
		581
		582	=item ev_set_timeout_collect_interval (loop, ev_tstamp interval)
		583
		584	These advanced functions influence the time that libev will spend waiting
		585	for events. Both are by default C<0>, meaning that libev will try to
		586	invoke timer/periodic callbacks and I/O callbacks with minimum latency.
		587
		588	Setting these to a higher value (the C<interval> I<must> be >= C<0>)
		589	allows libev to delay invocation of I/O and timer/periodic callbacks to
		590	increase efficiency of loop iterations.
		591
		592	The background is that sometimes your program runs just fast enough to
		593	handle one (or very few) event(s) per loop iteration. While this makes
		594	the program responsive, it also wastes a lot of CPU time to poll for new
		595	events, especially with backends like C<select ()> which have a high
		596	overhead for the actual polling but can deliver many events at once.
		597
		598	By setting a higher I<io collect interval> you allow libev to spend more
		599	time collecting I/O events, so you can handle more events per iteration,
		600	at the cost of increasing latency. Timeouts (both C<ev_periodic> and
		601	C<ev_timer>) will be not affected. Setting this to a non-null bvalue will
		602	introduce an additional C<ev_sleep ()> call into most loop iterations.
		603
		604	Likewise, by setting a higher I<timeout collect interval> you allow libev
		605	to spend more time collecting timeouts, at the expense of increased
		606	latency (the watcher callback will be called later). C<ev_io> watchers
		607	will not be affected. Setting this to a non-null value will not introduce
		608	any overhead in libev.
		609
		610	Many (busy) programs can usually benefit by setting the io collect
		611	interval to a value near C<0.1> or so, which is often enough for
		612	interactive servers (of course not for games), likewise for timeouts. It
		613	usually doesn't make much sense to set it to a lower value than C<0.01>,
		614	as this approsaches the timing granularity of most systems.
509		615
510	=back	616	=back
511		617
512		618
513	=head1 ANATOMY OF A WATCHER	619	=head1 ANATOMY OF A WATCHER
…		…
693	=item bool ev_is_pending (ev_TYPE *watcher)	799	=item bool ev_is_pending (ev_TYPE *watcher)
694		800
695	Returns a true value iff the watcher is pending, (i.e. it has outstanding	801	Returns a true value iff the watcher is pending, (i.e. it has outstanding
696	events but its callback has not yet been invoked). As long as a watcher	802	events but its callback has not yet been invoked). As long as a watcher
697	is pending (but not active) you must not call an init function on it (but	803	is pending (but not active) you must not call an init function on it (but
698	C<ev_TYPE_set> is safe) and you must make sure the watcher is available to	804	C<ev_TYPE_set> is safe), you must not change its priority, and you must
699	libev (e.g. you cnanot C<free ()> it).	805	make sure the watcher is available to libev (e.g. you cannot C<free ()>
		806	it).
700		807
701	=item callback = ev_cb (ev_TYPE *watcher)	808	=item callback ev_cb (ev_TYPE *watcher)
702		809
703	Returns the callback currently set on the watcher.	810	Returns the callback currently set on the watcher.
704		811
705	=item ev_cb_set (ev_TYPE *watcher, callback)	812	=item ev_cb_set (ev_TYPE *watcher, callback)
706		813
707	Change the callback. You can change the callback at virtually any time	814	Change the callback. You can change the callback at virtually any time
708	(modulo threads).	815	(modulo threads).
		816
		817	=item ev_set_priority (ev_TYPE *watcher, priority)
		818
		819	=item int ev_priority (ev_TYPE *watcher)
		820
		821	Set and query the priority of the watcher. The priority is a small
		822	integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>
		823	(default: C<-2>). Pending watchers with higher priority will be invoked
		824	before watchers with lower priority, but priority will not keep watchers
		825	from being executed (except for C<ev_idle> watchers).
		826
		827	This means that priorities are I<only> used for ordering callback
		828	invocation after new events have been received. This is useful, for
		829	example, to reduce latency after idling, or more often, to bind two
		830	watchers on the same event and make sure one is called first.
		831
		832	If you need to suppress invocation when higher priority events are pending
		833	you need to look at C<ev_idle> watchers, which provide this functionality.
		834
		835	You I<must not> change the priority of a watcher as long as it is active or
		836	pending.
		837
		838	The default priority used by watchers when no priority has been set is
		839	always C<0>, which is supposed to not be too high and not be too low :).
		840
		841	Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is
		842	fine, as long as you do not mind that the priority value you query might
		843	or might not have been adjusted to be within valid range.
		844
		845	=item ev_invoke (loop, ev_TYPE *watcher, int revents)
		846
		847	Invoke the C<watcher> with the given C<loop> and C<revents>. Neither
		848	C<loop> nor C<revents> need to be valid as long as the watcher callback
		849	can deal with that fact.
		850
		851	=item int ev_clear_pending (loop, ev_TYPE *watcher)
		852
		853	If the watcher is pending, this function returns clears its pending status
		854	and returns its C<revents> bitset (as if its callback was invoked). If the
		855	watcher isn't pending it does nothing and returns C<0>.
709		856
710	=back	857	=back
711		858
712		859
713	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER	860	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
…		…
734	{	881	{
735	struct my_io *w = (struct my_io *)w_;	882	struct my_io *w = (struct my_io *)w_;
736	...	883	...
737	}	884	}
738		885
739	More interesting and less C-conformant ways of catsing your callback type	886	More interesting and less C-conformant ways of casting your callback type
740	have been omitted....	887	instead have been omitted.
		888
		889	Another common scenario is having some data structure with multiple
		890	watchers:
		891
		892	struct my_biggy
		893	{
		894	int some_data;
		895	ev_timer t1;
		896	ev_timer t2;
		897	}
		898
		899	In this case getting the pointer to C<my_biggy> is a bit more complicated,
		900	you need to use C<offsetof>:
		901
		902	#include <stddef.h>
		903
		904	static void
		905	t1_cb (EV_P_ struct ev_timer *w, int revents)
		906	{
		907	struct my_biggy big = (struct my_biggy *
		908	(((char *)w) - offsetof (struct my_biggy, t1));
		909	}
		910
		911	static void
		912	t2_cb (EV_P_ struct ev_timer *w, int revents)
		913	{
		914	struct my_biggy big = (struct my_biggy *
		915	(((char *)w) - offsetof (struct my_biggy, t2));
		916	}
741		917
742		918
743	=head1 WATCHER TYPES	919	=head1 WATCHER TYPES
744		920
745	This section describes each watcher in detail, but will not repeat	921	This section describes each watcher in detail, but will not repeat
…		…
790	it is best to always use non-blocking I/O: An extra C<read>(2) returning	966	it is best to always use non-blocking I/O: An extra C<read>(2) returning
791	C<EAGAIN> is far preferable to a program hanging until some data arrives.	967	C<EAGAIN> is far preferable to a program hanging until some data arrives.
792		968
793	If you cannot run the fd in non-blocking mode (for example you should not	969	If you cannot run the fd in non-blocking mode (for example you should not
794	play around with an Xlib connection), then you have to seperately re-test	970	play around with an Xlib connection), then you have to seperately re-test
795	wether a file descriptor is really ready with a known-to-be good interface	971	whether a file descriptor is really ready with a known-to-be good interface
796	such as poll (fortunately in our Xlib example, Xlib already does this on	972	such as poll (fortunately in our Xlib example, Xlib already does this on
797	its own, so its quite safe to use).	973	its own, so its quite safe to use).
		974
		975	=head3 The special problem of disappearing file descriptors
		976
		977	Some backends (e.g. kqueue, epoll) need to be told about closing a file
		978	descriptor (either by calling C<close> explicitly or by any other means,
		979	such as C<dup>). The reason is that you register interest in some file
		980	descriptor, but when it goes away, the operating system will silently drop
		981	this interest. If another file descriptor with the same number then is
		982	registered with libev, there is no efficient way to see that this is, in
		983	fact, a different file descriptor.
		984
		985	To avoid having to explicitly tell libev about such cases, libev follows
		986	the following policy: Each time C<ev_io_set> is being called, libev
		987	will assume that this is potentially a new file descriptor, otherwise
		988	it is assumed that the file descriptor stays the same. That means that
		989	you I<have> to call C<ev_io_set> (or C<ev_io_init>) when you change the
		990	descriptor even if the file descriptor number itself did not change.
		991
		992	This is how one would do it normally anyway, the important point is that
		993	the libev application should not optimise around libev but should leave
		994	optimisations to libev.
		995
		996	=head3 The special problem of dup'ed file descriptors
		997
		998	Some backends (e.g. epoll), cannot register events for file descriptors,
		999	but only events for the underlying file descriptions. That menas when you
		1000	have C<dup ()>'ed file descriptors and register events for them, only one
		1001	file descriptor might actually receive events.
		1002
		1003	There is no workaorund possible except not registering events
		1004	for potentially C<dup ()>'ed file descriptors or to resort to
		1005	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
		1006
		1007	=head3 The special problem of fork
		1008
		1009	Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit
		1010	useless behaviour. Libev fully supports fork, but needs to be told about
		1011	it in the child.
		1012
		1013	To support fork in your programs, you either have to call
		1014	C<ev_default_fork ()> or C<ev_loop_fork ()> after a fork in the child,
		1015	enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or
		1016	C<EVBACKEND_POLL>.
		1017
		1018
		1019	=head3 Watcher-Specific Functions
798		1020
799	=over 4	1021	=over 4
800		1022
801	=item ev_io_init (ev_io *, callback, int fd, int events)	1023	=item ev_io_init (ev_io *, callback, int fd, int events)
802		1024
…		…
814		1036
815	The events being watched.	1037	The events being watched.
816		1038
817	=back	1039	=back
818		1040
819	Example: call C<stdin_readable_cb> when STDIN_FILENO has become, well	1041	Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well
820	readable, but only once. Since it is likely line-buffered, you could	1042	readable, but only once. Since it is likely line-buffered, you could
821	attempt to read a whole line in the callback:	1043	attempt to read a whole line in the callback.
822		1044
823	static void	1045	static void
824	stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents)	1046	stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents)
825	{	1047	{
826	ev_io_stop (loop, w);	1048	ev_io_stop (loop, w);
…		…
856		1078
857	The callback is guarenteed to be invoked only when its timeout has passed,	1079	The callback is guarenteed to be invoked only when its timeout has passed,
858	but if multiple timers become ready during the same loop iteration then	1080	but if multiple timers become ready during the same loop iteration then
859	order of execution is undefined.	1081	order of execution is undefined.
860		1082
		1083	=head3 Watcher-Specific Functions and Data Members
		1084
861	=over 4	1085	=over 4
862		1086
863	=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)	1087	=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
864		1088
865	=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)	1089	=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)
…		…
878	=item ev_timer_again (loop)	1102	=item ev_timer_again (loop)
879		1103
880	This will act as if the timer timed out and restart it again if it is	1104	This will act as if the timer timed out and restart it again if it is
881	repeating. The exact semantics are:	1105	repeating. The exact semantics are:
882		1106
		1107	If the timer is pending, its pending status is cleared.
		1108
883	If the timer is started but nonrepeating, stop it.	1109	If the timer is started but nonrepeating, stop it (as if it timed out).
884		1110
885	If the timer is repeating, either start it if necessary (with the repeat	1111	If the timer is repeating, either start it if necessary (with the
886	value), or reset the running timer to the repeat value.	1112	C<repeat> value), or reset the running timer to the C<repeat> value.
887		1113
888	This sounds a bit complicated, but here is a useful and typical	1114	This sounds a bit complicated, but here is a useful and typical
889	example: Imagine you have a tcp connection and you want a so-called	1115	example: Imagine you have a tcp connection and you want a so-called idle
890	idle timeout, that is, you want to be called when there have been,	1116	timeout, that is, you want to be called when there have been, say, 60
891	say, 60 seconds of inactivity on the socket. The easiest way to do	1117	seconds of inactivity on the socket. The easiest way to do this is to
892	this is to configure an C<ev_timer> with C<after>=C<repeat>=C<60> and calling	1118	configure an C<ev_timer> with a C<repeat> value of C<60> and then call
893	C<ev_timer_again> each time you successfully read or write some data. If	1119	C<ev_timer_again> each time you successfully read or write some data. If
894	you go into an idle state where you do not expect data to travel on the	1120	you go into an idle state where you do not expect data to travel on the
895	socket, you can stop the timer, and again will automatically restart it if	1121	socket, you can C<ev_timer_stop> the timer, and C<ev_timer_again> will
896	need be.	1122	automatically restart it if need be.
897		1123
898	You can also ignore the C<after> value and C<ev_timer_start> altogether	1124	That means you can ignore the C<after> value and C<ev_timer_start>
899	and only ever use the C<repeat> value:	1125	altogether and only ever use the C<repeat> value and C<ev_timer_again>:
900		1126
901	ev_timer_init (timer, callback, 0., 5.);	1127	ev_timer_init (timer, callback, 0., 5.);
902	ev_timer_again (loop, timer);	1128	ev_timer_again (loop, timer);
903	...	1129	...
904	timer->again = 17.;	1130	timer->again = 17.;
905	ev_timer_again (loop, timer);	1131	ev_timer_again (loop, timer);
906	...	1132	...
907	timer->again = 10.;	1133	timer->again = 10.;
908	ev_timer_again (loop, timer);	1134	ev_timer_again (loop, timer);
909		1135
910	This is more efficient then stopping/starting the timer eahc time you want	1136	This is more slightly efficient then stopping/starting the timer each time
911	to modify its timeout value.	1137	you want to modify its timeout value.
912		1138
913	=item ev_tstamp repeat [read-write]	1139	=item ev_tstamp repeat [read-write]
914		1140
915	The current C<repeat> value. Will be used each time the watcher times out	1141	The current C<repeat> value. Will be used each time the watcher times out
916	or C<ev_timer_again> is called and determines the next timeout (if any),	1142	or C<ev_timer_again> is called and determines the next timeout (if any),
917	which is also when any modifications are taken into account.	1143	which is also when any modifications are taken into account.
918		1144
919	=back	1145	=back
920		1146
921	Example: create a timer that fires after 60 seconds.	1147	Example: Create a timer that fires after 60 seconds.
922		1148
923	static void	1149	static void
924	one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents)	1150	one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents)
925	{	1151	{
926	.. one minute over, w is actually stopped right here	1152	.. one minute over, w is actually stopped right here
…		…
928		1154
929	struct ev_timer mytimer;	1155	struct ev_timer mytimer;
930	ev_timer_init (&mytimer, one_minute_cb, 60., 0.);	1156	ev_timer_init (&mytimer, one_minute_cb, 60., 0.);
931	ev_timer_start (loop, &mytimer);	1157	ev_timer_start (loop, &mytimer);
932		1158
933	Example: create a timeout timer that times out after 10 seconds of	1159	Example: Create a timeout timer that times out after 10 seconds of
934	inactivity.	1160	inactivity.
935		1161
936	static void	1162	static void
937	timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents)	1163	timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents)
938	{	1164	{
…		…
958	but on wallclock time (absolute time). You can tell a periodic watcher	1184	but on wallclock time (absolute time). You can tell a periodic watcher
959	to trigger "at" some specific point in time. For example, if you tell a	1185	to trigger "at" some specific point in time. For example, if you tell a
960	periodic watcher to trigger in 10 seconds (by specifiying e.g. C<ev_now ()	1186	periodic watcher to trigger in 10 seconds (by specifiying e.g. C<ev_now ()
961	+ 10.>) and then reset your system clock to the last year, then it will	1187	+ 10.>) and then reset your system clock to the last year, then it will
962	take a year to trigger the event (unlike an C<ev_timer>, which would trigger	1188	take a year to trigger the event (unlike an C<ev_timer>, which would trigger
963	roughly 10 seconds later and of course not if you reset your system time	1189	roughly 10 seconds later).
964	again).
965		1190
966	They can also be used to implement vastly more complex timers, such as	1191	They can also be used to implement vastly more complex timers, such as
967	triggering an event on eahc midnight, local time.	1192	triggering an event on each midnight, local time or other, complicated,
		1193	rules.
968		1194
969	As with timers, the callback is guarenteed to be invoked only when the	1195	As with timers, the callback is guarenteed to be invoked only when the
970	time (C<at>) has been passed, but if multiple periodic timers become ready	1196	time (C<at>) has been passed, but if multiple periodic timers become ready
971	during the same loop iteration then order of execution is undefined.	1197	during the same loop iteration then order of execution is undefined.
972		1198
		1199	=head3 Watcher-Specific Functions and Data Members
		1200
973	=over 4	1201	=over 4
974		1202
975	=item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)	1203	=item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)
976		1204
977	=item ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)	1205	=item ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)
…		…
979	Lots of arguments, lets sort it out... There are basically three modes of	1207	Lots of arguments, lets sort it out... There are basically three modes of
980	operation, and we will explain them from simplest to complex:	1208	operation, and we will explain them from simplest to complex:
981		1209
982	=over 4	1210	=over 4
983		1211
984	=item * absolute timer (interval = reschedule_cb = 0)	1212	=item * absolute timer (at = time, interval = reschedule_cb = 0)
985		1213
986	In this configuration the watcher triggers an event at the wallclock time	1214	In this configuration the watcher triggers an event at the wallclock time
987	C<at> and doesn't repeat. It will not adjust when a time jump occurs,	1215	C<at> and doesn't repeat. It will not adjust when a time jump occurs,
988	that is, if it is to be run at January 1st 2011 then it will run when the	1216	that is, if it is to be run at January 1st 2011 then it will run when the
989	system time reaches or surpasses this time.	1217	system time reaches or surpasses this time.
990		1218
991	=item * non-repeating interval timer (interval > 0, reschedule_cb = 0)	1219	=item * non-repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)
992		1220
993	In this mode the watcher will always be scheduled to time out at the next	1221	In this mode the watcher will always be scheduled to time out at the next
994	C<at + N * interval> time (for some integer N) and then repeat, regardless	1222	C<at + N * interval> time (for some integer N, which can also be negative)
995	of any time jumps.	1223	and then repeat, regardless of any time jumps.
996		1224
997	This can be used to create timers that do not drift with respect to system	1225	This can be used to create timers that do not drift with respect to system
998	time:	1226	time:
999		1227
1000	ev_periodic_set (&periodic, 0., 3600., 0);	1228	ev_periodic_set (&periodic, 0., 3600., 0);
…		…
1006		1234
1007	Another way to think about it (for the mathematically inclined) is that	1235	Another way to think about it (for the mathematically inclined) is that
1008	C<ev_periodic> will try to run the callback in this mode at the next possible	1236	C<ev_periodic> will try to run the callback in this mode at the next possible
1009	time where C<time = at (mod interval)>, regardless of any time jumps.	1237	time where C<time = at (mod interval)>, regardless of any time jumps.
1010		1238
		1239	For numerical stability it is preferable that the C<at> value is near
		1240	C<ev_now ()> (the current time), but there is no range requirement for
		1241	this value.
		1242
1011	=item * manual reschedule mode (reschedule_cb = callback)	1243	=item * manual reschedule mode (at and interval ignored, reschedule_cb = callback)
1012		1244
1013	In this mode the values for C<interval> and C<at> are both being	1245	In this mode the values for C<interval> and C<at> are both being
1014	ignored. Instead, each time the periodic watcher gets scheduled, the	1246	ignored. Instead, each time the periodic watcher gets scheduled, the
1015	reschedule callback will be called with the watcher as first, and the	1247	reschedule callback will be called with the watcher as first, and the
1016	current time as second argument.	1248	current time as second argument.
1017		1249
1018	NOTE: I<This callback MUST NOT stop or destroy any periodic watcher,	1250	NOTE: I<This callback MUST NOT stop or destroy any periodic watcher,
1019	ever, or make any event loop modifications>. If you need to stop it,	1251	ever, or make any event loop modifications>. If you need to stop it,
1020	return C<now + 1e30> (or so, fudge fudge) and stop it afterwards (e.g. by	1252	return C<now + 1e30> (or so, fudge fudge) and stop it afterwards (e.g. by
1021	starting a prepare watcher).	1253	starting an C<ev_prepare> watcher, which is legal).
1022		1254
1023	Its prototype is C<ev_tstamp (*reschedule_cb)(struct ev_periodic *w,	1255	Its prototype is C<ev_tstamp (*reschedule_cb)(struct ev_periodic *w,
1024	ev_tstamp now)>, e.g.:	1256	ev_tstamp now)>, e.g.:
1025		1257
1026	static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)	1258	static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)
…		…
1049	Simply stops and restarts the periodic watcher again. This is only useful	1281	Simply stops and restarts the periodic watcher again. This is only useful
1050	when you changed some parameters or the reschedule callback would return	1282	when you changed some parameters or the reschedule callback would return
1051	a different time than the last time it was called (e.g. in a crond like	1283	a different time than the last time it was called (e.g. in a crond like
1052	program when the crontabs have changed).	1284	program when the crontabs have changed).
1053		1285
		1286	=item ev_tstamp offset [read-write]
		1287
		1288	When repeating, this contains the offset value, otherwise this is the
		1289	absolute point in time (the C<at> value passed to C<ev_periodic_set>).
		1290
		1291	Can be modified any time, but changes only take effect when the periodic
		1292	timer fires or C<ev_periodic_again> is being called.
		1293
1054	=item ev_tstamp interval [read-write]	1294	=item ev_tstamp interval [read-write]
1055		1295
1056	The current interval value. Can be modified any time, but changes only	1296	The current interval value. Can be modified any time, but changes only
1057	take effect when the periodic timer fires or C<ev_periodic_again> is being	1297	take effect when the periodic timer fires or C<ev_periodic_again> is being
1058	called.	1298	called.
…		…
1061		1301
1062	The current reschedule callback, or C<0>, if this functionality is	1302	The current reschedule callback, or C<0>, if this functionality is
1063	switched off. Can be changed any time, but changes only take effect when	1303	switched off. Can be changed any time, but changes only take effect when
1064	the periodic timer fires or C<ev_periodic_again> is being called.	1304	the periodic timer fires or C<ev_periodic_again> is being called.
1065		1305
		1306	=item ev_tstamp at [read-only]
		1307
		1308	When active, contains the absolute time that the watcher is supposed to
		1309	trigger next.
		1310
1066	=back	1311	=back
1067		1312
1068	Example: call a callback every hour, or, more precisely, whenever the	1313	Example: Call a callback every hour, or, more precisely, whenever the
1069	system clock is divisible by 3600. The callback invocation times have	1314	system clock is divisible by 3600. The callback invocation times have
1070	potentially a lot of jittering, but good long-term stability.	1315	potentially a lot of jittering, but good long-term stability.
1071		1316
1072	static void	1317	static void
1073	clock_cb (struct ev_loop *loop, struct ev_io *w, int revents)	1318	clock_cb (struct ev_loop *loop, struct ev_io *w, int revents)
…		…
1077		1322
1078	struct ev_periodic hourly_tick;	1323	struct ev_periodic hourly_tick;
1079	ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);	1324	ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);
1080	ev_periodic_start (loop, &hourly_tick);	1325	ev_periodic_start (loop, &hourly_tick);
1081		1326
1082	Example: the same as above, but use a reschedule callback to do it:	1327	Example: The same as above, but use a reschedule callback to do it:
1083		1328
1084	#include <math.h>	1329	#include <math.h>
1085		1330
1086	static ev_tstamp	1331	static ev_tstamp
1087	my_scheduler_cb (struct ev_periodic *w, ev_tstamp now)	1332	my_scheduler_cb (struct ev_periodic *w, ev_tstamp now)
…		…
1089	return fmod (now, 3600.) + 3600.;	1334	return fmod (now, 3600.) + 3600.;
1090	}	1335	}
1091		1336
1092	ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);	1337	ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);
1093		1338
1094	Example: call a callback every hour, starting now:	1339	Example: Call a callback every hour, starting now:
1095		1340
1096	struct ev_periodic hourly_tick;	1341	struct ev_periodic hourly_tick;
1097	ev_periodic_init (&hourly_tick, clock_cb,	1342	ev_periodic_init (&hourly_tick, clock_cb,
1098	fmod (ev_now (loop), 3600.), 3600., 0);	1343	fmod (ev_now (loop), 3600.), 3600., 0);
1099	ev_periodic_start (loop, &hourly_tick);	1344	ev_periodic_start (loop, &hourly_tick);
…		…
1111	with the kernel (thus it coexists with your own signal handlers as long	1356	with the kernel (thus it coexists with your own signal handlers as long
1112	as you don't register any with libev). Similarly, when the last signal	1357	as you don't register any with libev). Similarly, when the last signal
1113	watcher for a signal is stopped libev will reset the signal handler to	1358	watcher for a signal is stopped libev will reset the signal handler to
1114	SIG_DFL (regardless of what it was set to before).	1359	SIG_DFL (regardless of what it was set to before).
1115		1360
		1361	=head3 Watcher-Specific Functions and Data Members
		1362
1116	=over 4	1363	=over 4
1117		1364
1118	=item ev_signal_init (ev_signal *, callback, int signum)	1365	=item ev_signal_init (ev_signal *, callback, int signum)
1119		1366
1120	=item ev_signal_set (ev_signal *, int signum)	1367	=item ev_signal_set (ev_signal *, int signum)
…		…
1131		1378
1132	=head2 C<ev_child> - watch out for process status changes	1379	=head2 C<ev_child> - watch out for process status changes
1133		1380
1134	Child watchers trigger when your process receives a SIGCHLD in response to	1381	Child watchers trigger when your process receives a SIGCHLD in response to
1135	some child status changes (most typically when a child of yours dies).	1382	some child status changes (most typically when a child of yours dies).
		1383
		1384	=head3 Watcher-Specific Functions and Data Members
1136		1385
1137	=over 4	1386	=over 4
1138		1387
1139	=item ev_child_init (ev_child *, callback, int pid)	1388	=item ev_child_init (ev_child *, callback, int pid)
1140		1389
…		…
1160	The process exit/trace status caused by C<rpid> (see your systems	1409	The process exit/trace status caused by C<rpid> (see your systems
1161	C<waitpid> and C<sys/wait.h> documentation for details).	1410	C<waitpid> and C<sys/wait.h> documentation for details).
1162		1411
1163	=back	1412	=back
1164		1413
1165	Example: try to exit cleanly on SIGINT and SIGTERM.	1414	Example: Try to exit cleanly on SIGINT and SIGTERM.
1166		1415
1167	static void	1416	static void
1168	sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)	1417	sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)
1169	{	1418	{
1170	ev_unloop (loop, EVUNLOOP_ALL);	1419	ev_unloop (loop, EVUNLOOP_ALL);
…		…
1185	not exist" is a status change like any other. The condition "path does	1434	not exist" is a status change like any other. The condition "path does
1186	not exist" is signified by the C<st_nlink> field being zero (which is	1435	not exist" is signified by the C<st_nlink> field being zero (which is
1187	otherwise always forced to be at least one) and all the other fields of	1436	otherwise always forced to be at least one) and all the other fields of
1188	the stat buffer having unspecified contents.	1437	the stat buffer having unspecified contents.
1189		1438
		1439	The path I<should> be absolute and I<must not> end in a slash. If it is
		1440	relative and your working directory changes, the behaviour is undefined.
		1441
1190	Since there is no standard to do this, the portable implementation simply	1442	Since there is no standard to do this, the portable implementation simply
1191	calls C<stat (2)> regulalry on the path to see if it changed somehow. You	1443	calls C<stat (2)> regularly on the path to see if it changed somehow. You
1192	can specify a recommended polling interval for this case. If you specify	1444	can specify a recommended polling interval for this case. If you specify
1193	a polling interval of C<0> (highly recommended!) then a I<suitable,	1445	a polling interval of C<0> (highly recommended!) then a I<suitable,
1194	unspecified default> value will be used (which you can expect to be around	1446	unspecified default> value will be used (which you can expect to be around
1195	five seconds, although this might change dynamically). Libev will also	1447	five seconds, although this might change dynamically). Libev will also
1196	impose a minimum interval which is currently around C<0.1>, but thats	1448	impose a minimum interval which is currently around C<0.1>, but thats
…		…
1198		1450
1199	This watcher type is not meant for massive numbers of stat watchers,	1451	This watcher type is not meant for massive numbers of stat watchers,
1200	as even with OS-supported change notifications, this can be	1452	as even with OS-supported change notifications, this can be
1201	resource-intensive.	1453	resource-intensive.
1202		1454
1203	At the time of this writing, no specific OS backends are implemented, but	1455	At the time of this writing, only the Linux inotify interface is
1204	if demand increases, at least a kqueue and inotify backend will be added.	1456	implemented (implementing kqueue support is left as an exercise for the
		1457	reader). Inotify will be used to give hints only and should not change the
		1458	semantics of C<ev_stat> watchers, which means that libev sometimes needs
		1459	to fall back to regular polling again even with inotify, but changes are
		1460	usually detected immediately, and if the file exists there will be no
		1461	polling.
		1462
		1463	=head3 Watcher-Specific Functions and Data Members
1205		1464
1206	=over 4	1465	=over 4
1207		1466
1208	=item ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)	1467	=item ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)
1209		1468
…		…
1273	ev_stat_start (loop, &passwd);	1532	ev_stat_start (loop, &passwd);
1274		1533
1275		1534
1276	=head2 C<ev_idle> - when you've got nothing better to do...	1535	=head2 C<ev_idle> - when you've got nothing better to do...
1277		1536
1278	Idle watchers trigger events when there are no other events are pending	1537	Idle watchers trigger events when no other events of the same or higher
1279	(prepare, check and other idle watchers do not count). That is, as long	1538	priority are pending (prepare, check and other idle watchers do not
1280	as your process is busy handling sockets or timeouts (or even signals,	1539	count).
1281	imagine) it will not be triggered. But when your process is idle all idle	1540
1282	watchers are being called again and again, once per event loop iteration -	1541	That is, as long as your process is busy handling sockets or timeouts
		1542	(or even signals, imagine) of the same or higher priority it will not be
		1543	triggered. But when your process is idle (or only lower-priority watchers
		1544	are pending), the idle watchers are being called once per event loop
1283	until stopped, that is, or your process receives more events and becomes	1545	iteration - until stopped, that is, or your process receives more events
1284	busy.	1546	and becomes busy again with higher priority stuff.
1285		1547
1286	The most noteworthy effect is that as long as any idle watchers are	1548	The most noteworthy effect is that as long as any idle watchers are
1287	active, the process will not block when waiting for new events.	1549	active, the process will not block when waiting for new events.
1288		1550
1289	Apart from keeping your process non-blocking (which is a useful	1551	Apart from keeping your process non-blocking (which is a useful
1290	effect on its own sometimes), idle watchers are a good place to do	1552	effect on its own sometimes), idle watchers are a good place to do
1291	"pseudo-background processing", or delay processing stuff to after the	1553	"pseudo-background processing", or delay processing stuff to after the
1292	event loop has handled all outstanding events.	1554	event loop has handled all outstanding events.
1293		1555
		1556	=head3 Watcher-Specific Functions and Data Members
		1557
1294	=over 4	1558	=over 4
1295		1559
1296	=item ev_idle_init (ev_signal *, callback)	1560	=item ev_idle_init (ev_signal *, callback)
1297		1561
1298	Initialises and configures the idle watcher - it has no parameters of any	1562	Initialises and configures the idle watcher - it has no parameters of any
1299	kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,	1563	kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,
1300	believe me.	1564	believe me.
1301		1565
1302	=back	1566	=back
1303		1567
1304	Example: dynamically allocate an C<ev_idle>, start it, and in the	1568	Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the
1305	callback, free it. Alos, use no error checking, as usual.	1569	callback, free it. Also, use no error checking, as usual.
1306		1570
1307	static void	1571	static void
1308	idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents)	1572	idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents)
1309	{	1573	{
1310	free (w);	1574	free (w);
…		…
1355	with priority higher than or equal to the event loop and one coroutine	1619	with priority higher than or equal to the event loop and one coroutine
1356	of lower priority, but only once, using idle watchers to keep the event	1620	of lower priority, but only once, using idle watchers to keep the event
1357	loop from blocking if lower-priority coroutines are active, thus mapping	1621	loop from blocking if lower-priority coroutines are active, thus mapping
1358	low-priority coroutines to idle/background tasks).	1622	low-priority coroutines to idle/background tasks).
1359		1623
		1624	It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>)
		1625	priority, to ensure that they are being run before any other watchers
		1626	after the poll. Also, C<ev_check> watchers (and C<ev_prepare> watchers,
		1627	too) should not activate ("feed") events into libev. While libev fully
		1628	supports this, they will be called before other C<ev_check> watchers did
		1629	their job. As C<ev_check> watchers are often used to embed other event
		1630	loops those other event loops might be in an unusable state until their
		1631	C<ev_check> watcher ran (always remind yourself to coexist peacefully with
		1632	others).
		1633
		1634	=head3 Watcher-Specific Functions and Data Members
		1635
1360	=over 4	1636	=over 4
1361		1637
1362	=item ev_prepare_init (ev_prepare *, callback)	1638	=item ev_prepare_init (ev_prepare *, callback)
1363		1639
1364	=item ev_check_init (ev_check *, callback)	1640	=item ev_check_init (ev_check *, callback)
…		…
1367	parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>	1643	parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>
1368	macros, but using them is utterly, utterly and completely pointless.	1644	macros, but using them is utterly, utterly and completely pointless.
1369		1645
1370	=back	1646	=back
1371		1647
1372	Example: To include a library such as adns, you would add IO watchers	1648	There are a number of principal ways to embed other event loops or modules
1373	and a timeout watcher in a prepare handler, as required by libadns, and	1649	into libev. Here are some ideas on how to include libadns into libev
		1650	(there is a Perl module named C<EV::ADNS> that does this, which you could
		1651	use for an actually working example. Another Perl module named C<EV::Glib>
		1652	embeds a Glib main context into libev, and finally, C<Glib::EV> embeds EV
		1653	into the Glib event loop).
		1654
		1655	Method 1: Add IO watchers and a timeout watcher in a prepare handler,
1374	in a check watcher, destroy them and call into libadns. What follows is	1656	and in a check watcher, destroy them and call into libadns. What follows
1375	pseudo-code only of course:	1657	is pseudo-code only of course. This requires you to either use a low
		1658	priority for the check watcher or use C<ev_clear_pending> explicitly, as
		1659	the callbacks for the IO/timeout watchers might not have been called yet.
1376		1660
1377	static ev_io iow [nfd];	1661	static ev_io iow [nfd];
1378	static ev_timer tw;	1662	static ev_timer tw;
1379		1663
1380	static void	1664	static void
1381	io_cb (ev_loop *loop, ev_io *w, int revents)	1665	io_cb (ev_loop *loop, ev_io *w, int revents)
1382	{	1666	{
1383	// set the relevant poll flags
1384	// could also call adns_processreadable etc. here
1385	struct pollfd *fd = (struct pollfd *)w->data;
1386	if (revents & EV_READ ) fd->revents |= fd->events & POLLIN;
1387	if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT;
1388	}	1667	}
1389		1668
1390	// create io watchers for each fd and a timer before blocking	1669	// create io watchers for each fd and a timer before blocking
1391	static void	1670	static void
1392	adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents)	1671	adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents)
1393	{	1672	{
1394	int timeout = 3600000;truct pollfd fds [nfd];	1673	int timeout = 3600000;
		1674	struct pollfd fds [nfd];
1395	// actual code will need to loop here and realloc etc.	1675	// actual code will need to loop here and realloc etc.
1396	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));	1676	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
1397		1677
1398	/* the callback is illegal, but won't be called as we stop during check */	1678	/* the callback is illegal, but won't be called as we stop during check */
1399	ev_timer_init (&tw, 0, timeout * 1e-3);	1679	ev_timer_init (&tw, 0, timeout * 1e-3);
1400	ev_timer_start (loop, &tw);	1680	ev_timer_start (loop, &tw);
1401		1681
1402	// create on ev_io per pollfd	1682	// create one ev_io per pollfd
1403	for (int i = 0; i < nfd; ++i)	1683	for (int i = 0; i < nfd; ++i)
1404	{	1684	{
1405	ev_io_init (iow + i, io_cb, fds [i].fd,	1685	ev_io_init (iow + i, io_cb, fds [i].fd,
1406	((fds [i].events & POLLIN ? EV_READ : 0)	1686	((fds [i].events & POLLIN ? EV_READ : 0)
1407	| (fds [i].events & POLLOUT ? EV_WRITE : 0)));	1687	| (fds [i].events & POLLOUT ? EV_WRITE : 0)));
1408		1688
1409	fds [i].revents = 0;	1689	fds [i].revents = 0;
1410	iow [i].data = fds + i;
1411	ev_io_start (loop, iow + i);	1690	ev_io_start (loop, iow + i);
1412	}	1691	}
1413	}	1692	}
1414		1693
1415	// stop all watchers after blocking	1694	// stop all watchers after blocking
…		…
1417	adns_check_cb (ev_loop *loop, ev_check *w, int revents)	1696	adns_check_cb (ev_loop *loop, ev_check *w, int revents)
1418	{	1697	{
1419	ev_timer_stop (loop, &tw);	1698	ev_timer_stop (loop, &tw);
1420		1699
1421	for (int i = 0; i < nfd; ++i)	1700	for (int i = 0; i < nfd; ++i)
		1701	{
		1702	// set the relevant poll flags
		1703	// could also call adns_processreadable etc. here
		1704	struct pollfd *fd = fds + i;
		1705	int revents = ev_clear_pending (iow + i);
		1706	if (revents & EV_READ ) fd->revents |= fd->events & POLLIN;
		1707	if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT;
		1708
		1709	// now stop the watcher
1422	ev_io_stop (loop, iow + i);	1710	ev_io_stop (loop, iow + i);
		1711	}
1423		1712
1424	adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));	1713	adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));
		1714	}
		1715
		1716	Method 2: This would be just like method 1, but you run C<adns_afterpoll>
		1717	in the prepare watcher and would dispose of the check watcher.
		1718
		1719	Method 3: If the module to be embedded supports explicit event
		1720	notification (adns does), you can also make use of the actual watcher
		1721	callbacks, and only destroy/create the watchers in the prepare watcher.
		1722
		1723	static void
		1724	timer_cb (EV_P_ ev_timer *w, int revents)
		1725	{
		1726	adns_state ads = (adns_state)w->data;
		1727	update_now (EV_A);
		1728
		1729	adns_processtimeouts (ads, &tv_now);
		1730	}
		1731
		1732	static void
		1733	io_cb (EV_P_ ev_io *w, int revents)
		1734	{
		1735	adns_state ads = (adns_state)w->data;
		1736	update_now (EV_A);
		1737
		1738	if (revents & EV_READ ) adns_processreadable (ads, w->fd, &tv_now);
		1739	if (revents & EV_WRITE) adns_processwriteable (ads, w->fd, &tv_now);
		1740	}
		1741
		1742	// do not ever call adns_afterpoll
		1743
		1744	Method 4: Do not use a prepare or check watcher because the module you
		1745	want to embed is too inflexible to support it. Instead, youc na override
		1746	their poll function. The drawback with this solution is that the main
		1747	loop is now no longer controllable by EV. The C<Glib::EV> module does
		1748	this.
		1749
		1750	static gint
		1751	event_poll_func (GPollFD *fds, guint nfds, gint timeout)
		1752	{
		1753	int got_events = 0;
		1754
		1755	for (n = 0; n < nfds; ++n)
		1756	// create/start io watcher that sets the relevant bits in fds[n] and increment got_events
		1757
		1758	if (timeout >= 0)
		1759	// create/start timer
		1760
		1761	// poll
		1762	ev_loop (EV_A_ 0);
		1763
		1764	// stop timer again
		1765	if (timeout >= 0)
		1766	ev_timer_stop (EV_A_ &to);
		1767
		1768	// stop io watchers again - their callbacks should have set
		1769	for (n = 0; n < nfds; ++n)
		1770	ev_io_stop (EV_A_ iow [n]);
		1771
		1772	return got_events;
1425	}	1773	}
1426		1774
1427		1775
1428	=head2 C<ev_embed> - when one backend isn't enough...	1776	=head2 C<ev_embed> - when one backend isn't enough...
1429		1777
1430	This is a rather advanced watcher type that lets you embed one event loop	1778	This is a rather advanced watcher type that lets you embed one event loop
1431	into another (currently only C<ev_io> events are supported in the embedded	1779	into another (currently only C<ev_io> events are supported in the embedded
1432	loop, other types of watchers might be handled in a delayed or incorrect	1780	loop, other types of watchers might be handled in a delayed or incorrect
1433	fashion and must not be used).	1781	fashion and must not be used). (See portability notes, below).
1434		1782
1435	There are primarily two reasons you would want that: work around bugs and	1783	There are primarily two reasons you would want that: work around bugs and
1436	prioritise I/O.	1784	prioritise I/O.
1437		1785
1438	As an example for a bug workaround, the kqueue backend might only support	1786	As an example for a bug workaround, the kqueue backend might only support
…		…
1493	ev_embed_start (loop_hi, &embed);	1841	ev_embed_start (loop_hi, &embed);
1494	}	1842	}
1495	else	1843	else
1496	loop_lo = loop_hi;	1844	loop_lo = loop_hi;
1497		1845
		1846	=head2 Portability notes
		1847
		1848	Kqueue is nominally embeddable, but this is broken on all BSDs that I
		1849	tried, in various ways. Usually the embedded event loop will simply never
		1850	receive events, sometimes it will only trigger a few times, sometimes in a
		1851	loop. Epoll is also nominally embeddable, but many Linux kernel versions
		1852	will always eport the epoll fd as ready, even when no events are pending.
		1853
		1854	While libev allows embedding these backends (they are contained in
		1855	C<ev_embeddable_backends ()>), take extreme care that it will actually
		1856	work.
		1857
		1858	When in doubt, create a dynamic event loop forced to use sockets (this
		1859	usually works) and possibly another thread and a pipe or so to report to
		1860	your main event loop.
		1861
		1862	=head3 Watcher-Specific Functions and Data Members
		1863
1498	=over 4	1864	=over 4
1499		1865
1500	=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)	1866	=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)
1501		1867
1502	=item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)	1868	=item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)
…		…
1511		1877
1512	Make a single, non-blocking sweep over the embedded loop. This works	1878	Make a single, non-blocking sweep over the embedded loop. This works
1513	similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most	1879	similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most
1514	apropriate way for embedded loops.	1880	apropriate way for embedded loops.
1515		1881
1516	=item struct ev_loop *loop [read-only]	1882	=item struct ev_loop *other [read-only]
1517		1883
1518	The embedded event loop.	1884	The embedded event loop.
1519		1885
1520	=back	1886	=back
1521		1887
…		…
1528	event loop blocks next and before C<ev_check> watchers are being called,	1894	event loop blocks next and before C<ev_check> watchers are being called,
1529	and only in the child after the fork. If whoever good citizen calling	1895	and only in the child after the fork. If whoever good citizen calling
1530	C<ev_default_fork> cheats and calls it in the wrong process, the fork	1896	C<ev_default_fork> cheats and calls it in the wrong process, the fork
1531	handlers will be invoked, too, of course.	1897	handlers will be invoked, too, of course.
1532		1898
		1899	=head3 Watcher-Specific Functions and Data Members
		1900
1533	=over 4	1901	=over 4
1534		1902
1535	=item ev_fork_init (ev_signal *, callback)	1903	=item ev_fork_init (ev_signal *, callback)
1536		1904
1537	Initialises and configures the fork watcher - it has no parameters of any	1905	Initialises and configures the fork watcher - it has no parameters of any
…		…
1633		2001
1634	To use it,	2002	To use it,
1635		2003
1636	#include <ev++.h>	2004	#include <ev++.h>
1637		2005
1638	(it is not installed by default). This automatically includes F<ev.h>	2006	This automatically includes F<ev.h> and puts all of its definitions (many
1639	and puts all of its definitions (many of them macros) into the global	2007	of them macros) into the global namespace. All C++ specific things are
1640	namespace. All C++ specific things are put into the C<ev> namespace.	2008	put into the C<ev> namespace. It should support all the same embedding
		2009	options as F<ev.h>, most notably C<EV_MULTIPLICITY>.
1641		2010
1642	It should support all the same embedding options as F<ev.h>, most notably	2011	Care has been taken to keep the overhead low. The only data member the C++
1643	C<EV_MULTIPLICITY>.	2012	classes add (compared to plain C-style watchers) is the event loop pointer
		2013	that the watcher is associated with (or no additional members at all if
		2014	you disable C<EV_MULTIPLICITY> when embedding libev).
		2015
		2016	Currently, functions, and static and non-static member functions can be
		2017	used as callbacks. Other types should be easy to add as long as they only
		2018	need one additional pointer for context. If you need support for other
		2019	types of functors please contact the author (preferably after implementing
		2020	it).
1644		2021
1645	Here is a list of things available in the C<ev> namespace:	2022	Here is a list of things available in the C<ev> namespace:
1646		2023
1647	=over 4	2024	=over 4
1648		2025
…		…
1664		2041
1665	All of those classes have these methods:	2042	All of those classes have these methods:
1666		2043
1667	=over 4	2044	=over 4
1668		2045
1669	=item ev::TYPE::TYPE (object *, object::method *)	2046	=item ev::TYPE::TYPE ()
1670		2047
1671	=item ev::TYPE::TYPE (object *, object::method *, struct ev_loop *)	2048	=item ev::TYPE::TYPE (struct ev_loop *)
1672		2049
1673	=item ev::TYPE::~TYPE	2050	=item ev::TYPE::~TYPE
1674		2051
1675	The constructor takes a pointer to an object and a method pointer to	2052	The constructor (optionally) takes an event loop to associate the watcher
1676	the event handler callback to call in this class. The constructor calls	2053	with. If it is omitted, it will use C<EV_DEFAULT>.
1677	C<ev_init> for you, which means you have to call the C<set> method	2054
1678	before starting it. If you do not specify a loop then the constructor	2055	The constructor calls C<ev_init> for you, which means you have to call the
1679	automatically associates the default loop with this watcher.	2056	C<set> method before starting it.
		2057
		2058	It will not set a callback, however: You have to call the templated C<set>
		2059	method to set a callback before you can start the watcher.
		2060
		2061	(The reason why you have to use a method is a limitation in C++ which does
		2062	not allow explicit template arguments for constructors).
1680		2063
1681	The destructor automatically stops the watcher if it is active.	2064	The destructor automatically stops the watcher if it is active.
		2065
		2066	=item w->set<class, &class::method> (object *)
		2067
		2068	This method sets the callback method to call. The method has to have a
		2069	signature of C<void (*)(ev_TYPE &, int)>, it receives the watcher as
		2070	first argument and the C<revents> as second. The object must be given as
		2071	parameter and is stored in the C<data> member of the watcher.
		2072
		2073	This method synthesizes efficient thunking code to call your method from
		2074	the C callback that libev requires. If your compiler can inline your
		2075	callback (i.e. it is visible to it at the place of the C<set> call and
		2076	your compiler is good :), then the method will be fully inlined into the
		2077	thunking function, making it as fast as a direct C callback.
		2078
		2079	Example: simple class declaration and watcher initialisation
		2080
		2081	struct myclass
		2082	{
		2083	void io_cb (ev::io &w, int revents) { }
		2084	}
		2085
		2086	myclass obj;
		2087	ev::io iow;
		2088	iow.set <myclass, &myclass::io_cb> (&obj);
		2089
		2090	=item w->set<function> (void *data = 0)
		2091
		2092	Also sets a callback, but uses a static method or plain function as
		2093	callback. The optional C<data> argument will be stored in the watcher's
		2094	C<data> member and is free for you to use.
		2095
		2096	The prototype of the C<function> must be C<void (*)(ev::TYPE &w, int)>.
		2097
		2098	See the method-C<set> above for more details.
		2099
		2100	Example:
		2101
		2102	static void io_cb (ev::io &w, int revents) { }
		2103	iow.set <io_cb> ();
1682		2104
1683	=item w->set (struct ev_loop *)	2105	=item w->set (struct ev_loop *)
1684		2106
1685	Associates a different C<struct ev_loop> with this watcher. You can only	2107	Associates a different C<struct ev_loop> with this watcher. You can only
1686	do this when the watcher is inactive (and not pending either).	2108	do this when the watcher is inactive (and not pending either).
1687		2109
1688	=item w->set ([args])	2110	=item w->set ([args])
1689		2111
1690	Basically the same as C<ev_TYPE_set>, with the same args. Must be	2112	Basically the same as C<ev_TYPE_set>, with the same args. Must be
1691	called at least once. Unlike the C counterpart, an active watcher gets	2113	called at least once. Unlike the C counterpart, an active watcher gets
1692	automatically stopped and restarted.	2114	automatically stopped and restarted when reconfiguring it with this
		2115	method.
1693		2116
1694	=item w->start ()	2117	=item w->start ()
1695		2118
1696	Starts the watcher. Note that there is no C<loop> argument as the	2119	Starts the watcher. Note that there is no C<loop> argument, as the
1697	constructor already takes the loop.	2120	constructor already stores the event loop.
1698		2121
1699	=item w->stop ()	2122	=item w->stop ()
1700		2123
1701	Stops the watcher if it is active. Again, no C<loop> argument.	2124	Stops the watcher if it is active. Again, no C<loop> argument.
1702		2125
1703	=item w->again () C<ev::timer>, C<ev::periodic> only	2126	=item w->again () (C<ev::timer>, C<ev::periodic> only)
1704		2127
1705	For C<ev::timer> and C<ev::periodic>, this invokes the corresponding	2128	For C<ev::timer> and C<ev::periodic>, this invokes the corresponding
1706	C<ev_TYPE_again> function.	2129	C<ev_TYPE_again> function.
1707		2130
1708	=item w->sweep () C<ev::embed> only	2131	=item w->sweep () (C<ev::embed> only)
1709		2132
1710	Invokes C<ev_embed_sweep>.	2133	Invokes C<ev_embed_sweep>.
1711		2134
1712	=item w->update () C<ev::stat> only	2135	=item w->update () (C<ev::stat> only)
1713		2136
1714	Invokes C<ev_stat_stat>.	2137	Invokes C<ev_stat_stat>.
1715		2138
1716	=back	2139	=back
1717		2140
…		…
1727		2150
1728	myclass ();	2151	myclass ();
1729	}	2152	}
1730		2153
1731	myclass::myclass (int fd)	2154	myclass::myclass (int fd)
1732	: io (this, &myclass::io_cb),
1733	idle (this, &myclass::idle_cb)
1734	{	2155	{
		2156	io .set <myclass, &myclass::io_cb > (this);
		2157	idle.set <myclass, &myclass::idle_cb> (this);
		2158
1735	io.start (fd, ev::READ);	2159	io.start (fd, ev::READ);
1736	}	2160	}
1737		2161
1738		2162
1739	=head1 MACRO MAGIC	2163	=head1 MACRO MAGIC
1740		2164
1741	Libev can be compiled with a variety of options, the most fundemantal is	2165	Libev can be compiled with a variety of options, the most fundamantal
1742	C<EV_MULTIPLICITY>. This option determines wether (most) functions and	2166	of which is C<EV_MULTIPLICITY>. This option determines whether (most)
1743	callbacks have an initial C<struct ev_loop *> argument.	2167	functions and callbacks have an initial C<struct ev_loop *> argument.
1744		2168
1745	To make it easier to write programs that cope with either variant, the	2169	To make it easier to write programs that cope with either variant, the
1746	following macros are defined:	2170	following macros are defined:
1747		2171
1748	=over 4	2172	=over 4
…		…
1780	Similar to the other two macros, this gives you the value of the default	2204	Similar to the other two macros, this gives you the value of the default
1781	loop, if multiple loops are supported ("ev loop default").	2205	loop, if multiple loops are supported ("ev loop default").
1782		2206
1783	=back	2207	=back
1784		2208
1785	Example: Declare and initialise a check watcher, working regardless of	2209	Example: Declare and initialise a check watcher, utilising the above
1786	wether multiple loops are supported or not.	2210	macros so it will work regardless of whether multiple loops are supported
		2211	or not.
1787		2212
1788	static void	2213	static void
1789	check_cb (EV_P_ ev_timer *w, int revents)	2214	check_cb (EV_P_ ev_timer *w, int revents)
1790	{	2215	{
1791	ev_check_stop (EV_A_ w);	2216	ev_check_stop (EV_A_ w);
…		…
1794	ev_check check;	2219	ev_check check;
1795	ev_check_init (&check, check_cb);	2220	ev_check_init (&check, check_cb);
1796	ev_check_start (EV_DEFAULT_ &check);	2221	ev_check_start (EV_DEFAULT_ &check);
1797	ev_loop (EV_DEFAULT_ 0);	2222	ev_loop (EV_DEFAULT_ 0);
1798		2223
1799
1800	=head1 EMBEDDING	2224	=head1 EMBEDDING
1801		2225
1802	Libev can (and often is) directly embedded into host	2226	Libev can (and often is) directly embedded into host
1803	applications. Examples of applications that embed it include the Deliantra	2227	applications. Examples of applications that embed it include the Deliantra
1804	Game Server, the EV perl module, the GNU Virtual Private Ethernet (gvpe)	2228	Game Server, the EV perl module, the GNU Virtual Private Ethernet (gvpe)
1805	and rxvt-unicode.	2229	and rxvt-unicode.
1806		2230
1807	The goal is to enable you to just copy the neecssary files into your	2231	The goal is to enable you to just copy the necessary files into your
1808	source directory without having to change even a single line in them, so	2232	source directory without having to change even a single line in them, so
1809	you can easily upgrade by simply copying (or having a checked-out copy of	2233	you can easily upgrade by simply copying (or having a checked-out copy of
1810	libev somewhere in your source tree).	2234	libev somewhere in your source tree).
1811		2235
1812	=head2 FILESETS	2236	=head2 FILESETS
…		…
1843	ev_vars.h	2267	ev_vars.h
1844	ev_wrap.h	2268	ev_wrap.h
1845		2269
1846	ev_win32.c required on win32 platforms only	2270	ev_win32.c required on win32 platforms only
1847		2271
1848	ev_select.c only when select backend is enabled (which is by default)	2272	ev_select.c only when select backend is enabled (which is enabled by default)
1849	ev_poll.c only when poll backend is enabled (disabled by default)	2273	ev_poll.c only when poll backend is enabled (disabled by default)
1850	ev_epoll.c only when the epoll backend is enabled (disabled by default)	2274	ev_epoll.c only when the epoll backend is enabled (disabled by default)
1851	ev_kqueue.c only when the kqueue backend is enabled (disabled by default)	2275	ev_kqueue.c only when the kqueue backend is enabled (disabled by default)
1852	ev_port.c only when the solaris port backend is enabled (disabled by default)	2276	ev_port.c only when the solaris port backend is enabled (disabled by default)
1853		2277
…		…
1902		2326
1903	If defined to be C<1>, libev will try to detect the availability of the	2327	If defined to be C<1>, libev will try to detect the availability of the
1904	monotonic clock option at both compiletime and runtime. Otherwise no use	2328	monotonic clock option at both compiletime and runtime. Otherwise no use
1905	of the monotonic clock option will be attempted. If you enable this, you	2329	of the monotonic clock option will be attempted. If you enable this, you
1906	usually have to link against librt or something similar. Enabling it when	2330	usually have to link against librt or something similar. Enabling it when
1907	the functionality isn't available is safe, though, althoguh you have	2331	the functionality isn't available is safe, though, although you have
1908	to make sure you link against any libraries where the C<clock_gettime>	2332	to make sure you link against any libraries where the C<clock_gettime>
1909	function is hiding in (often F<-lrt>).	2333	function is hiding in (often F<-lrt>).
1910		2334
1911	=item EV_USE_REALTIME	2335	=item EV_USE_REALTIME
1912		2336
1913	If defined to be C<1>, libev will try to detect the availability of the	2337	If defined to be C<1>, libev will try to detect the availability of the
1914	realtime clock option at compiletime (and assume its availability at	2338	realtime clock option at compiletime (and assume its availability at
1915	runtime if successful). Otherwise no use of the realtime clock option will	2339	runtime if successful). Otherwise no use of the realtime clock option will
1916	be attempted. This effectively replaces C<gettimeofday> by C<clock_get	2340	be attempted. This effectively replaces C<gettimeofday> by C<clock_get
1917	(CLOCK_REALTIME, ...)> and will not normally affect correctness. See tzhe note about libraries	2341	(CLOCK_REALTIME, ...)> and will not normally affect correctness. See the
1918	in the description of C<EV_USE_MONOTONIC>, though.	2342	note about libraries in the description of C<EV_USE_MONOTONIC>, though.
		2343
		2344	=item EV_USE_NANOSLEEP
		2345
		2346	If defined to be C<1>, libev will assume that C<nanosleep ()> is available
		2347	and will use it for delays. Otherwise it will use C<select ()>.
1919		2348
1920	=item EV_USE_SELECT	2349	=item EV_USE_SELECT
1921		2350
1922	If undefined or defined to be C<1>, libev will compile in support for the	2351	If undefined or defined to be C<1>, libev will compile in support for the
1923	C<select>(2) backend. No attempt at autodetection will be done: if no	2352	C<select>(2) backend. No attempt at autodetection will be done: if no
…		…
1978		2407
1979	=item EV_USE_DEVPOLL	2408	=item EV_USE_DEVPOLL
1980		2409
1981	reserved for future expansion, works like the USE symbols above.	2410	reserved for future expansion, works like the USE symbols above.
1982		2411
		2412	=item EV_USE_INOTIFY
		2413
		2414	If defined to be C<1>, libev will compile in support for the Linux inotify
		2415	interface to speed up C<ev_stat> watchers. Its actual availability will
		2416	be detected at runtime.
		2417
1983	=item EV_H	2418	=item EV_H
1984		2419
1985	The name of the F<ev.h> header file used to include it. The default if	2420	The name of the F<ev.h> header file used to include it. The default if
1986	undefined is C<< <ev.h> >> in F<event.h> and C<"ev.h"> in F<ev.c>. This	2421	undefined is C<< <ev.h> >> in F<event.h> and C<"ev.h"> in F<ev.c>. This
1987	can be used to virtually rename the F<ev.h> header file in case of conflicts.	2422	can be used to virtually rename the F<ev.h> header file in case of conflicts.
…		…
2010	will have the C<struct ev_loop *> as first argument, and you can create	2445	will have the C<struct ev_loop *> as first argument, and you can create
2011	additional independent event loops. Otherwise there will be no support	2446	additional independent event loops. Otherwise there will be no support
2012	for multiple event loops and there is no first event loop pointer	2447	for multiple event loops and there is no first event loop pointer
2013	argument. Instead, all functions act on the single default loop.	2448	argument. Instead, all functions act on the single default loop.
2014		2449
		2450	=item EV_MINPRI
		2451
		2452	=item EV_MAXPRI
		2453
		2454	The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to
		2455	C<EV_MAXPRI>, but otherwise there are no non-obvious limitations. You can
		2456	provide for more priorities by overriding those symbols (usually defined
		2457	to be C<-2> and C<2>, respectively).
		2458
		2459	When doing priority-based operations, libev usually has to linearly search
		2460	all the priorities, so having many of them (hundreds) uses a lot of space
		2461	and time, so using the defaults of five priorities (-2 .. +2) is usually
		2462	fine.
		2463
		2464	If your embedding app does not need any priorities, defining these both to
		2465	C<0> will save some memory and cpu.
		2466
2015	=item EV_PERIODIC_ENABLE	2467	=item EV_PERIODIC_ENABLE
2016		2468
2017	If undefined or defined to be C<1>, then periodic timers are supported. If	2469	If undefined or defined to be C<1>, then periodic timers are supported. If
2018	defined to be C<0>, then they are not. Disabling them saves a few kB of	2470	defined to be C<0>, then they are not. Disabling them saves a few kB of
2019	code.	2471	code.
2020		2472
		2473	=item EV_IDLE_ENABLE
		2474
		2475	If undefined or defined to be C<1>, then idle watchers are supported. If
		2476	defined to be C<0>, then they are not. Disabling them saves a few kB of
		2477	code.
		2478
2021	=item EV_EMBED_ENABLE	2479	=item EV_EMBED_ENABLE
2022		2480
2023	If undefined or defined to be C<1>, then embed watchers are supported. If	2481	If undefined or defined to be C<1>, then embed watchers are supported. If
2024	defined to be C<0>, then they are not.	2482	defined to be C<0>, then they are not.
2025		2483
…		…
2042	=item EV_PID_HASHSIZE	2500	=item EV_PID_HASHSIZE
2043		2501
2044	C<ev_child> watchers use a small hash table to distribute workload by	2502	C<ev_child> watchers use a small hash table to distribute workload by
2045	pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more	2503	pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more
2046	than enough. If you need to manage thousands of children you might want to	2504	than enough. If you need to manage thousands of children you might want to
2047	increase this value.	2505	increase this value (I<must> be a power of two).
		2506
		2507	=item EV_INOTIFY_HASHSIZE
		2508
		2509	C<ev_staz> watchers use a small hash table to distribute workload by
		2510	inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>),
		2511	usually more than enough. If you need to manage thousands of C<ev_stat>
		2512	watchers you might want to increase this value (I<must> be a power of
		2513	two).
2048		2514
2049	=item EV_COMMON	2515	=item EV_COMMON
2050		2516
2051	By default, all watchers have a C<void *data> member. By redefining	2517	By default, all watchers have a C<void *data> member. By redefining
2052	this macro to a something else you can include more and other types of	2518	this macro to a something else you can include more and other types of
…		…
2065		2531
2066	=item ev_set_cb (ev, cb)	2532	=item ev_set_cb (ev, cb)
2067		2533
2068	Can be used to change the callback member declaration in each watcher,	2534	Can be used to change the callback member declaration in each watcher,
2069	and the way callbacks are invoked and set. Must expand to a struct member	2535	and the way callbacks are invoked and set. Must expand to a struct member
2070	definition and a statement, respectively. See the F<ev.v> header file for	2536	definition and a statement, respectively. See the F<ev.h> header file for
2071	their default definitions. One possible use for overriding these is to	2537	their default definitions. One possible use for overriding these is to
2072	avoid the C<struct ev_loop *> as first argument in all cases, or to use	2538	avoid the C<struct ev_loop *> as first argument in all cases, or to use
2073	method calls instead of plain function calls in C++.	2539	method calls instead of plain function calls in C++.
		2540
		2541	=head2 EXPORTED API SYMBOLS
		2542
		2543	If you need to re-export the API (e.g. via a dll) and you need a list of
		2544	exported symbols, you can use the provided F<Symbol.*> files which list
		2545	all public symbols, one per line:
		2546
		2547	Symbols.ev for libev proper
		2548	Symbols.event for the libevent emulation
		2549
		2550	This can also be used to rename all public symbols to avoid clashes with
		2551	multiple versions of libev linked together (which is obviously bad in
		2552	itself, but sometimes it is inconvinient to avoid this).
		2553
		2554	A sed command like this will create wrapper C<#define>'s that you need to
		2555	include before including F<ev.h>:
		2556
		2557	<Symbols.ev sed -e "s/.*/#define & myprefix_&/" >wrap.h
		2558
		2559	This would create a file F<wrap.h> which essentially looks like this:
		2560
		2561	#define ev_backend myprefix_ev_backend
		2562	#define ev_check_start myprefix_ev_check_start
		2563	#define ev_check_stop myprefix_ev_check_stop
		2564	...
2074		2565
2075	=head2 EXAMPLES	2566	=head2 EXAMPLES
2076		2567
2077	For a real-world example of a program the includes libev	2568	For a real-world example of a program the includes libev
2078	verbatim, you can have a look at the EV perl module	2569	verbatim, you can have a look at the EV perl module
…		…
2081	interface) and F<EV.xs> (implementation) files. Only the F<EV.xs> file	2572	interface) and F<EV.xs> (implementation) files. Only the F<EV.xs> file
2082	will be compiled. It is pretty complex because it provides its own header	2573	will be compiled. It is pretty complex because it provides its own header
2083	file.	2574	file.
2084		2575
2085	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file	2576	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file
2086	that everybody includes and which overrides some autoconf choices:	2577	that everybody includes and which overrides some configure choices:
2087		2578
		2579	#define EV_MINIMAL 1
2088	#define EV_USE_POLL 0	2580	#define EV_USE_POLL 0
2089	#define EV_MULTIPLICITY 0	2581	#define EV_MULTIPLICITY 0
2090	#define EV_PERIODICS 0	2582	#define EV_PERIODIC_ENABLE 0
		2583	#define EV_STAT_ENABLE 0
		2584	#define EV_FORK_ENABLE 0
2091	#define EV_CONFIG_H <config.h>	2585	#define EV_CONFIG_H <config.h>
		2586	#define EV_MINPRI 0
		2587	#define EV_MAXPRI 0
2092		2588
2093	#include "ev++.h"	2589	#include "ev++.h"
2094		2590
2095	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:	2591	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
2096		2592
…		…
2102		2598
2103	In this section the complexities of (many of) the algorithms used inside	2599	In this section the complexities of (many of) the algorithms used inside
2104	libev will be explained. For complexity discussions about backends see the	2600	libev will be explained. For complexity discussions about backends see the
2105	documentation for C<ev_default_init>.	2601	documentation for C<ev_default_init>.
2106		2602
		2603	All of the following are about amortised time: If an array needs to be
		2604	extended, libev needs to realloc and move the whole array, but this
		2605	happens asymptotically never with higher number of elements, so O(1) might
		2606	mean it might do a lengthy realloc operation in rare cases, but on average
		2607	it is much faster and asymptotically approaches constant time.
		2608
2107	=over 4	2609	=over 4
2108		2610
2109	=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers)	2611	=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers)
2110		2612
		2613	This means that, when you have a watcher that triggers in one hour and
		2614	there are 100 watchers that would trigger before that then inserting will
		2615	have to skip those 100 watchers.
		2616
2111	=item Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)	2617	=item Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)
2112		2618
		2619	That means that for changing a timer costs less than removing/adding them
		2620	as only the relative motion in the event queue has to be paid for.
		2621
2113	=item Starting io/check/prepare/idle/signal/child watchers: O(1)	2622	=item Starting io/check/prepare/idle/signal/child watchers: O(1)
2114		2623
		2624	These just add the watcher into an array or at the head of a list.
2115	=item Stopping check/prepare/idle watchers: O(1)	2625	=item Stopping check/prepare/idle watchers: O(1)
2116		2626
2117	=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % 16))	2627	=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))
		2628
		2629	These watchers are stored in lists then need to be walked to find the
		2630	correct watcher to remove. The lists are usually short (you don't usually
		2631	have many watchers waiting for the same fd or signal).
2118		2632
2119	=item Finding the next timer per loop iteration: O(1)	2633	=item Finding the next timer per loop iteration: O(1)
2120		2634
2121	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)	2635	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)
2122		2636
		2637	A change means an I/O watcher gets started or stopped, which requires
		2638	libev to recalculate its status (and possibly tell the kernel).
		2639
2123	=item Activating one watcher: O(1)	2640	=item Activating one watcher: O(1)
2124		2641
		2642	=item Priority handling: O(number_of_priorities)
		2643
		2644	Priorities are implemented by allocating some space for each
		2645	priority. When doing priority-based operations, libev usually has to
		2646	linearly search all the priorities.
		2647
2125	=back	2648	=back
2126		2649
2127		2650
2128	=head1 AUTHOR	2651	=head1 AUTHOR
2129		2652

Diff Legend

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