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.94 by root, Fri Dec 21 04:38:45 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.
…		…
105		119
106	=item int ev_version_major ()	120	=item int ev_version_major ()
107		121
108	=item int ev_version_minor ()	122	=item int ev_version_minor ()
109		123
110	You can find out the major and minor version numbers of the library	124	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	125	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	126	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	127	symbols C<EV_VERSION_MAJOR> and C<EV_VERSION_MINOR>, which specify the
114	version of the library your program was compiled against.	128	version of the library your program was compiled against.
115		129
		130	These version numbers refer to the ABI version of the library, not the
		131	release version.
		132
116	Usually, it's a good idea to terminate if the major versions mismatch,	133	Usually, it's a good idea to terminate if the major versions mismatch,
117	as this indicates an incompatible change. Minor versions are usually	134	as this indicates an incompatible change. Minor versions are usually
118	compatible to older versions, so a larger minor version alone is usually	135	compatible to older versions, so a larger minor version alone is usually
119	not a problem.	136	not a problem.
120		137
121	Example: make sure we haven't accidentally been linked against the wrong	138	Example: Make sure we haven't accidentally been linked against the wrong
122	version:	139	version.
123		140
124	assert (("libev version mismatch",	141	assert (("libev version mismatch",
125	ev_version_major () == EV_VERSION_MAJOR	142	ev_version_major () == EV_VERSION_MAJOR
126	&& ev_version_minor () >= EV_VERSION_MINOR));	143	&& ev_version_minor () >= EV_VERSION_MINOR));
127		144
…		…
155	C<ev_embeddable_backends () & ev_supported_backends ()>, likewise for	172	C<ev_embeddable_backends () & ev_supported_backends ()>, likewise for
156	recommended ones.	173	recommended ones.
157		174
158	See the description of C<ev_embed> watchers for more info.	175	See the description of C<ev_embed> watchers for more info.
159		176
160	=item ev_set_allocator (void *(*cb)(void *ptr, size_t size))	177	=item ev_set_allocator (void *(*cb)(void *ptr, long size))
161		178
162	Sets the allocation function to use (the prototype and semantics are	179	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	180	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	181	allocate and free memory (no surprises here). If it returns zero when
165	allocated, the library might abort or take some potentially destructive	182	memory needs to be allocated, the library might abort or take some
166	action. The default is your system realloc function.	183	potentially destructive action. The default is your system realloc
		184	function.
167		185
168	You could override this function in high-availability programs to, say,	186	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,	187	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.	188	or even to sleep a while and retry until some memory is available.
171		189
172	Example: replace the libev allocator with one that waits a bit and then	190	Example: Replace the libev allocator with one that waits a bit and then
173	retries: better than mine).	191	retries).
174		192
175	static void *	193	static void *
176	persistent_realloc (void *ptr, size_t size)	194	persistent_realloc (void *ptr, size_t size)
177	{	195	{
178	for (;;)	196	for (;;)
…		…
197	callback is set, then libev will expect it to remedy the sitution, no	215	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	216	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	217	requested operation, or, if the condition doesn't go away, do bad stuff
200	(such as abort).	218	(such as abort).
201		219
202	Example: do the same thing as libev does internally:	220	Example: This is basically the same thing that libev does internally, too.
203		221
204	static void	222	static void
205	fatal_error (const char *msg)	223	fatal_error (const char *msg)
206	{	224	{
207	perror (msg);	225	perror (msg);
…		…
257	C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will	275	C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will
258	override the flags completely if it is found in the environment. This is	276	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	277	useful to try out specific backends to test their performance, or to work
260	around bugs.	278	around bugs.
261		279
		280	=item C<EVFLAG_FORKCHECK>
		281
		282	Instead of calling C<ev_default_fork> or C<ev_loop_fork> manually after
		283	a fork, you can also make libev check for a fork in each iteration by
		284	enabling this flag.
		285
		286	This works by calling C<getpid ()> on every iteration of the loop,
		287	and thus this might slow down your event loop if you do a lot of loop
		288	iterations and little real work, but is usually not noticeable (on my
		289	Linux system for example, C<getpid> is actually a simple 5-insn sequence
		290	without a syscall and thus I<very> fast, but my Linux system also has
		291	C<pthread_atfork> which is even faster).
		292
		293	The big advantage of this flag is that you can forget about fork (and
		294	forget about forgetting to tell libev about forking) when you use this
		295	flag.
		296
		297	This flag setting cannot be overriden or specified in the C<LIBEV_FLAGS>
		298	environment variable.
		299
262	=item C<EVBACKEND_SELECT> (value 1, portable select backend)	300	=item C<EVBACKEND_SELECT> (value 1, portable select backend)
263		301
264	This is your standard select(2) backend. Not I<completely> standard, as	302	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,	303	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	304	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).	313	lot of inactive fds). It scales similarly to select, i.e. O(total_fds).
276		314
277	=item C<EVBACKEND_EPOLL> (value 4, Linux)	315	=item C<EVBACKEND_EPOLL> (value 4, Linux)
278		316
279	For few fds, this backend is a bit little slower than poll and select,	317	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	318	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	319	like O(total_fds) where n is the total number of fds (or the highest fd),
282	either O(1) or O(active_fds).	320	epoll scales either O(1) or O(active_fds). The epoll design has a number
		321	of shortcomings, such as silently dropping events in some hard-to-detect
		322	cases and rewuiring a syscall per fd change, no fork support and bad
		323	support for dup:
283		324
284	While stopping and starting an I/O watcher in the same iteration will	325	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	326	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	327	(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	328	best to avoid that. Also, C<dup ()>'ed file descriptors might not work
288	well if you register events for both fds.	329	very well if you register events for both fds.
289		330
290	Please note that epoll sometimes generates spurious notifications, so you	331	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	332	need to use non-blocking I/O or other means to avoid blocking when no data
292	(or space) is available.	333	(or space) is available.
293		334
294	=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)	335	=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)
295		336
296	Kqueue deserves special mention, as at the time of this writing, it	337	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	338	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	339	sockets and pipes, except on Darwin, where of course it's completely
		340	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"	341	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	342	unless you explicitly specify it explicitly in the flags (i.e. using
301	C<EVBACKEND_KQUEUE>).	343	C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough)
		344	system like NetBSD.
302		345
303	It scales in the same way as the epoll backend, but the interface to the	346	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	347	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	348	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	349	never cause an extra syscall as with epoll, it still adds up to two event
307	incident, so its best to avoid that.	350	changes per incident, support for C<fork ()> is very bad and it drops fds
		351	silently in similarly hard-to-detetc cases.
308		352
309	=item C<EVBACKEND_DEVPOLL> (value 16, Solaris 8)	353	=item C<EVBACKEND_DEVPOLL> (value 16, Solaris 8)
310		354
311	This is not implemented yet (and might never be).	355	This is not implemented yet (and might never be).
312		356
313	=item C<EVBACKEND_PORT> (value 32, Solaris 10)	357	=item C<EVBACKEND_PORT> (value 32, Solaris 10)
314		358
315	This uses the Solaris 10 port mechanism. As with everything on Solaris,	359	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)).	360	it's really slow, but it still scales very well (O(active_fds)).
317		361
318	Please note that solaris ports can result in a lot of spurious	362	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	363	notifications, so you need to use non-blocking I/O or other means to avoid
320	blocking when no data (or space) is available.	364	blocking when no data (or space) is available.
321		365
322	=item C<EVBACKEND_ALL>	366	=item C<EVBACKEND_ALL>
323		367
…		…
353	Similar to C<ev_default_loop>, but always creates a new event loop that is	397	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	398	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	399	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).	400	undefined behaviour (or a failed assertion if assertions are enabled).
357		401
358	Example: try to create a event loop that uses epoll and nothing else.	402	Example: Try to create a event loop that uses epoll and nothing else.
359		403
360	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);	404	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
361	if (!epoller)	405	if (!epoller)
362	fatal ("no epoll found here, maybe it hides under your chair");	406	fatal ("no epoll found here, maybe it hides under your chair");
363		407
…		…
366	Destroys the default loop again (frees all memory and kernel state	410	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	411	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	412	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>	413	responsibility to either stop all watchers cleanly yoursef I<before>
370	calling this function, or cope with the fact afterwards (which is usually	414	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	415	the easiest thing, you can just ignore the watchers and/or C<free ()> them
372	for example).	416	for example).
		417
		418	Note that certain global state, such as signal state, will not be freed by
		419	this function, and related watchers (such as signal and child watchers)
		420	would need to be stopped manually.
		421
		422	In general it is not advisable to call this function except in the
		423	rare occasion where you really need to free e.g. the signal handling
		424	pipe fds. If you need dynamically allocated loops it is better to use
		425	C<ev_loop_new> and C<ev_loop_destroy>).
373		426
374	=item ev_loop_destroy (loop)	427	=item ev_loop_destroy (loop)
375		428
376	Like C<ev_default_destroy>, but destroys an event loop created by an	429	Like C<ev_default_destroy>, but destroys an event loop created by an
377	earlier call to C<ev_loop_new>.	430	earlier call to C<ev_loop_new>.
…		…
401		454
402	Like C<ev_default_fork>, but acts on an event loop created by	455	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	456	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.	457	after fork, and how you do this is entirely your own problem.
405		458
		459	=item unsigned int ev_loop_count (loop)
		460
		461	Returns the count of loop iterations for the loop, which is identical to
		462	the number of times libev did poll for new events. It starts at C<0> and
		463	happily wraps around with enough iterations.
		464
		465	This value can sometimes be useful as a generation counter of sorts (it
		466	"ticks" the number of loop iterations), as it roughly corresponds with
		467	C<ev_prepare> and C<ev_check> calls.
		468
406	=item unsigned int ev_backend (loop)	469	=item unsigned int ev_backend (loop)
407		470
408	Returns one of the C<EVBACKEND_*> flags indicating the event backend in	471	Returns one of the C<EVBACKEND_*> flags indicating the event backend in
409	use.	472	use.
410		473
…		…
412		475
413	Returns the current "event loop time", which is the time the event loop	476	Returns the current "event loop time", which is the time the event loop
414	received events and started processing them. This timestamp does not	477	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	478	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	479	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).	480	event occurring (or more correctly, libev finding out about it).
418		481
419	=item ev_loop (loop, int flags)	482	=item ev_loop (loop, int flags)
420		483
421	Finally, this is it, the event handler. This function usually is called	484	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	485	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	506	libev watchers. However, a pair of C<ev_prepare>/C<ev_check> watchers is
444	usually a better approach for this kind of thing.	507	usually a better approach for this kind of thing.
445		508
446	Here are the gory details of what C<ev_loop> does:	509	Here are the gory details of what C<ev_loop> does:
447		510
		511	- Before the first iteration, call any pending watchers.
448	* If there are no active watchers (reference count is zero), return.	512	* If there are no active watchers (reference count is zero), return.
449	- Queue prepare watchers and then call all outstanding watchers.	513	- Queue all prepare watchers and then call all outstanding watchers.
450	- If we have been forked, recreate the kernel state.	514	- If we have been forked, recreate the kernel state.
451	- Update the kernel state with all outstanding changes.	515	- Update the kernel state with all outstanding changes.
452	- Update the "event loop time".	516	- Update the "event loop time".
453	- Calculate for how long to block.	517	- Calculate for how long to block.
454	- Block the process, waiting for any events.	518	- Block the process, waiting for any events.
…		…
462	Signals and child watchers are implemented as I/O watchers, and will	526	Signals and child watchers are implemented as I/O watchers, and will
463	be handled here by queueing them when their watcher gets executed.	527	be handled here by queueing them when their watcher gets executed.
464	- If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK	528	- If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK
465	were used, return, otherwise continue with step *.	529	were used, return, otherwise continue with step *.
466		530
467	Example: queue some jobs and then loop until no events are outsanding	531	Example: Queue some jobs and then loop until no events are outsanding
468	anymore.	532	anymore.
469		533
470	... queue jobs here, make sure they register event watchers as long	534	... 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..)	535	... as they still have work to do (even an idle watcher will do..)
472	ev_loop (my_loop, 0);	536	ev_loop (my_loop, 0);
…		…
492	visible to the libev user and should not keep C<ev_loop> from exiting if	556	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	557	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	558	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>.	559	libraries. Just remember to I<unref after start> and I<ref before stop>.
496		560
497	Example: create a signal watcher, but keep it from keeping C<ev_loop>	561	Example: Create a signal watcher, but keep it from keeping C<ev_loop>
498	running when nothing else is active.	562	running when nothing else is active.
499		563
500	struct dv_signal exitsig;	564	struct ev_signal exitsig;
501	ev_signal_init (&exitsig, sig_cb, SIGINT);	565	ev_signal_init (&exitsig, sig_cb, SIGINT);
502	ev_signal_start (myloop, &exitsig);	566	ev_signal_start (loop, &exitsig);
503	evf_unref (myloop);	567	evf_unref (loop);
504		568
505	Example: for some weird reason, unregister the above signal handler again.	569	Example: For some weird reason, unregister the above signal handler again.
506		570
507	ev_ref (myloop);	571	ev_ref (loop);
508	ev_signal_stop (myloop, &exitsig);	572	ev_signal_stop (loop, &exitsig);
509		573
510	=back	574	=back
511		575
512		576
513	=head1 ANATOMY OF A WATCHER	577	=head1 ANATOMY OF A WATCHER
…		…
693	=item bool ev_is_pending (ev_TYPE *watcher)	757	=item bool ev_is_pending (ev_TYPE *watcher)
694		758
695	Returns a true value iff the watcher is pending, (i.e. it has outstanding	759	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	760	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	761	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	762	C<ev_TYPE_set> is safe), you must not change its priority, and you must
699	libev (e.g. you cnanot C<free ()> it).	763	make sure the watcher is available to libev (e.g. you cannot C<free ()>
		764	it).
700		765
701	=item callback = ev_cb (ev_TYPE *watcher)	766	=item callback ev_cb (ev_TYPE *watcher)
702		767
703	Returns the callback currently set on the watcher.	768	Returns the callback currently set on the watcher.
704		769
705	=item ev_cb_set (ev_TYPE *watcher, callback)	770	=item ev_cb_set (ev_TYPE *watcher, callback)
706		771
707	Change the callback. You can change the callback at virtually any time	772	Change the callback. You can change the callback at virtually any time
708	(modulo threads).	773	(modulo threads).
		774
		775	=item ev_set_priority (ev_TYPE *watcher, priority)
		776
		777	=item int ev_priority (ev_TYPE *watcher)
		778
		779	Set and query the priority of the watcher. The priority is a small
		780	integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>
		781	(default: C<-2>). Pending watchers with higher priority will be invoked
		782	before watchers with lower priority, but priority will not keep watchers
		783	from being executed (except for C<ev_idle> watchers).
		784
		785	This means that priorities are I<only> used for ordering callback
		786	invocation after new events have been received. This is useful, for
		787	example, to reduce latency after idling, or more often, to bind two
		788	watchers on the same event and make sure one is called first.
		789
		790	If you need to suppress invocation when higher priority events are pending
		791	you need to look at C<ev_idle> watchers, which provide this functionality.
		792
		793	You I<must not> change the priority of a watcher as long as it is active or
		794	pending.
		795
		796	The default priority used by watchers when no priority has been set is
		797	always C<0>, which is supposed to not be too high and not be too low :).
		798
		799	Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is
		800	fine, as long as you do not mind that the priority value you query might
		801	or might not have been adjusted to be within valid range.
		802
		803	=item ev_invoke (loop, ev_TYPE *watcher, int revents)
		804
		805	Invoke the C<watcher> with the given C<loop> and C<revents>. Neither
		806	C<loop> nor C<revents> need to be valid as long as the watcher callback
		807	can deal with that fact.
		808
		809	=item int ev_clear_pending (loop, ev_TYPE *watcher)
		810
		811	If the watcher is pending, this function returns clears its pending status
		812	and returns its C<revents> bitset (as if its callback was invoked). If the
		813	watcher isn't pending it does nothing and returns C<0>.
709		814
710	=back	815	=back
711		816
712		817
713	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER	818	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
…		…
734	{	839	{
735	struct my_io *w = (struct my_io *)w_;	840	struct my_io *w = (struct my_io *)w_;
736	...	841	...
737	}	842	}
738		843
739	More interesting and less C-conformant ways of catsing your callback type	844	More interesting and less C-conformant ways of casting your callback type
740	have been omitted....	845	instead have been omitted.
		846
		847	Another common scenario is having some data structure with multiple
		848	watchers:
		849
		850	struct my_biggy
		851	{
		852	int some_data;
		853	ev_timer t1;
		854	ev_timer t2;
		855	}
		856
		857	In this case getting the pointer to C<my_biggy> is a bit more complicated,
		858	you need to use C<offsetof>:
		859
		860	#include <stddef.h>
		861
		862	static void
		863	t1_cb (EV_P_ struct ev_timer *w, int revents)
		864	{
		865	struct my_biggy big = (struct my_biggy *
		866	(((char *)w) - offsetof (struct my_biggy, t1));
		867	}
		868
		869	static void
		870	t2_cb (EV_P_ struct ev_timer *w, int revents)
		871	{
		872	struct my_biggy big = (struct my_biggy *
		873	(((char *)w) - offsetof (struct my_biggy, t2));
		874	}
741		875
742		876
743	=head1 WATCHER TYPES	877	=head1 WATCHER TYPES
744		878
745	This section describes each watcher in detail, but will not repeat	879	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	924	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.	925	C<EAGAIN> is far preferable to a program hanging until some data arrives.
792		926
793	If you cannot run the fd in non-blocking mode (for example you should not	927	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	928	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	929	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	930	such as poll (fortunately in our Xlib example, Xlib already does this on
797	its own, so its quite safe to use).	931	its own, so its quite safe to use).
		932
		933	=head3 The special problem of disappearing file descriptors
		934
		935	Some backends (e.g. kqueue, epoll) need to be told about closing a file
		936	descriptor (either by calling C<close> explicitly or by any other means,
		937	such as C<dup>). The reason is that you register interest in some file
		938	descriptor, but when it goes away, the operating system will silently drop
		939	this interest. If another file descriptor with the same number then is
		940	registered with libev, there is no efficient way to see that this is, in
		941	fact, a different file descriptor.
		942
		943	To avoid having to explicitly tell libev about such cases, libev follows
		944	the following policy: Each time C<ev_io_set> is being called, libev
		945	will assume that this is potentially a new file descriptor, otherwise
		946	it is assumed that the file descriptor stays the same. That means that
		947	you I<have> to call C<ev_io_set> (or C<ev_io_init>) when you change the
		948	descriptor even if the file descriptor number itself did not change.
		949
		950	This is how one would do it normally anyway, the important point is that
		951	the libev application should not optimise around libev but should leave
		952	optimisations to libev.
		953
		954	=head3 Ths special problem of dup'ed file descriptors
		955
		956	Some backends (e.g. epoll), cannot register events for file descriptors,
		957	but only events for the underlying file descriptions. That menas when you
		958	have C<dup ()>'ed file descriptors and register events for them, only one
		959	file descriptor might actually receive events.
		960
		961	There is no workaorund possible except not registering events
		962	for potentially C<dup ()>'ed file descriptors or to resort to
		963	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
		964
		965	=head3 The special problem of fork
		966
		967	Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit
		968	useless behaviour. Libev fully supports fork, but needs to be told about
		969	it in the child.
		970
		971	To support fork in your programs, you either have to call
		972	C<ev_default_fork ()> or C<ev_loop_fork ()> after a fork in the child,
		973	enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or
		974	C<EVBACKEND_POLL>.
		975
		976
		977	=head3 Watcher-Specific Functions
798		978
799	=over 4	979	=over 4
800		980
801	=item ev_io_init (ev_io *, callback, int fd, int events)	981	=item ev_io_init (ev_io *, callback, int fd, int events)
802		982
…		…
814		994
815	The events being watched.	995	The events being watched.
816		996
817	=back	997	=back
818		998
819	Example: call C<stdin_readable_cb> when STDIN_FILENO has become, well	999	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	1000	readable, but only once. Since it is likely line-buffered, you could
821	attempt to read a whole line in the callback:	1001	attempt to read a whole line in the callback.
822		1002
823	static void	1003	static void
824	stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents)	1004	stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents)
825	{	1005	{
826	ev_io_stop (loop, w);	1006	ev_io_stop (loop, w);
…		…
856		1036
857	The callback is guarenteed to be invoked only when its timeout has passed,	1037	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	1038	but if multiple timers become ready during the same loop iteration then
859	order of execution is undefined.	1039	order of execution is undefined.
860		1040
		1041	=head3 Watcher-Specific Functions and Data Members
		1042
861	=over 4	1043	=over 4
862		1044
863	=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)	1045	=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
864		1046
865	=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)	1047	=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)
…		…
878	=item ev_timer_again (loop)	1060	=item ev_timer_again (loop)
879		1061
880	This will act as if the timer timed out and restart it again if it is	1062	This will act as if the timer timed out and restart it again if it is
881	repeating. The exact semantics are:	1063	repeating. The exact semantics are:
882		1064
		1065	If the timer is pending, its pending status is cleared.
		1066
883	If the timer is started but nonrepeating, stop it.	1067	If the timer is started but nonrepeating, stop it (as if it timed out).
884		1068
885	If the timer is repeating, either start it if necessary (with the repeat	1069	If the timer is repeating, either start it if necessary (with the
886	value), or reset the running timer to the repeat value.	1070	C<repeat> value), or reset the running timer to the C<repeat> value.
887		1071
888	This sounds a bit complicated, but here is a useful and typical	1072	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	1073	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,	1074	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	1075	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	1076	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	1077	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	1078	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	1079	socket, you can C<ev_timer_stop> the timer, and C<ev_timer_again> will
896	need be.	1080	automatically restart it if need be.
897		1081
898	You can also ignore the C<after> value and C<ev_timer_start> altogether	1082	That means you can ignore the C<after> value and C<ev_timer_start>
899	and only ever use the C<repeat> value:	1083	altogether and only ever use the C<repeat> value and C<ev_timer_again>:
900		1084
901	ev_timer_init (timer, callback, 0., 5.);	1085	ev_timer_init (timer, callback, 0., 5.);
902	ev_timer_again (loop, timer);	1086	ev_timer_again (loop, timer);
903	...	1087	...
904	timer->again = 17.;	1088	timer->again = 17.;
905	ev_timer_again (loop, timer);	1089	ev_timer_again (loop, timer);
906	...	1090	...
907	timer->again = 10.;	1091	timer->again = 10.;
908	ev_timer_again (loop, timer);	1092	ev_timer_again (loop, timer);
909		1093
910	This is more efficient then stopping/starting the timer eahc time you want	1094	This is more slightly efficient then stopping/starting the timer each time
911	to modify its timeout value.	1095	you want to modify its timeout value.
912		1096
913	=item ev_tstamp repeat [read-write]	1097	=item ev_tstamp repeat [read-write]
914		1098
915	The current C<repeat> value. Will be used each time the watcher times out	1099	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),	1100	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.	1101	which is also when any modifications are taken into account.
918		1102
919	=back	1103	=back
920		1104
921	Example: create a timer that fires after 60 seconds.	1105	Example: Create a timer that fires after 60 seconds.
922		1106
923	static void	1107	static void
924	one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents)	1108	one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents)
925	{	1109	{
926	.. one minute over, w is actually stopped right here	1110	.. one minute over, w is actually stopped right here
…		…
928		1112
929	struct ev_timer mytimer;	1113	struct ev_timer mytimer;
930	ev_timer_init (&mytimer, one_minute_cb, 60., 0.);	1114	ev_timer_init (&mytimer, one_minute_cb, 60., 0.);
931	ev_timer_start (loop, &mytimer);	1115	ev_timer_start (loop, &mytimer);
932		1116
933	Example: create a timeout timer that times out after 10 seconds of	1117	Example: Create a timeout timer that times out after 10 seconds of
934	inactivity.	1118	inactivity.
935		1119
936	static void	1120	static void
937	timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents)	1121	timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents)
938	{	1122	{
…		…
958	but on wallclock time (absolute time). You can tell a periodic watcher	1142	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	1143	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 ()	1144	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	1145	+ 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	1146	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	1147	roughly 10 seconds later).
964	again).
965		1148
966	They can also be used to implement vastly more complex timers, such as	1149	They can also be used to implement vastly more complex timers, such as
967	triggering an event on eahc midnight, local time.	1150	triggering an event on each midnight, local time or other, complicated,
		1151	rules.
968		1152
969	As with timers, the callback is guarenteed to be invoked only when the	1153	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	1154	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.	1155	during the same loop iteration then order of execution is undefined.
972		1156
		1157	=head3 Watcher-Specific Functions and Data Members
		1158
973	=over 4	1159	=over 4
974		1160
975	=item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)	1161	=item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)
976		1162
977	=item ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)	1163	=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	1165	Lots of arguments, lets sort it out... There are basically three modes of
980	operation, and we will explain them from simplest to complex:	1166	operation, and we will explain them from simplest to complex:
981		1167
982	=over 4	1168	=over 4
983		1169
984	=item * absolute timer (interval = reschedule_cb = 0)	1170	=item * absolute timer (at = time, interval = reschedule_cb = 0)
985		1171
986	In this configuration the watcher triggers an event at the wallclock time	1172	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,	1173	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	1174	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.	1175	system time reaches or surpasses this time.
990		1176
991	=item * non-repeating interval timer (interval > 0, reschedule_cb = 0)	1177	=item * non-repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)
992		1178
993	In this mode the watcher will always be scheduled to time out at the next	1179	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	1180	C<at + N * interval> time (for some integer N, which can also be negative)
995	of any time jumps.	1181	and then repeat, regardless of any time jumps.
996		1182
997	This can be used to create timers that do not drift with respect to system	1183	This can be used to create timers that do not drift with respect to system
998	time:	1184	time:
999		1185
1000	ev_periodic_set (&periodic, 0., 3600., 0);	1186	ev_periodic_set (&periodic, 0., 3600., 0);
…		…
1006		1192
1007	Another way to think about it (for the mathematically inclined) is that	1193	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	1194	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.	1195	time where C<time = at (mod interval)>, regardless of any time jumps.
1010		1196
		1197	For numerical stability it is preferable that the C<at> value is near
		1198	C<ev_now ()> (the current time), but there is no range requirement for
		1199	this value.
		1200
1011	=item * manual reschedule mode (reschedule_cb = callback)	1201	=item * manual reschedule mode (at and interval ignored, reschedule_cb = callback)
1012		1202
1013	In this mode the values for C<interval> and C<at> are both being	1203	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	1204	ignored. Instead, each time the periodic watcher gets scheduled, the
1015	reschedule callback will be called with the watcher as first, and the	1205	reschedule callback will be called with the watcher as first, and the
1016	current time as second argument.	1206	current time as second argument.
1017		1207
1018	NOTE: I<This callback MUST NOT stop or destroy any periodic watcher,	1208	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,	1209	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	1210	return C<now + 1e30> (or so, fudge fudge) and stop it afterwards (e.g. by
1021	starting a prepare watcher).	1211	starting an C<ev_prepare> watcher, which is legal).
1022		1212
1023	Its prototype is C<ev_tstamp (*reschedule_cb)(struct ev_periodic *w,	1213	Its prototype is C<ev_tstamp (*reschedule_cb)(struct ev_periodic *w,
1024	ev_tstamp now)>, e.g.:	1214	ev_tstamp now)>, e.g.:
1025		1215
1026	static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)	1216	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	1239	Simply stops and restarts the periodic watcher again. This is only useful
1050	when you changed some parameters or the reschedule callback would return	1240	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	1241	a different time than the last time it was called (e.g. in a crond like
1052	program when the crontabs have changed).	1242	program when the crontabs have changed).
1053		1243
		1244	=item ev_tstamp offset [read-write]
		1245
		1246	When repeating, this contains the offset value, otherwise this is the
		1247	absolute point in time (the C<at> value passed to C<ev_periodic_set>).
		1248
		1249	Can be modified any time, but changes only take effect when the periodic
		1250	timer fires or C<ev_periodic_again> is being called.
		1251
1054	=item ev_tstamp interval [read-write]	1252	=item ev_tstamp interval [read-write]
1055		1253
1056	The current interval value. Can be modified any time, but changes only	1254	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	1255	take effect when the periodic timer fires or C<ev_periodic_again> is being
1058	called.	1256	called.
…		…
1061		1259
1062	The current reschedule callback, or C<0>, if this functionality is	1260	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	1261	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.	1262	the periodic timer fires or C<ev_periodic_again> is being called.
1065		1263
		1264	=item ev_tstamp at [read-only]
		1265
		1266	When active, contains the absolute time that the watcher is supposed to
		1267	trigger next.
		1268
1066	=back	1269	=back
1067		1270
1068	Example: call a callback every hour, or, more precisely, whenever the	1271	Example: Call a callback every hour, or, more precisely, whenever the
1069	system clock is divisible by 3600. The callback invocation times have	1272	system clock is divisible by 3600. The callback invocation times have
1070	potentially a lot of jittering, but good long-term stability.	1273	potentially a lot of jittering, but good long-term stability.
1071		1274
1072	static void	1275	static void
1073	clock_cb (struct ev_loop *loop, struct ev_io *w, int revents)	1276	clock_cb (struct ev_loop *loop, struct ev_io *w, int revents)
…		…
1077		1280
1078	struct ev_periodic hourly_tick;	1281	struct ev_periodic hourly_tick;
1079	ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);	1282	ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);
1080	ev_periodic_start (loop, &hourly_tick);	1283	ev_periodic_start (loop, &hourly_tick);
1081		1284
1082	Example: the same as above, but use a reschedule callback to do it:	1285	Example: The same as above, but use a reschedule callback to do it:
1083		1286
1084	#include <math.h>	1287	#include <math.h>
1085		1288
1086	static ev_tstamp	1289	static ev_tstamp
1087	my_scheduler_cb (struct ev_periodic *w, ev_tstamp now)	1290	my_scheduler_cb (struct ev_periodic *w, ev_tstamp now)
…		…
1089	return fmod (now, 3600.) + 3600.;	1292	return fmod (now, 3600.) + 3600.;
1090	}	1293	}
1091		1294
1092	ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);	1295	ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);
1093		1296
1094	Example: call a callback every hour, starting now:	1297	Example: Call a callback every hour, starting now:
1095		1298
1096	struct ev_periodic hourly_tick;	1299	struct ev_periodic hourly_tick;
1097	ev_periodic_init (&hourly_tick, clock_cb,	1300	ev_periodic_init (&hourly_tick, clock_cb,
1098	fmod (ev_now (loop), 3600.), 3600., 0);	1301	fmod (ev_now (loop), 3600.), 3600., 0);
1099	ev_periodic_start (loop, &hourly_tick);	1302	ev_periodic_start (loop, &hourly_tick);
…		…
1111	with the kernel (thus it coexists with your own signal handlers as long	1314	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	1315	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	1316	watcher for a signal is stopped libev will reset the signal handler to
1114	SIG_DFL (regardless of what it was set to before).	1317	SIG_DFL (regardless of what it was set to before).
1115		1318
		1319	=head3 Watcher-Specific Functions and Data Members
		1320
1116	=over 4	1321	=over 4
1117		1322
1118	=item ev_signal_init (ev_signal *, callback, int signum)	1323	=item ev_signal_init (ev_signal *, callback, int signum)
1119		1324
1120	=item ev_signal_set (ev_signal *, int signum)	1325	=item ev_signal_set (ev_signal *, int signum)
…		…
1131		1336
1132	=head2 C<ev_child> - watch out for process status changes	1337	=head2 C<ev_child> - watch out for process status changes
1133		1338
1134	Child watchers trigger when your process receives a SIGCHLD in response to	1339	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).	1340	some child status changes (most typically when a child of yours dies).
		1341
		1342	=head3 Watcher-Specific Functions and Data Members
1136		1343
1137	=over 4	1344	=over 4
1138		1345
1139	=item ev_child_init (ev_child *, callback, int pid)	1346	=item ev_child_init (ev_child *, callback, int pid)
1140		1347
…		…
1160	The process exit/trace status caused by C<rpid> (see your systems	1367	The process exit/trace status caused by C<rpid> (see your systems
1161	C<waitpid> and C<sys/wait.h> documentation for details).	1368	C<waitpid> and C<sys/wait.h> documentation for details).
1162		1369
1163	=back	1370	=back
1164		1371
1165	Example: try to exit cleanly on SIGINT and SIGTERM.	1372	Example: Try to exit cleanly on SIGINT and SIGTERM.
1166		1373
1167	static void	1374	static void
1168	sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)	1375	sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)
1169	{	1376	{
1170	ev_unloop (loop, EVUNLOOP_ALL);	1377	ev_unloop (loop, EVUNLOOP_ALL);
…		…
1185	not exist" is a status change like any other. The condition "path does	1392	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	1393	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	1394	otherwise always forced to be at least one) and all the other fields of
1188	the stat buffer having unspecified contents.	1395	the stat buffer having unspecified contents.
1189		1396
		1397	The path I<should> be absolute and I<must not> end in a slash. If it is
		1398	relative and your working directory changes, the behaviour is undefined.
		1399
1190	Since there is no standard to do this, the portable implementation simply	1400	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	1401	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	1402	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,	1403	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	1404	unspecified default> value will be used (which you can expect to be around
1195	five seconds, although this might change dynamically). Libev will also	1405	five seconds, although this might change dynamically). Libev will also
1196	impose a minimum interval which is currently around C<0.1>, but thats	1406	impose a minimum interval which is currently around C<0.1>, but thats
…		…
1198		1408
1199	This watcher type is not meant for massive numbers of stat watchers,	1409	This watcher type is not meant for massive numbers of stat watchers,
1200	as even with OS-supported change notifications, this can be	1410	as even with OS-supported change notifications, this can be
1201	resource-intensive.	1411	resource-intensive.
1202		1412
1203	At the time of this writing, no specific OS backends are implemented, but	1413	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.	1414	implemented (implementing kqueue support is left as an exercise for the
		1415	reader). Inotify will be used to give hints only and should not change the
		1416	semantics of C<ev_stat> watchers, which means that libev sometimes needs
		1417	to fall back to regular polling again even with inotify, but changes are
		1418	usually detected immediately, and if the file exists there will be no
		1419	polling.
		1420
		1421	=head3 Watcher-Specific Functions and Data Members
1205		1422
1206	=over 4	1423	=over 4
1207		1424
1208	=item ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)	1425	=item ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)
1209		1426
…		…
1273	ev_stat_start (loop, &passwd);	1490	ev_stat_start (loop, &passwd);
1274		1491
1275		1492
1276	=head2 C<ev_idle> - when you've got nothing better to do...	1493	=head2 C<ev_idle> - when you've got nothing better to do...
1277		1494
1278	Idle watchers trigger events when there are no other events are pending	1495	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	1496	priority are pending (prepare, check and other idle watchers do not
1280	as your process is busy handling sockets or timeouts (or even signals,	1497	count).
1281	imagine) it will not be triggered. But when your process is idle all idle	1498
1282	watchers are being called again and again, once per event loop iteration -	1499	That is, as long as your process is busy handling sockets or timeouts
		1500	(or even signals, imagine) of the same or higher priority it will not be
		1501	triggered. But when your process is idle (or only lower-priority watchers
		1502	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	1503	iteration - until stopped, that is, or your process receives more events
1284	busy.	1504	and becomes busy again with higher priority stuff.
1285		1505
1286	The most noteworthy effect is that as long as any idle watchers are	1506	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.	1507	active, the process will not block when waiting for new events.
1288		1508
1289	Apart from keeping your process non-blocking (which is a useful	1509	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	1510	effect on its own sometimes), idle watchers are a good place to do
1291	"pseudo-background processing", or delay processing stuff to after the	1511	"pseudo-background processing", or delay processing stuff to after the
1292	event loop has handled all outstanding events.	1512	event loop has handled all outstanding events.
1293		1513
		1514	=head3 Watcher-Specific Functions and Data Members
		1515
1294	=over 4	1516	=over 4
1295		1517
1296	=item ev_idle_init (ev_signal *, callback)	1518	=item ev_idle_init (ev_signal *, callback)
1297		1519
1298	Initialises and configures the idle watcher - it has no parameters of any	1520	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,	1521	kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,
1300	believe me.	1522	believe me.
1301		1523
1302	=back	1524	=back
1303		1525
1304	Example: dynamically allocate an C<ev_idle>, start it, and in the	1526	Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the
1305	callback, free it. Alos, use no error checking, as usual.	1527	callback, free it. Also, use no error checking, as usual.
1306		1528
1307	static void	1529	static void
1308	idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents)	1530	idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents)
1309	{	1531	{
1310	free (w);	1532	free (w);
…		…
1355	with priority higher than or equal to the event loop and one coroutine	1577	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	1578	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	1579	loop from blocking if lower-priority coroutines are active, thus mapping
1358	low-priority coroutines to idle/background tasks).	1580	low-priority coroutines to idle/background tasks).
1359		1581
		1582	It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>)
		1583	priority, to ensure that they are being run before any other watchers
		1584	after the poll. Also, C<ev_check> watchers (and C<ev_prepare> watchers,
		1585	too) should not activate ("feed") events into libev. While libev fully
		1586	supports this, they will be called before other C<ev_check> watchers did
		1587	their job. As C<ev_check> watchers are often used to embed other event
		1588	loops those other event loops might be in an unusable state until their
		1589	C<ev_check> watcher ran (always remind yourself to coexist peacefully with
		1590	others).
		1591
		1592	=head3 Watcher-Specific Functions and Data Members
		1593
1360	=over 4	1594	=over 4
1361		1595
1362	=item ev_prepare_init (ev_prepare *, callback)	1596	=item ev_prepare_init (ev_prepare *, callback)
1363		1597
1364	=item ev_check_init (ev_check *, callback)	1598	=item ev_check_init (ev_check *, callback)
…		…
1367	parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>	1601	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.	1602	macros, but using them is utterly, utterly and completely pointless.
1369		1603
1370	=back	1604	=back
1371		1605
1372	Example: To include a library such as adns, you would add IO watchers	1606	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	1607	into libev. Here are some ideas on how to include libadns into libev
		1608	(there is a Perl module named C<EV::ADNS> that does this, which you could
		1609	use for an actually working example. Another Perl module named C<EV::Glib>
		1610	embeds a Glib main context into libev, and finally, C<Glib::EV> embeds EV
		1611	into the Glib event loop).
		1612
		1613	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	1614	and in a check watcher, destroy them and call into libadns. What follows
1375	pseudo-code only of course:	1615	is pseudo-code only of course. This requires you to either use a low
		1616	priority for the check watcher or use C<ev_clear_pending> explicitly, as
		1617	the callbacks for the IO/timeout watchers might not have been called yet.
1376		1618
1377	static ev_io iow [nfd];	1619	static ev_io iow [nfd];
1378	static ev_timer tw;	1620	static ev_timer tw;
1379		1621
1380	static void	1622	static void
1381	io_cb (ev_loop *loop, ev_io *w, int revents)	1623	io_cb (ev_loop *loop, ev_io *w, int revents)
1382	{	1624	{
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	}	1625	}
1389		1626
1390	// create io watchers for each fd and a timer before blocking	1627	// create io watchers for each fd and a timer before blocking
1391	static void	1628	static void
1392	adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents)	1629	adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents)
1393	{	1630	{
1394	int timeout = 3600000;truct pollfd fds [nfd];	1631	int timeout = 3600000;
		1632	struct pollfd fds [nfd];
1395	// actual code will need to loop here and realloc etc.	1633	// actual code will need to loop here and realloc etc.
1396	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));	1634	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
1397		1635
1398	/* the callback is illegal, but won't be called as we stop during check */	1636	/* the callback is illegal, but won't be called as we stop during check */
1399	ev_timer_init (&tw, 0, timeout * 1e-3);	1637	ev_timer_init (&tw, 0, timeout * 1e-3);
1400	ev_timer_start (loop, &tw);	1638	ev_timer_start (loop, &tw);
1401		1639
1402	// create on ev_io per pollfd	1640	// create one ev_io per pollfd
1403	for (int i = 0; i < nfd; ++i)	1641	for (int i = 0; i < nfd; ++i)
1404	{	1642	{
1405	ev_io_init (iow + i, io_cb, fds [i].fd,	1643	ev_io_init (iow + i, io_cb, fds [i].fd,
1406	((fds [i].events & POLLIN ? EV_READ : 0)	1644	((fds [i].events & POLLIN ? EV_READ : 0)
1407	| (fds [i].events & POLLOUT ? EV_WRITE : 0)));	1645	| (fds [i].events & POLLOUT ? EV_WRITE : 0)));
1408		1646
1409	fds [i].revents = 0;	1647	fds [i].revents = 0;
1410	iow [i].data = fds + i;
1411	ev_io_start (loop, iow + i);	1648	ev_io_start (loop, iow + i);
1412	}	1649	}
1413	}	1650	}
1414		1651
1415	// stop all watchers after blocking	1652	// stop all watchers after blocking
…		…
1417	adns_check_cb (ev_loop *loop, ev_check *w, int revents)	1654	adns_check_cb (ev_loop *loop, ev_check *w, int revents)
1418	{	1655	{
1419	ev_timer_stop (loop, &tw);	1656	ev_timer_stop (loop, &tw);
1420		1657
1421	for (int i = 0; i < nfd; ++i)	1658	for (int i = 0; i < nfd; ++i)
		1659	{
		1660	// set the relevant poll flags
		1661	// could also call adns_processreadable etc. here
		1662	struct pollfd *fd = fds + i;
		1663	int revents = ev_clear_pending (iow + i);
		1664	if (revents & EV_READ ) fd->revents |= fd->events & POLLIN;
		1665	if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT;
		1666
		1667	// now stop the watcher
1422	ev_io_stop (loop, iow + i);	1668	ev_io_stop (loop, iow + i);
		1669	}
1423		1670
1424	adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));	1671	adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));
		1672	}
		1673
		1674	Method 2: This would be just like method 1, but you run C<adns_afterpoll>
		1675	in the prepare watcher and would dispose of the check watcher.
		1676
		1677	Method 3: If the module to be embedded supports explicit event
		1678	notification (adns does), you can also make use of the actual watcher
		1679	callbacks, and only destroy/create the watchers in the prepare watcher.
		1680
		1681	static void
		1682	timer_cb (EV_P_ ev_timer *w, int revents)
		1683	{
		1684	adns_state ads = (adns_state)w->data;
		1685	update_now (EV_A);
		1686
		1687	adns_processtimeouts (ads, &tv_now);
		1688	}
		1689
		1690	static void
		1691	io_cb (EV_P_ ev_io *w, int revents)
		1692	{
		1693	adns_state ads = (adns_state)w->data;
		1694	update_now (EV_A);
		1695
		1696	if (revents & EV_READ ) adns_processreadable (ads, w->fd, &tv_now);
		1697	if (revents & EV_WRITE) adns_processwriteable (ads, w->fd, &tv_now);
		1698	}
		1699
		1700	// do not ever call adns_afterpoll
		1701
		1702	Method 4: Do not use a prepare or check watcher because the module you
		1703	want to embed is too inflexible to support it. Instead, youc na override
		1704	their poll function. The drawback with this solution is that the main
		1705	loop is now no longer controllable by EV. The C<Glib::EV> module does
		1706	this.
		1707
		1708	static gint
		1709	event_poll_func (GPollFD *fds, guint nfds, gint timeout)
		1710	{
		1711	int got_events = 0;
		1712
		1713	for (n = 0; n < nfds; ++n)
		1714	// create/start io watcher that sets the relevant bits in fds[n] and increment got_events
		1715
		1716	if (timeout >= 0)
		1717	// create/start timer
		1718
		1719	// poll
		1720	ev_loop (EV_A_ 0);
		1721
		1722	// stop timer again
		1723	if (timeout >= 0)
		1724	ev_timer_stop (EV_A_ &to);
		1725
		1726	// stop io watchers again - their callbacks should have set
		1727	for (n = 0; n < nfds; ++n)
		1728	ev_io_stop (EV_A_ iow [n]);
		1729
		1730	return got_events;
1425	}	1731	}
1426		1732
1427		1733
1428	=head2 C<ev_embed> - when one backend isn't enough...	1734	=head2 C<ev_embed> - when one backend isn't enough...
1429		1735
1430	This is a rather advanced watcher type that lets you embed one event loop	1736	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	1737	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	1738	loop, other types of watchers might be handled in a delayed or incorrect
1433	fashion and must not be used).	1739	fashion and must not be used). (See portability notes, below).
1434		1740
1435	There are primarily two reasons you would want that: work around bugs and	1741	There are primarily two reasons you would want that: work around bugs and
1436	prioritise I/O.	1742	prioritise I/O.
1437		1743
1438	As an example for a bug workaround, the kqueue backend might only support	1744	As an example for a bug workaround, the kqueue backend might only support
…		…
1493	ev_embed_start (loop_hi, &embed);	1799	ev_embed_start (loop_hi, &embed);
1494	}	1800	}
1495	else	1801	else
1496	loop_lo = loop_hi;	1802	loop_lo = loop_hi;
1497		1803
		1804	=head2 Portability notes
		1805
		1806	Kqueue is nominally embeddable, but this is broken on all BSDs that I
		1807	tried, in various ways. Usually the embedded event loop will simply never
		1808	receive events, sometimes it will only trigger a few times, sometimes in a
		1809	loop. Epoll is also nominally embeddable, but many Linux kernel versions
		1810	will always eport the epoll fd as ready, even when no events are pending.
		1811
		1812	While libev allows embedding these backends (they are contained in
		1813	C<ev_embeddable_backends ()>), take extreme care that it will actually
		1814	work.
		1815
		1816	When in doubt, create a dynamic event loop forced to use sockets (this
		1817	usually works) and possibly another thread and a pipe or so to report to
		1818	your main event loop.
		1819
		1820	=head3 Watcher-Specific Functions and Data Members
		1821
1498	=over 4	1822	=over 4
1499		1823
1500	=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)	1824	=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)
1501		1825
1502	=item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)	1826	=item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)
…		…
1511		1835
1512	Make a single, non-blocking sweep over the embedded loop. This works	1836	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	1837	similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most
1514	apropriate way for embedded loops.	1838	apropriate way for embedded loops.
1515		1839
1516	=item struct ev_loop *loop [read-only]	1840	=item struct ev_loop *other [read-only]
1517		1841
1518	The embedded event loop.	1842	The embedded event loop.
1519		1843
1520	=back	1844	=back
1521		1845
…		…
1528	event loop blocks next and before C<ev_check> watchers are being called,	1852	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	1853	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	1854	C<ev_default_fork> cheats and calls it in the wrong process, the fork
1531	handlers will be invoked, too, of course.	1855	handlers will be invoked, too, of course.
1532		1856
		1857	=head3 Watcher-Specific Functions and Data Members
		1858
1533	=over 4	1859	=over 4
1534		1860
1535	=item ev_fork_init (ev_signal *, callback)	1861	=item ev_fork_init (ev_signal *, callback)
1536		1862
1537	Initialises and configures the fork watcher - it has no parameters of any	1863	Initialises and configures the fork watcher - it has no parameters of any
…		…
1633		1959
1634	To use it,	1960	To use it,
1635		1961
1636	#include <ev++.h>	1962	#include <ev++.h>
1637		1963
1638	(it is not installed by default). This automatically includes F<ev.h>	1964	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	1965	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.	1966	put into the C<ev> namespace. It should support all the same embedding
		1967	options as F<ev.h>, most notably C<EV_MULTIPLICITY>.
1641		1968
1642	It should support all the same embedding options as F<ev.h>, most notably	1969	Care has been taken to keep the overhead low. The only data member the C++
1643	C<EV_MULTIPLICITY>.	1970	classes add (compared to plain C-style watchers) is the event loop pointer
		1971	that the watcher is associated with (or no additional members at all if
		1972	you disable C<EV_MULTIPLICITY> when embedding libev).
		1973
		1974	Currently, functions, and static and non-static member functions can be
		1975	used as callbacks. Other types should be easy to add as long as they only
		1976	need one additional pointer for context. If you need support for other
		1977	types of functors please contact the author (preferably after implementing
		1978	it).
1644		1979
1645	Here is a list of things available in the C<ev> namespace:	1980	Here is a list of things available in the C<ev> namespace:
1646		1981
1647	=over 4	1982	=over 4
1648		1983
…		…
1664		1999
1665	All of those classes have these methods:	2000	All of those classes have these methods:
1666		2001
1667	=over 4	2002	=over 4
1668		2003
1669	=item ev::TYPE::TYPE (object *, object::method *)	2004	=item ev::TYPE::TYPE ()
1670		2005
1671	=item ev::TYPE::TYPE (object *, object::method *, struct ev_loop *)	2006	=item ev::TYPE::TYPE (struct ev_loop *)
1672		2007
1673	=item ev::TYPE::~TYPE	2008	=item ev::TYPE::~TYPE
1674		2009
1675	The constructor takes a pointer to an object and a method pointer to	2010	The constructor (optionally) takes an event loop to associate the watcher
1676	the event handler callback to call in this class. The constructor calls	2011	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	2012
1678	before starting it. If you do not specify a loop then the constructor	2013	The constructor calls C<ev_init> for you, which means you have to call the
1679	automatically associates the default loop with this watcher.	2014	C<set> method before starting it.
		2015
		2016	It will not set a callback, however: You have to call the templated C<set>
		2017	method to set a callback before you can start the watcher.
		2018
		2019	(The reason why you have to use a method is a limitation in C++ which does
		2020	not allow explicit template arguments for constructors).
1680		2021
1681	The destructor automatically stops the watcher if it is active.	2022	The destructor automatically stops the watcher if it is active.
		2023
		2024	=item w->set<class, &class::method> (object *)
		2025
		2026	This method sets the callback method to call. The method has to have a
		2027	signature of C<void (*)(ev_TYPE &, int)>, it receives the watcher as
		2028	first argument and the C<revents> as second. The object must be given as
		2029	parameter and is stored in the C<data> member of the watcher.
		2030
		2031	This method synthesizes efficient thunking code to call your method from
		2032	the C callback that libev requires. If your compiler can inline your
		2033	callback (i.e. it is visible to it at the place of the C<set> call and
		2034	your compiler is good :), then the method will be fully inlined into the
		2035	thunking function, making it as fast as a direct C callback.
		2036
		2037	Example: simple class declaration and watcher initialisation
		2038
		2039	struct myclass
		2040	{
		2041	void io_cb (ev::io &w, int revents) { }
		2042	}
		2043
		2044	myclass obj;
		2045	ev::io iow;
		2046	iow.set <myclass, &myclass::io_cb> (&obj);
		2047
		2048	=item w->set<function> (void *data = 0)
		2049
		2050	Also sets a callback, but uses a static method or plain function as
		2051	callback. The optional C<data> argument will be stored in the watcher's
		2052	C<data> member and is free for you to use.
		2053
		2054	The prototype of the C<function> must be C<void (*)(ev::TYPE &w, int)>.
		2055
		2056	See the method-C<set> above for more details.
		2057
		2058	Example:
		2059
		2060	static void io_cb (ev::io &w, int revents) { }
		2061	iow.set <io_cb> ();
1682		2062
1683	=item w->set (struct ev_loop *)	2063	=item w->set (struct ev_loop *)
1684		2064
1685	Associates a different C<struct ev_loop> with this watcher. You can only	2065	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).	2066	do this when the watcher is inactive (and not pending either).
1687		2067
1688	=item w->set ([args])	2068	=item w->set ([args])
1689		2069
1690	Basically the same as C<ev_TYPE_set>, with the same args. Must be	2070	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	2071	called at least once. Unlike the C counterpart, an active watcher gets
1692	automatically stopped and restarted.	2072	automatically stopped and restarted when reconfiguring it with this
		2073	method.
1693		2074
1694	=item w->start ()	2075	=item w->start ()
1695		2076
1696	Starts the watcher. Note that there is no C<loop> argument as the	2077	Starts the watcher. Note that there is no C<loop> argument, as the
1697	constructor already takes the loop.	2078	constructor already stores the event loop.
1698		2079
1699	=item w->stop ()	2080	=item w->stop ()
1700		2081
1701	Stops the watcher if it is active. Again, no C<loop> argument.	2082	Stops the watcher if it is active. Again, no C<loop> argument.
1702		2083
1703	=item w->again () C<ev::timer>, C<ev::periodic> only	2084	=item w->again () (C<ev::timer>, C<ev::periodic> only)
1704		2085
1705	For C<ev::timer> and C<ev::periodic>, this invokes the corresponding	2086	For C<ev::timer> and C<ev::periodic>, this invokes the corresponding
1706	C<ev_TYPE_again> function.	2087	C<ev_TYPE_again> function.
1707		2088
1708	=item w->sweep () C<ev::embed> only	2089	=item w->sweep () (C<ev::embed> only)
1709		2090
1710	Invokes C<ev_embed_sweep>.	2091	Invokes C<ev_embed_sweep>.
1711		2092
1712	=item w->update () C<ev::stat> only	2093	=item w->update () (C<ev::stat> only)
1713		2094
1714	Invokes C<ev_stat_stat>.	2095	Invokes C<ev_stat_stat>.
1715		2096
1716	=back	2097	=back
1717		2098
…		…
1727		2108
1728	myclass ();	2109	myclass ();
1729	}	2110	}
1730		2111
1731	myclass::myclass (int fd)	2112	myclass::myclass (int fd)
1732	: io (this, &myclass::io_cb),
1733	idle (this, &myclass::idle_cb)
1734	{	2113	{
		2114	io .set <myclass, &myclass::io_cb > (this);
		2115	idle.set <myclass, &myclass::idle_cb> (this);
		2116
1735	io.start (fd, ev::READ);	2117	io.start (fd, ev::READ);
1736	}	2118	}
1737		2119
1738		2120
1739	=head1 MACRO MAGIC	2121	=head1 MACRO MAGIC
1740		2122
1741	Libev can be compiled with a variety of options, the most fundemantal is	2123	Libev can be compiled with a variety of options, the most fundamantal
1742	C<EV_MULTIPLICITY>. This option determines wether (most) functions and	2124	of which is C<EV_MULTIPLICITY>. This option determines whether (most)
1743	callbacks have an initial C<struct ev_loop *> argument.	2125	functions and callbacks have an initial C<struct ev_loop *> argument.
1744		2126
1745	To make it easier to write programs that cope with either variant, the	2127	To make it easier to write programs that cope with either variant, the
1746	following macros are defined:	2128	following macros are defined:
1747		2129
1748	=over 4	2130	=over 4
…		…
1780	Similar to the other two macros, this gives you the value of the default	2162	Similar to the other two macros, this gives you the value of the default
1781	loop, if multiple loops are supported ("ev loop default").	2163	loop, if multiple loops are supported ("ev loop default").
1782		2164
1783	=back	2165	=back
1784		2166
1785	Example: Declare and initialise a check watcher, working regardless of	2167	Example: Declare and initialise a check watcher, utilising the above
1786	wether multiple loops are supported or not.	2168	macros so it will work regardless of whether multiple loops are supported
		2169	or not.
1787		2170
1788	static void	2171	static void
1789	check_cb (EV_P_ ev_timer *w, int revents)	2172	check_cb (EV_P_ ev_timer *w, int revents)
1790	{	2173	{
1791	ev_check_stop (EV_A_ w);	2174	ev_check_stop (EV_A_ w);
…		…
1794	ev_check check;	2177	ev_check check;
1795	ev_check_init (&check, check_cb);	2178	ev_check_init (&check, check_cb);
1796	ev_check_start (EV_DEFAULT_ &check);	2179	ev_check_start (EV_DEFAULT_ &check);
1797	ev_loop (EV_DEFAULT_ 0);	2180	ev_loop (EV_DEFAULT_ 0);
1798		2181
1799
1800	=head1 EMBEDDING	2182	=head1 EMBEDDING
1801		2183
1802	Libev can (and often is) directly embedded into host	2184	Libev can (and often is) directly embedded into host
1803	applications. Examples of applications that embed it include the Deliantra	2185	applications. Examples of applications that embed it include the Deliantra
1804	Game Server, the EV perl module, the GNU Virtual Private Ethernet (gvpe)	2186	Game Server, the EV perl module, the GNU Virtual Private Ethernet (gvpe)
1805	and rxvt-unicode.	2187	and rxvt-unicode.
1806		2188
1807	The goal is to enable you to just copy the neecssary files into your	2189	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	2190	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	2191	you can easily upgrade by simply copying (or having a checked-out copy of
1810	libev somewhere in your source tree).	2192	libev somewhere in your source tree).
1811		2193
1812	=head2 FILESETS	2194	=head2 FILESETS
…		…
1843	ev_vars.h	2225	ev_vars.h
1844	ev_wrap.h	2226	ev_wrap.h
1845		2227
1846	ev_win32.c required on win32 platforms only	2228	ev_win32.c required on win32 platforms only
1847		2229
1848	ev_select.c only when select backend is enabled (which is by default)	2230	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)	2231	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)	2232	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)	2233	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)	2234	ev_port.c only when the solaris port backend is enabled (disabled by default)
1853		2235
…		…
1902		2284
1903	If defined to be C<1>, libev will try to detect the availability of the	2285	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	2286	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	2287	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	2288	usually have to link against librt or something similar. Enabling it when
1907	the functionality isn't available is safe, though, althoguh you have	2289	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>	2290	to make sure you link against any libraries where the C<clock_gettime>
1909	function is hiding in (often F<-lrt>).	2291	function is hiding in (often F<-lrt>).
1910		2292
1911	=item EV_USE_REALTIME	2293	=item EV_USE_REALTIME
1912		2294
1913	If defined to be C<1>, libev will try to detect the availability of the	2295	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	2296	realtime clock option at compiletime (and assume its availability at
1915	runtime if successful). Otherwise no use of the realtime clock option will	2297	runtime if successful). Otherwise no use of the realtime clock option will
1916	be attempted. This effectively replaces C<gettimeofday> by C<clock_get	2298	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	2299	(CLOCK_REALTIME, ...)> and will not normally affect correctness. See the
1918	in the description of C<EV_USE_MONOTONIC>, though.	2300	note about libraries in the description of C<EV_USE_MONOTONIC>, though.
1919		2301
1920	=item EV_USE_SELECT	2302	=item EV_USE_SELECT
1921		2303
1922	If undefined or defined to be C<1>, libev will compile in support for the	2304	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	2305	C<select>(2) backend. No attempt at autodetection will be done: if no
…		…
1978		2360
1979	=item EV_USE_DEVPOLL	2361	=item EV_USE_DEVPOLL
1980		2362
1981	reserved for future expansion, works like the USE symbols above.	2363	reserved for future expansion, works like the USE symbols above.
1982		2364
		2365	=item EV_USE_INOTIFY
		2366
		2367	If defined to be C<1>, libev will compile in support for the Linux inotify
		2368	interface to speed up C<ev_stat> watchers. Its actual availability will
		2369	be detected at runtime.
		2370
1983	=item EV_H	2371	=item EV_H
1984		2372
1985	The name of the F<ev.h> header file used to include it. The default if	2373	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	2374	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.	2375	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	2398	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	2399	additional independent event loops. Otherwise there will be no support
2012	for multiple event loops and there is no first event loop pointer	2400	for multiple event loops and there is no first event loop pointer
2013	argument. Instead, all functions act on the single default loop.	2401	argument. Instead, all functions act on the single default loop.
2014		2402
		2403	=item EV_MINPRI
		2404
		2405	=item EV_MAXPRI
		2406
		2407	The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to
		2408	C<EV_MAXPRI>, but otherwise there are no non-obvious limitations. You can
		2409	provide for more priorities by overriding those symbols (usually defined
		2410	to be C<-2> and C<2>, respectively).
		2411
		2412	When doing priority-based operations, libev usually has to linearly search
		2413	all the priorities, so having many of them (hundreds) uses a lot of space
		2414	and time, so using the defaults of five priorities (-2 .. +2) is usually
		2415	fine.
		2416
		2417	If your embedding app does not need any priorities, defining these both to
		2418	C<0> will save some memory and cpu.
		2419
2015	=item EV_PERIODIC_ENABLE	2420	=item EV_PERIODIC_ENABLE
2016		2421
2017	If undefined or defined to be C<1>, then periodic timers are supported. If	2422	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	2423	defined to be C<0>, then they are not. Disabling them saves a few kB of
2019	code.	2424	code.
2020		2425
		2426	=item EV_IDLE_ENABLE
		2427
		2428	If undefined or defined to be C<1>, then idle watchers are supported. If
		2429	defined to be C<0>, then they are not. Disabling them saves a few kB of
		2430	code.
		2431
2021	=item EV_EMBED_ENABLE	2432	=item EV_EMBED_ENABLE
2022		2433
2023	If undefined or defined to be C<1>, then embed watchers are supported. If	2434	If undefined or defined to be C<1>, then embed watchers are supported. If
2024	defined to be C<0>, then they are not.	2435	defined to be C<0>, then they are not.
2025		2436
…		…
2042	=item EV_PID_HASHSIZE	2453	=item EV_PID_HASHSIZE
2043		2454
2044	C<ev_child> watchers use a small hash table to distribute workload by	2455	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	2456	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	2457	than enough. If you need to manage thousands of children you might want to
2047	increase this value.	2458	increase this value (I<must> be a power of two).
		2459
		2460	=item EV_INOTIFY_HASHSIZE
		2461
		2462	C<ev_staz> watchers use a small hash table to distribute workload by
		2463	inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>),
		2464	usually more than enough. If you need to manage thousands of C<ev_stat>
		2465	watchers you might want to increase this value (I<must> be a power of
		2466	two).
2048		2467
2049	=item EV_COMMON	2468	=item EV_COMMON
2050		2469
2051	By default, all watchers have a C<void *data> member. By redefining	2470	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	2471	this macro to a something else you can include more and other types of
…		…
2065		2484
2066	=item ev_set_cb (ev, cb)	2485	=item ev_set_cb (ev, cb)
2067		2486
2068	Can be used to change the callback member declaration in each watcher,	2487	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	2488	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	2489	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	2490	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	2491	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++.	2492	method calls instead of plain function calls in C++.
		2493
		2494	=head2 EXPORTED API SYMBOLS
		2495
		2496	If you need to re-export the API (e.g. via a dll) and you need a list of
		2497	exported symbols, you can use the provided F<Symbol.*> files which list
		2498	all public symbols, one per line:
		2499
		2500	Symbols.ev for libev proper
		2501	Symbols.event for the libevent emulation
		2502
		2503	This can also be used to rename all public symbols to avoid clashes with
		2504	multiple versions of libev linked together (which is obviously bad in
		2505	itself, but sometimes it is inconvinient to avoid this).
		2506
		2507	A sed command like this will create wrapper C<#define>'s that you need to
		2508	include before including F<ev.h>:
		2509
		2510	<Symbols.ev sed -e "s/.*/#define & myprefix_&/" >wrap.h
		2511
		2512	This would create a file F<wrap.h> which essentially looks like this:
		2513
		2514	#define ev_backend myprefix_ev_backend
		2515	#define ev_check_start myprefix_ev_check_start
		2516	#define ev_check_stop myprefix_ev_check_stop
		2517	...
2074		2518
2075	=head2 EXAMPLES	2519	=head2 EXAMPLES
2076		2520
2077	For a real-world example of a program the includes libev	2521	For a real-world example of a program the includes libev
2078	verbatim, you can have a look at the EV perl module	2522	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	2525	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	2526	will be compiled. It is pretty complex because it provides its own header
2083	file.	2527	file.
2084		2528
2085	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file	2529	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:	2530	that everybody includes and which overrides some configure choices:
2087		2531
		2532	#define EV_MINIMAL 1
2088	#define EV_USE_POLL 0	2533	#define EV_USE_POLL 0
2089	#define EV_MULTIPLICITY 0	2534	#define EV_MULTIPLICITY 0
2090	#define EV_PERIODICS 0	2535	#define EV_PERIODIC_ENABLE 0
		2536	#define EV_STAT_ENABLE 0
		2537	#define EV_FORK_ENABLE 0
2091	#define EV_CONFIG_H <config.h>	2538	#define EV_CONFIG_H <config.h>
		2539	#define EV_MINPRI 0
		2540	#define EV_MAXPRI 0
2092		2541
2093	#include "ev++.h"	2542	#include "ev++.h"
2094		2543
2095	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:	2544	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
2096		2545
…		…
2102		2551
2103	In this section the complexities of (many of) the algorithms used inside	2552	In this section the complexities of (many of) the algorithms used inside
2104	libev will be explained. For complexity discussions about backends see the	2553	libev will be explained. For complexity discussions about backends see the
2105	documentation for C<ev_default_init>.	2554	documentation for C<ev_default_init>.
2106		2555
		2556	All of the following are about amortised time: If an array needs to be
		2557	extended, libev needs to realloc and move the whole array, but this
		2558	happens asymptotically never with higher number of elements, so O(1) might
		2559	mean it might do a lengthy realloc operation in rare cases, but on average
		2560	it is much faster and asymptotically approaches constant time.
		2561
2107	=over 4	2562	=over 4
2108		2563
2109	=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers)	2564	=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers)
2110		2565
		2566	This means that, when you have a watcher that triggers in one hour and
		2567	there are 100 watchers that would trigger before that then inserting will
		2568	have to skip those 100 watchers.
		2569
2111	=item Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)	2570	=item Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)
2112		2571
		2572	That means that for changing a timer costs less than removing/adding them
		2573	as only the relative motion in the event queue has to be paid for.
		2574
2113	=item Starting io/check/prepare/idle/signal/child watchers: O(1)	2575	=item Starting io/check/prepare/idle/signal/child watchers: O(1)
2114		2576
		2577	These just add the watcher into an array or at the head of a list.
2115	=item Stopping check/prepare/idle watchers: O(1)	2578	=item Stopping check/prepare/idle watchers: O(1)
2116		2579
2117	=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % 16))	2580	=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))
		2581
		2582	These watchers are stored in lists then need to be walked to find the
		2583	correct watcher to remove. The lists are usually short (you don't usually
		2584	have many watchers waiting for the same fd or signal).
2118		2585
2119	=item Finding the next timer per loop iteration: O(1)	2586	=item Finding the next timer per loop iteration: O(1)
2120		2587
2121	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)	2588	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)
2122		2589
		2590	A change means an I/O watcher gets started or stopped, which requires
		2591	libev to recalculate its status (and possibly tell the kernel).
		2592
2123	=item Activating one watcher: O(1)	2593	=item Activating one watcher: O(1)
2124		2594
		2595	=item Priority handling: O(number_of_priorities)
		2596
		2597	Priorities are implemented by allocating some space for each
		2598	priority. When doing priority-based operations, libev usually has to
		2599	linearly search all the priorities.
		2600
2125	=back	2601	=back
2126		2602
2127		2603
2128	=head1 AUTHOR	2604	=head1 AUTHOR
2129		2605

Diff Legend

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