ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.157 by root, Tue May 20 23:49:41 2008 UTC vs.
Revision 1.166 by root, Tue Jun 3 03:48:10 2008 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	#include <ev.h>	7	#include <ev.h>
8		8
9	=head2 EXAMPLE PROGRAM	9	=head2 EXAMPLE PROGRAM
10		10
11	// a single header file is required	11	// a single header file is required
12	#include <ev.h>	12	#include <ev.h>
13		13
14	// every watcher type has its own typedef'd struct	14	// every watcher type has its own typedef'd struct
15	// with the name ev_<type>	15	// with the name ev_<type>
16	ev_io stdin_watcher;	16	ev_io stdin_watcher;
17	ev_timer timeout_watcher;	17	ev_timer timeout_watcher;
18		18
19	// all watcher callbacks have a similar signature	19	// all watcher callbacks have a similar signature
20	// this callback is called when data is readable on stdin	20	// this callback is called when data is readable on stdin
21	static void	21	static void
22	stdin_cb (EV_P_ struct ev_io *w, int revents)	22	stdin_cb (EV_P_ struct ev_io *w, int revents)
23	{	23	{
24	puts ("stdin ready");	24	puts ("stdin ready");
25	// for one-shot events, one must manually stop the watcher	25	// for one-shot events, one must manually stop the watcher
26	// with its corresponding stop function.	26	// with its corresponding stop function.
27	ev_io_stop (EV_A_ w);	27	ev_io_stop (EV_A_ w);
28		28
29	// this causes all nested ev_loop's to stop iterating	29	// this causes all nested ev_loop's to stop iterating
30	ev_unloop (EV_A_ EVUNLOOP_ALL);	30	ev_unloop (EV_A_ EVUNLOOP_ALL);
31	}	31	}
32		32
33	// another callback, this time for a time-out	33	// another callback, this time for a time-out
34	static void	34	static void
35	timeout_cb (EV_P_ struct ev_timer *w, int revents)	35	timeout_cb (EV_P_ struct ev_timer *w, int revents)
36	{	36	{
37	puts ("timeout");	37	puts ("timeout");
38	// this causes the innermost ev_loop to stop iterating	38	// this causes the innermost ev_loop to stop iterating
39	ev_unloop (EV_A_ EVUNLOOP_ONE);	39	ev_unloop (EV_A_ EVUNLOOP_ONE);
40	}	40	}
41		41
42	int	42	int
43	main (void)	43	main (void)
44	{	44	{
45	// use the default event loop unless you have special needs	45	// use the default event loop unless you have special needs
46	struct ev_loop *loop = ev_default_loop (0);	46	struct ev_loop *loop = ev_default_loop (0);
47		47
48	// initialise an io watcher, then start it	48	// initialise an io watcher, then start it
49	// this one will watch for stdin to become readable	49	// this one will watch for stdin to become readable
50	ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);	50	ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);
51	ev_io_start (loop, &stdin_watcher);	51	ev_io_start (loop, &stdin_watcher);
52		52
53	// initialise a timer watcher, then start it	53	// initialise a timer watcher, then start it
54	// simple non-repeating 5.5 second timeout	54	// simple non-repeating 5.5 second timeout
55	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);	55	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
56	ev_timer_start (loop, &timeout_watcher);	56	ev_timer_start (loop, &timeout_watcher);
57		57
58	// now wait for events to arrive	58	// now wait for events to arrive
59	ev_loop (loop, 0);	59	ev_loop (loop, 0);
60		60
61	// unloop was called, so exit	61	// unloop was called, so exit
62	return 0;	62	return 0;
63	}	63	}
64		64
65	=head1 DESCRIPTION	65	=head1 DESCRIPTION
66		66
67	The newest version of this document is also available as an html-formatted	67	The newest version of this document is also available as an html-formatted
68	web page you might find easier to navigate when reading it for the first	68	web page you might find easier to navigate when reading it for the first
…		…
113	Libev represents time as a single floating point number, representing the	113	Libev represents time as a single floating point number, representing the
114	(fractional) number of seconds since the (POSIX) epoch (somewhere near	114	(fractional) number of seconds since the (POSIX) epoch (somewhere near
115	the beginning of 1970, details are complicated, don't ask). This type is	115	the beginning of 1970, details are complicated, don't ask). This type is
116	called C<ev_tstamp>, which is what you should use too. It usually aliases	116	called C<ev_tstamp>, which is what you should use too. It usually aliases
117	to the C<double> type in C, and when you need to do any calculations on	117	to the C<double> type in C, and when you need to do any calculations on
118	it, you should treat it as some floatingpoint value. Unlike the name	118	it, you should treat it as some floating point value. Unlike the name
119	component C<stamp> might indicate, it is also used for time differences	119	component C<stamp> might indicate, it is also used for time differences
120	throughout libev.	120	throughout libev.
		121
		122	=head1 ERROR HANDLING
		123
		124	Libev knows three classes of errors: operating system errors, usage errors
		125	and internal errors (bugs).
		126
		127	When libev catches an operating system error it cannot handle (for example
		128	a system call indicating a condition libev cannot fix), it calls the callback
		129	set via C<ev_set_syserr_cb>, which is supposed to fix the problem or
		130	abort. The default is to print a diagnostic message and to call C<abort
		131	()>.
		132
		133	When libev detects a usage error such as a negative timer interval, then
		134	it will print a diagnostic message and abort (via the C<assert> mechanism,
		135	so C<NDEBUG> will disable this checking): these are programming errors in
		136	the libev caller and need to be fixed there.
		137
		138	Libev also has a few internal error-checking C<assert>ions, and also has
		139	extensive consistency checking code. These do not trigger under normal
		140	circumstances, as they indicate either a bug in libev or worse.
		141
121		142
122	=head1 GLOBAL FUNCTIONS	143	=head1 GLOBAL FUNCTIONS
123		144
124	These functions can be called anytime, even before initialising the	145	These functions can be called anytime, even before initialising the
125	library in any way.	146	library in any way.
…		…
134		155
135	=item ev_sleep (ev_tstamp interval)	156	=item ev_sleep (ev_tstamp interval)
136		157
137	Sleep for the given interval: The current thread will be blocked until	158	Sleep for the given interval: The current thread will be blocked until
138	either it is interrupted or the given time interval has passed. Basically	159	either it is interrupted or the given time interval has passed. Basically
139	this is a subsecond-resolution C<sleep ()>.	160	this is a sub-second-resolution C<sleep ()>.
140		161
141	=item int ev_version_major ()	162	=item int ev_version_major ()
142		163
143	=item int ev_version_minor ()	164	=item int ev_version_minor ()
144		165
…		…
157	not a problem.	178	not a problem.
158		179
159	Example: Make sure we haven't accidentally been linked against the wrong	180	Example: Make sure we haven't accidentally been linked against the wrong
160	version.	181	version.
161		182
162	assert (("libev version mismatch",	183	assert (("libev version mismatch",
163	ev_version_major () == EV_VERSION_MAJOR	184	ev_version_major () == EV_VERSION_MAJOR
164	&& ev_version_minor () >= EV_VERSION_MINOR));	185	&& ev_version_minor () >= EV_VERSION_MINOR));
165		186
166	=item unsigned int ev_supported_backends ()	187	=item unsigned int ev_supported_backends ()
167		188
168	Return the set of all backends (i.e. their corresponding C<EV_BACKEND_*>	189	Return the set of all backends (i.e. their corresponding C<EV_BACKEND_*>
169	value) compiled into this binary of libev (independent of their	190	value) compiled into this binary of libev (independent of their
…		…
171	a description of the set values.	192	a description of the set values.
172		193
173	Example: make sure we have the epoll method, because yeah this is cool and	194	Example: make sure we have the epoll method, because yeah this is cool and
174	a must have and can we have a torrent of it please!!!11	195	a must have and can we have a torrent of it please!!!11
175		196
176	assert (("sorry, no epoll, no sex",	197	assert (("sorry, no epoll, no sex",
177	ev_supported_backends () & EVBACKEND_EPOLL));	198	ev_supported_backends () & EVBACKEND_EPOLL));
178		199
179	=item unsigned int ev_recommended_backends ()	200	=item unsigned int ev_recommended_backends ()
180		201
181	Return the set of all backends compiled into this binary of libev and also	202	Return the set of all backends compiled into this binary of libev and also
182	recommended for this platform. This set is often smaller than the one	203	recommended for this platform. This set is often smaller than the one
183	returned by C<ev_supported_backends>, as for example kqueue is broken on	204	returned by C<ev_supported_backends>, as for example kqueue is broken on
184	most BSDs and will not be autodetected unless you explicitly request it	205	most BSDs and will not be auto-detected unless you explicitly request it
185	(assuming you know what you are doing). This is the set of backends that	206	(assuming you know what you are doing). This is the set of backends that
186	libev will probe for if you specify no backends explicitly.	207	libev will probe for if you specify no backends explicitly.
187		208
188	=item unsigned int ev_embeddable_backends ()	209	=item unsigned int ev_embeddable_backends ()
189		210
…		…
231	...	252	...
232	ev_set_allocator (persistent_realloc);	253	ev_set_allocator (persistent_realloc);
233		254
234	=item ev_set_syserr_cb (void (*cb)(const char *msg));	255	=item ev_set_syserr_cb (void (*cb)(const char *msg));
235		256
236	Set the callback function to call on a retryable syscall error (such	257	Set the callback function to call on a retryable system call error (such
237	as failed select, poll, epoll_wait). The message is a printable string	258	as failed select, poll, epoll_wait). The message is a printable string
238	indicating the system call or subsystem causing the problem. If this	259	indicating the system call or subsystem causing the problem. If this
239	callback is set, then libev will expect it to remedy the sitution, no	260	callback is set, then libev will expect it to remedy the situation, no
240	matter what, when it returns. That is, libev will generally retry the	261	matter what, when it returns. That is, libev will generally retry the
241	requested operation, or, if the condition doesn't go away, do bad stuff	262	requested operation, or, if the condition doesn't go away, do bad stuff
242	(such as abort).	263	(such as abort).
243		264
244	Example: This is basically the same thing that libev does internally, too.	265	Example: This is basically the same thing that libev does internally, too.
…		…
277	from multiple threads, you have to lock (note also that this is unlikely,	298	from multiple threads, you have to lock (note also that this is unlikely,
278	as loops cannot bes hared easily between threads anyway).	299	as loops cannot bes hared easily between threads anyway).
279		300
280	The default loop is the only loop that can handle C<ev_signal> and	301	The default loop is the only loop that can handle C<ev_signal> and
281	C<ev_child> watchers, and to do this, it always registers a handler	302	C<ev_child> watchers, and to do this, it always registers a handler
282	for C<SIGCHLD>. If this is a problem for your app you can either	303	for C<SIGCHLD>. If this is a problem for your application you can either
283	create a dynamic loop with C<ev_loop_new> that doesn't do that, or you	304	create a dynamic loop with C<ev_loop_new> that doesn't do that, or you
284	can simply overwrite the C<SIGCHLD> signal handler I<after> calling	305	can simply overwrite the C<SIGCHLD> signal handler I<after> calling
285	C<ev_default_init>.	306	C<ev_default_init>.
286		307
287	The flags argument can be used to specify special behaviour or specific	308	The flags argument can be used to specify special behaviour or specific
…		…
296	The default flags value. Use this if you have no clue (it's the right	317	The default flags value. Use this if you have no clue (it's the right
297	thing, believe me).	318	thing, believe me).
298		319
299	=item C<EVFLAG_NOENV>	320	=item C<EVFLAG_NOENV>
300		321
301	If this flag bit is ored into the flag value (or the program runs setuid	322	If this flag bit is or'ed into the flag value (or the program runs setuid
302	or setgid) then libev will I<not> look at the environment variable	323	or setgid) then libev will I<not> look at the environment variable
303	C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will	324	C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will
304	override the flags completely if it is found in the environment. This is	325	override the flags completely if it is found in the environment. This is
305	useful to try out specific backends to test their performance, or to work	326	useful to try out specific backends to test their performance, or to work
306	around bugs.	327	around bugs.
…		…
313		334
314	This works by calling C<getpid ()> on every iteration of the loop,	335	This works by calling C<getpid ()> on every iteration of the loop,
315	and thus this might slow down your event loop if you do a lot of loop	336	and thus this might slow down your event loop if you do a lot of loop
316	iterations and little real work, but is usually not noticeable (on my	337	iterations and little real work, but is usually not noticeable (on my
317	GNU/Linux system for example, C<getpid> is actually a simple 5-insn sequence	338	GNU/Linux system for example, C<getpid> is actually a simple 5-insn sequence
318	without a syscall and thus I<very> fast, but my GNU/Linux system also has	339	without a system call and thus I<very> fast, but my GNU/Linux system also has
319	C<pthread_atfork> which is even faster).	340	C<pthread_atfork> which is even faster).
320		341
321	The big advantage of this flag is that you can forget about fork (and	342	The big advantage of this flag is that you can forget about fork (and
322	forget about forgetting to tell libev about forking) when you use this	343	forget about forgetting to tell libev about forking) when you use this
323	flag.	344	flag.
324		345
325	This flag setting cannot be overriden or specified in the C<LIBEV_FLAGS>	346	This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS>
326	environment variable.	347	environment variable.
327		348
328	=item C<EVBACKEND_SELECT> (value 1, portable select backend)	349	=item C<EVBACKEND_SELECT> (value 1, portable select backend)
329		350
330	This is your standard select(2) backend. Not I<completely> standard, as	351	This is your standard select(2) backend. Not I<completely> standard, as
…		…
332	but if that fails, expect a fairly low limit on the number of fds when	353	but if that fails, expect a fairly low limit on the number of fds when
333	using this backend. It doesn't scale too well (O(highest_fd)), but its	354	using this backend. It doesn't scale too well (O(highest_fd)), but its
334	usually the fastest backend for a low number of (low-numbered :) fds.	355	usually the fastest backend for a low number of (low-numbered :) fds.
335		356
336	To get good performance out of this backend you need a high amount of	357	To get good performance out of this backend you need a high amount of
337	parallelity (most of the file descriptors should be busy). If you are	358	parallelism (most of the file descriptors should be busy). If you are
338	writing a server, you should C<accept ()> in a loop to accept as many	359	writing a server, you should C<accept ()> in a loop to accept as many
339	connections as possible during one iteration. You might also want to have	360	connections as possible during one iteration. You might also want to have
340	a look at C<ev_set_io_collect_interval ()> to increase the amount of	361	a look at C<ev_set_io_collect_interval ()> to increase the amount of
341	readiness notifications you get per iteration.	362	readiness notifications you get per iteration.
342		363
…		…
354	For few fds, this backend is a bit little slower than poll and select,	375	For few fds, this backend is a bit little slower than poll and select,
355	but it scales phenomenally better. While poll and select usually scale	376	but it scales phenomenally better. While poll and select usually scale
356	like O(total_fds) where n is the total number of fds (or the highest fd),	377	like O(total_fds) where n is the total number of fds (or the highest fd),
357	epoll scales either O(1) or O(active_fds). The epoll design has a number	378	epoll scales either O(1) or O(active_fds). The epoll design has a number
358	of shortcomings, such as silently dropping events in some hard-to-detect	379	of shortcomings, such as silently dropping events in some hard-to-detect
359	cases and requiring a syscall per fd change, no fork support and bad	380	cases and requiring a system call per fd change, no fork support and bad
360	support for dup.	381	support for dup.
361		382
362	While stopping, setting and starting an I/O watcher in the same iteration	383	While stopping, setting and starting an I/O watcher in the same iteration
363	will result in some caching, there is still a syscall per such incident	384	will result in some caching, there is still a system call per such incident
364	(because the fd could point to a different file description now), so its	385	(because the fd could point to a different file description now), so its
365	best to avoid that. Also, C<dup ()>'ed file descriptors might not work	386	best to avoid that. Also, C<dup ()>'ed file descriptors might not work
366	very well if you register events for both fds.	387	very well if you register events for both fds.
367		388
368	Please note that epoll sometimes generates spurious notifications, so you	389	Please note that epoll sometimes generates spurious notifications, so you
…		…
371		392
372	Best performance from this backend is achieved by not unregistering all	393	Best performance from this backend is achieved by not unregistering all
373	watchers for a file descriptor until it has been closed, if possible, i.e.	394	watchers for a file descriptor until it has been closed, if possible, i.e.
374	keep at least one watcher active per fd at all times.	395	keep at least one watcher active per fd at all times.
375		396
376	While nominally embeddeble in other event loops, this feature is broken in	397	While nominally embeddable in other event loops, this feature is broken in
377	all kernel versions tested so far.	398	all kernel versions tested so far.
378		399
379	=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)	400	=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)
380		401
381	Kqueue deserves special mention, as at the time of this writing, it	402	Kqueue deserves special mention, as at the time of this writing, it
382	was broken on all BSDs except NetBSD (usually it doesn't work reliably	403	was broken on all BSDs except NetBSD (usually it doesn't work reliably
383	with anything but sockets and pipes, except on Darwin, where of course	404	with anything but sockets and pipes, except on Darwin, where of course
384	it's completely useless). For this reason it's not being "autodetected"	405	it's completely useless). For this reason it's not being "auto-detected"
385	unless you explicitly specify it explicitly in the flags (i.e. using	406	unless you explicitly specify it explicitly in the flags (i.e. using
386	C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough)	407	C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough)
387	system like NetBSD.	408	system like NetBSD.
388		409
389	You still can embed kqueue into a normal poll or select backend and use it	410	You still can embed kqueue into a normal poll or select backend and use it
…		…
391	the target platform). See C<ev_embed> watchers for more info.	412	the target platform). See C<ev_embed> watchers for more info.
392		413
393	It scales in the same way as the epoll backend, but the interface to the	414	It scales in the same way as the epoll backend, but the interface to the
394	kernel is more efficient (which says nothing about its actual speed, of	415	kernel is more efficient (which says nothing about its actual speed, of
395	course). While stopping, setting and starting an I/O watcher does never	416	course). While stopping, setting and starting an I/O watcher does never
396	cause an extra syscall as with C<EVBACKEND_EPOLL>, it still adds up to	417	cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to
397	two event changes per incident, support for C<fork ()> is very bad and it	418	two event changes per incident, support for C<fork ()> is very bad and it
398	drops fds silently in similarly hard-to-detect cases.	419	drops fds silently in similarly hard-to-detect cases.
399		420
400	This backend usually performs well under most conditions.	421	This backend usually performs well under most conditions.
401		422
…		…
416	=item C<EVBACKEND_PORT> (value 32, Solaris 10)	437	=item C<EVBACKEND_PORT> (value 32, Solaris 10)
417		438
418	This uses the Solaris 10 event port mechanism. As with everything on Solaris,	439	This uses the Solaris 10 event port mechanism. As with everything on Solaris,
419	it's really slow, but it still scales very well (O(active_fds)).	440	it's really slow, but it still scales very well (O(active_fds)).
420		441
421	Please note that solaris event ports can deliver a lot of spurious	442	Please note that Solaris event ports can deliver a lot of spurious
422	notifications, so you need to use non-blocking I/O or other means to avoid	443	notifications, so you need to use non-blocking I/O or other means to avoid
423	blocking when no data (or space) is available.	444	blocking when no data (or space) is available.
424		445
425	While this backend scales well, it requires one system call per active	446	While this backend scales well, it requires one system call per active
426	file descriptor per loop iteration. For small and medium numbers of file	447	file descriptor per loop iteration. For small and medium numbers of file
…		…
439		460
440	It is definitely not recommended to use this flag.	461	It is definitely not recommended to use this flag.
441		462
442	=back	463	=back
443		464
444	If one or more of these are ored into the flags value, then only these	465	If one or more of these are or'ed into the flags value, then only these
445	backends will be tried (in the reverse order as listed here). If none are	466	backends will be tried (in the reverse order as listed here). If none are
446	specified, all backends in C<ev_recommended_backends ()> will be tried.	467	specified, all backends in C<ev_recommended_backends ()> will be tried.
447		468
448	The most typical usage is like this:	469	The most typical usage is like this:
449		470
450	if (!ev_default_loop (0))	471	if (!ev_default_loop (0))
451	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");	472	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
452		473
453	Restrict libev to the select and poll backends, and do not allow	474	Restrict libev to the select and poll backends, and do not allow
454	environment settings to be taken into account:	475	environment settings to be taken into account:
455		476
456	ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV);	477	ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV);
457		478
458	Use whatever libev has to offer, but make sure that kqueue is used if	479	Use whatever libev has to offer, but make sure that kqueue is used if
459	available (warning, breaks stuff, best use only with your own private	480	available (warning, breaks stuff, best use only with your own private
460	event loop and only if you know the OS supports your types of fds):	481	event loop and only if you know the OS supports your types of fds):
461		482
462	ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE);	483	ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE);
463		484
464	=item struct ev_loop *ev_loop_new (unsigned int flags)	485	=item struct ev_loop *ev_loop_new (unsigned int flags)
465		486
466	Similar to C<ev_default_loop>, but always creates a new event loop that is	487	Similar to C<ev_default_loop>, but always creates a new event loop that is
467	always distinct from the default loop. Unlike the default loop, it cannot	488	always distinct from the default loop. Unlike the default loop, it cannot
…		…
472	libev with threads is indeed to create one loop per thread, and using the	493	libev with threads is indeed to create one loop per thread, and using the
473	default loop in the "main" or "initial" thread.	494	default loop in the "main" or "initial" thread.
474		495
475	Example: Try to create a event loop that uses epoll and nothing else.	496	Example: Try to create a event loop that uses epoll and nothing else.
476		497
477	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);	498	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
478	if (!epoller)	499	if (!epoller)
479	fatal ("no epoll found here, maybe it hides under your chair");	500	fatal ("no epoll found here, maybe it hides under your chair");
480		501
481	=item ev_default_destroy ()	502	=item ev_default_destroy ()
482		503
483	Destroys the default loop again (frees all memory and kernel state	504	Destroys the default loop again (frees all memory and kernel state
484	etc.). None of the active event watchers will be stopped in the normal	505	etc.). None of the active event watchers will be stopped in the normal
485	sense, so e.g. C<ev_is_active> might still return true. It is your	506	sense, so e.g. C<ev_is_active> might still return true. It is your
486	responsibility to either stop all watchers cleanly yoursef I<before>	507	responsibility to either stop all watchers cleanly yourself I<before>
487	calling this function, or cope with the fact afterwards (which is usually	508	calling this function, or cope with the fact afterwards (which is usually
488	the easiest thing, you can just ignore the watchers and/or C<free ()> them	509	the easiest thing, you can just ignore the watchers and/or C<free ()> them
489	for example).	510	for example).
490		511
491	Note that certain global state, such as signal state, will not be freed by	512	Note that certain global state, such as signal state, will not be freed by
…		…
572	A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle	593	A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle
573	those events and any outstanding ones, but will not block your process in	594	those events and any outstanding ones, but will not block your process in
574	case there are no events and will return after one iteration of the loop.	595	case there are no events and will return after one iteration of the loop.
575		596
576	A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if	597	A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if
577	neccessary) and will handle those and any outstanding ones. It will block	598	necessary) and will handle those and any outstanding ones. It will block
578	your process until at least one new event arrives, and will return after	599	your process until at least one new event arrives, and will return after
579	one iteration of the loop. This is useful if you are waiting for some	600	one iteration of the loop. This is useful if you are waiting for some
580	external event in conjunction with something not expressible using other	601	external event in conjunction with something not expressible using other
581	libev watchers. However, a pair of C<ev_prepare>/C<ev_check> watchers is	602	libev watchers. However, a pair of C<ev_prepare>/C<ev_check> watchers is
582	usually a better approach for this kind of thing.	603	usually a better approach for this kind of thing.
…		…
643	respectively).	664	respectively).
644		665
645	Example: Create a signal watcher, but keep it from keeping C<ev_loop>	666	Example: Create a signal watcher, but keep it from keeping C<ev_loop>
646	running when nothing else is active.	667	running when nothing else is active.
647		668
648	struct ev_signal exitsig;	669	struct ev_signal exitsig;
649	ev_signal_init (&exitsig, sig_cb, SIGINT);	670	ev_signal_init (&exitsig, sig_cb, SIGINT);
650	ev_signal_start (loop, &exitsig);	671	ev_signal_start (loop, &exitsig);
651	evf_unref (loop);	672	evf_unref (loop);
652		673
653	Example: For some weird reason, unregister the above signal handler again.	674	Example: For some weird reason, unregister the above signal handler again.
654		675
655	ev_ref (loop);	676	ev_ref (loop);
656	ev_signal_stop (loop, &exitsig);	677	ev_signal_stop (loop, &exitsig);
657		678
658	=item ev_set_io_collect_interval (loop, ev_tstamp interval)	679	=item ev_set_io_collect_interval (loop, ev_tstamp interval)
659		680
660	=item ev_set_timeout_collect_interval (loop, ev_tstamp interval)	681	=item ev_set_timeout_collect_interval (loop, ev_tstamp interval)
661		682
…		…
683	to spend more time collecting timeouts, at the expense of increased	704	to spend more time collecting timeouts, at the expense of increased
684	latency (the watcher callback will be called later). C<ev_io> watchers	705	latency (the watcher callback will be called later). C<ev_io> watchers
685	will not be affected. Setting this to a non-null value will not introduce	706	will not be affected. Setting this to a non-null value will not introduce
686	any overhead in libev.	707	any overhead in libev.
687		708
688	Many (busy) programs can usually benefit by setting the io collect	709	Many (busy) programs can usually benefit by setting the I/O collect
689	interval to a value near C<0.1> or so, which is often enough for	710	interval to a value near C<0.1> or so, which is often enough for
690	interactive servers (of course not for games), likewise for timeouts. It	711	interactive servers (of course not for games), likewise for timeouts. It
691	usually doesn't make much sense to set it to a lower value than C<0.01>,	712	usually doesn't make much sense to set it to a lower value than C<0.01>,
692	as this approsaches the timing granularity of most systems.	713	as this approaches the timing granularity of most systems.
		714
		715	=item ev_loop_verify (loop)
		716
		717	This function only does something when C<EV_VERIFY> support has been
		718	compiled in. It tries to go through all internal structures and checks
		719	them for validity. If anything is found to be inconsistent, it will print
		720	an error message to standard error and call C<abort ()>.
		721
		722	This can be used to catch bugs inside libev itself: under normal
		723	circumstances, this function will never abort as of course libev keeps its
		724	data structures consistent.
693		725
694	=back	726	=back
695		727
696		728
697	=head1 ANATOMY OF A WATCHER	729	=head1 ANATOMY OF A WATCHER
698		730
699	A watcher is a structure that you create and register to record your	731	A watcher is a structure that you create and register to record your
700	interest in some event. For instance, if you want to wait for STDIN to	732	interest in some event. For instance, if you want to wait for STDIN to
701	become readable, you would create an C<ev_io> watcher for that:	733	become readable, you would create an C<ev_io> watcher for that:
702		734
703	static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents)	735	static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents)
704	{	736	{
705	ev_io_stop (w);	737	ev_io_stop (w);
706	ev_unloop (loop, EVUNLOOP_ALL);	738	ev_unloop (loop, EVUNLOOP_ALL);
707	}	739	}
708		740
709	struct ev_loop *loop = ev_default_loop (0);	741	struct ev_loop *loop = ev_default_loop (0);
710	struct ev_io stdin_watcher;	742	struct ev_io stdin_watcher;
711	ev_init (&stdin_watcher, my_cb);	743	ev_init (&stdin_watcher, my_cb);
712	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);	744	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);
713	ev_io_start (loop, &stdin_watcher);	745	ev_io_start (loop, &stdin_watcher);
714	ev_loop (loop, 0);	746	ev_loop (loop, 0);
715		747
716	As you can see, you are responsible for allocating the memory for your	748	As you can see, you are responsible for allocating the memory for your
717	watcher structures (and it is usually a bad idea to do this on the stack,	749	watcher structures (and it is usually a bad idea to do this on the stack,
718	although this can sometimes be quite valid).	750	although this can sometimes be quite valid).
719		751
720	Each watcher structure must be initialised by a call to C<ev_init	752	Each watcher structure must be initialised by a call to C<ev_init
721	(watcher *, callback)>, which expects a callback to be provided. This	753	(watcher *, callback)>, which expects a callback to be provided. This
722	callback gets invoked each time the event occurs (or, in the case of io	754	callback gets invoked each time the event occurs (or, in the case of I/O
723	watchers, each time the event loop detects that the file descriptor given	755	watchers, each time the event loop detects that the file descriptor given
724	is readable and/or writable).	756	is readable and/or writable).
725		757
726	Each watcher type has its own C<< ev_<type>_set (watcher *, ...) >> macro	758	Each watcher type has its own C<< ev_<type>_set (watcher *, ...) >> macro
727	with arguments specific to this watcher type. There is also a macro	759	with arguments specific to this watcher type. There is also a macro
…		…
803		835
804	The given async watcher has been asynchronously notified (see C<ev_async>).	836	The given async watcher has been asynchronously notified (see C<ev_async>).
805		837
806	=item C<EV_ERROR>	838	=item C<EV_ERROR>
807		839
808	An unspecified error has occured, the watcher has been stopped. This might	840	An unspecified error has occurred, the watcher has been stopped. This might
809	happen because the watcher could not be properly started because libev	841	happen because the watcher could not be properly started because libev
810	ran out of memory, a file descriptor was found to be closed or any other	842	ran out of memory, a file descriptor was found to be closed or any other
811	problem. You best act on it by reporting the problem and somehow coping	843	problem. You best act on it by reporting the problem and somehow coping
812	with the watcher being stopped.	844	with the watcher being stopped.
813		845
814	Libev will usually signal a few "dummy" events together with an error,	846	Libev will usually signal a few "dummy" events together with an error,
815	for example it might indicate that a fd is readable or writable, and if	847	for example it might indicate that a fd is readable or writable, and if
816	your callbacks is well-written it can just attempt the operation and cope	848	your callbacks is well-written it can just attempt the operation and cope
817	with the error from read() or write(). This will not work in multithreaded	849	with the error from read() or write(). This will not work in multi-threaded
818	programs, though, so beware.	850	programs, though, so beware.
819		851
820	=back	852	=back
821		853
822	=head2 GENERIC WATCHER FUNCTIONS	854	=head2 GENERIC WATCHER FUNCTIONS
…		…
852	Although some watcher types do not have type-specific arguments	884	Although some watcher types do not have type-specific arguments
853	(e.g. C<ev_prepare>) you still need to call its C<set> macro.	885	(e.g. C<ev_prepare>) you still need to call its C<set> macro.
854		886
855	=item C<ev_TYPE_init> (ev_TYPE *watcher, callback, [args])	887	=item C<ev_TYPE_init> (ev_TYPE *watcher, callback, [args])
856		888
857	This convinience macro rolls both C<ev_init> and C<ev_TYPE_set> macro	889	This convenience macro rolls both C<ev_init> and C<ev_TYPE_set> macro
858	calls into a single call. This is the most convinient method to initialise	890	calls into a single call. This is the most convenient method to initialise
859	a watcher. The same limitations apply, of course.	891	a watcher. The same limitations apply, of course.
860		892
861	=item C<ev_TYPE_start> (loop *, ev_TYPE *watcher)	893	=item C<ev_TYPE_start> (loop *, ev_TYPE *watcher)
862		894
863	Starts (activates) the given watcher. Only active watchers will receive	895	Starts (activates) the given watcher. Only active watchers will receive
…		…
946	to associate arbitrary data with your watcher. If you need more data and	978	to associate arbitrary data with your watcher. If you need more data and
947	don't want to allocate memory and store a pointer to it in that data	979	don't want to allocate memory and store a pointer to it in that data
948	member, you can also "subclass" the watcher type and provide your own	980	member, you can also "subclass" the watcher type and provide your own
949	data:	981	data:
950		982
951	struct my_io	983	struct my_io
952	{	984	{
953	struct ev_io io;	985	struct ev_io io;
954	int otherfd;	986	int otherfd;
955	void *somedata;	987	void *somedata;
956	struct whatever *mostinteresting;	988	struct whatever *mostinteresting;
957	}	989	}
958		990
959	And since your callback will be called with a pointer to the watcher, you	991	And since your callback will be called with a pointer to the watcher, you
960	can cast it back to your own type:	992	can cast it back to your own type:
961		993
962	static void my_cb (struct ev_loop *loop, struct ev_io *w_, int revents)	994	static void my_cb (struct ev_loop *loop, struct ev_io *w_, int revents)
963	{	995	{
964	struct my_io *w = (struct my_io *)w_;	996	struct my_io *w = (struct my_io *)w_;
965	...	997	...
966	}	998	}
967		999
968	More interesting and less C-conformant ways of casting your callback type	1000	More interesting and less C-conformant ways of casting your callback type
969	instead have been omitted.	1001	instead have been omitted.
970		1002
971	Another common scenario is having some data structure with multiple	1003	Another common scenario is having some data structure with multiple
972	watchers:	1004	watchers:
973		1005
974	struct my_biggy	1006	struct my_biggy
975	{	1007	{
976	int some_data;	1008	int some_data;
977	ev_timer t1;	1009	ev_timer t1;
978	ev_timer t2;	1010	ev_timer t2;
979	}	1011	}
980		1012
981	In this case getting the pointer to C<my_biggy> is a bit more complicated,	1013	In this case getting the pointer to C<my_biggy> is a bit more complicated,
982	you need to use C<offsetof>:	1014	you need to use C<offsetof>:
983		1015
984	#include <stddef.h>	1016	#include <stddef.h>
985		1017
986	static void	1018	static void
987	t1_cb (EV_P_ struct ev_timer *w, int revents)	1019	t1_cb (EV_P_ struct ev_timer *w, int revents)
988	{	1020	{
989	struct my_biggy big = (struct my_biggy *	1021	struct my_biggy big = (struct my_biggy *
990	(((char *)w) - offsetof (struct my_biggy, t1));	1022	(((char *)w) - offsetof (struct my_biggy, t1));
991	}	1023	}
992		1024
993	static void	1025	static void
994	t2_cb (EV_P_ struct ev_timer *w, int revents)	1026	t2_cb (EV_P_ struct ev_timer *w, int revents)
995	{	1027	{
996	struct my_biggy big = (struct my_biggy *	1028	struct my_biggy big = (struct my_biggy *
997	(((char *)w) - offsetof (struct my_biggy, t2));	1029	(((char *)w) - offsetof (struct my_biggy, t2));
998	}	1030	}
999		1031
1000		1032
1001	=head1 WATCHER TYPES	1033	=head1 WATCHER TYPES
1002		1034
1003	This section describes each watcher in detail, but will not repeat	1035	This section describes each watcher in detail, but will not repeat
…		…
1035		1067
1036	Another thing you have to watch out for is that it is quite easy to	1068	Another thing you have to watch out for is that it is quite easy to
1037	receive "spurious" readiness notifications, that is your callback might	1069	receive "spurious" readiness notifications, that is your callback might
1038	be called with C<EV_READ> but a subsequent C<read>(2) will actually block	1070	be called with C<EV_READ> but a subsequent C<read>(2) will actually block
1039	because there is no data. Not only are some backends known to create a	1071	because there is no data. Not only are some backends known to create a
1040	lot of those (for example solaris ports), it is very easy to get into	1072	lot of those (for example Solaris ports), it is very easy to get into
1041	this situation even with a relatively standard program structure. Thus	1073	this situation even with a relatively standard program structure. Thus
1042	it is best to always use non-blocking I/O: An extra C<read>(2) returning	1074	it is best to always use non-blocking I/O: An extra C<read>(2) returning
1043	C<EAGAIN> is far preferable to a program hanging until some data arrives.	1075	C<EAGAIN> is far preferable to a program hanging until some data arrives.
1044		1076
1045	If you cannot run the fd in non-blocking mode (for example you should not	1077	If you cannot run the fd in non-blocking mode (for example you should not
1046	play around with an Xlib connection), then you have to seperately re-test	1078	play around with an Xlib connection), then you have to separately re-test
1047	whether a file descriptor is really ready with a known-to-be good interface	1079	whether a file descriptor is really ready with a known-to-be good interface
1048	such as poll (fortunately in our Xlib example, Xlib already does this on	1080	such as poll (fortunately in our Xlib example, Xlib already does this on
1049	its own, so its quite safe to use).	1081	its own, so its quite safe to use).
1050		1082
1051	=head3 The special problem of disappearing file descriptors	1083	=head3 The special problem of disappearing file descriptors
…		…
1111	=item ev_io_init (ev_io *, callback, int fd, int events)	1143	=item ev_io_init (ev_io *, callback, int fd, int events)
1112		1144
1113	=item ev_io_set (ev_io *, int fd, int events)	1145	=item ev_io_set (ev_io *, int fd, int events)
1114		1146
1115	Configures an C<ev_io> watcher. The C<fd> is the file descriptor to	1147	Configures an C<ev_io> watcher. The C<fd> is the file descriptor to
1116	rceeive events for and events is either C<EV_READ>, C<EV_WRITE> or	1148	receive events for and events is either C<EV_READ>, C<EV_WRITE> or
1117	C<EV_READ | EV_WRITE> to receive the given events.	1149	C<EV_READ | EV_WRITE> to receive the given events.
1118		1150
1119	=item int fd [read-only]	1151	=item int fd [read-only]
1120		1152
1121	The file descriptor being watched.	1153	The file descriptor being watched.
…		…
1130		1162
1131	Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well	1163	Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well
1132	readable, but only once. Since it is likely line-buffered, you could	1164	readable, but only once. Since it is likely line-buffered, you could
1133	attempt to read a whole line in the callback.	1165	attempt to read a whole line in the callback.
1134		1166
1135	static void	1167	static void
1136	stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents)	1168	stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents)
1137	{	1169	{
1138	ev_io_stop (loop, w);	1170	ev_io_stop (loop, w);
1139	.. read from stdin here (or from w->fd) and haqndle any I/O errors	1171	.. read from stdin here (or from w->fd) and haqndle any I/O errors
1140	}	1172	}
1141		1173
1142	...	1174	...
1143	struct ev_loop *loop = ev_default_init (0);	1175	struct ev_loop *loop = ev_default_init (0);
1144	struct ev_io stdin_readable;	1176	struct ev_io stdin_readable;
1145	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);	1177	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);
1146	ev_io_start (loop, &stdin_readable);	1178	ev_io_start (loop, &stdin_readable);
1147	ev_loop (loop, 0);	1179	ev_loop (loop, 0);
1148		1180
1149		1181
1150	=head2 C<ev_timer> - relative and optionally repeating timeouts	1182	=head2 C<ev_timer> - relative and optionally repeating timeouts
1151		1183
1152	Timer watchers are simple relative timers that generate an event after a	1184	Timer watchers are simple relative timers that generate an event after a
1153	given time, and optionally repeating in regular intervals after that.	1185	given time, and optionally repeating in regular intervals after that.
1154		1186
1155	The timers are based on real time, that is, if you register an event that	1187	The timers are based on real time, that is, if you register an event that
1156	times out after an hour and you reset your system clock to january last	1188	times out after an hour and you reset your system clock to January last
1157	year, it will still time out after (roughly) and hour. "Roughly" because	1189	year, it will still time out after (roughly) and hour. "Roughly" because
1158	detecting time jumps is hard, and some inaccuracies are unavoidable (the	1190	detecting time jumps is hard, and some inaccuracies are unavoidable (the
1159	monotonic clock option helps a lot here).	1191	monotonic clock option helps a lot here).
1160		1192
1161	The relative timeouts are calculated relative to the C<ev_now ()>	1193	The relative timeouts are calculated relative to the C<ev_now ()>
…		…
1164	you suspect event processing to be delayed and you I<need> to base the timeout	1196	you suspect event processing to be delayed and you I<need> to base the timeout
1165	on the current time, use something like this to adjust for this:	1197	on the current time, use something like this to adjust for this:
1166		1198
1167	ev_timer_set (&timer, after + ev_now () - ev_time (), 0.);	1199	ev_timer_set (&timer, after + ev_now () - ev_time (), 0.);
1168		1200
1169	The callback is guarenteed to be invoked only after its timeout has passed,	1201	The callback is guaranteed to be invoked only after its timeout has passed,
1170	but if multiple timers become ready during the same loop iteration then	1202	but if multiple timers become ready during the same loop iteration then
1171	order of execution is undefined.	1203	order of execution is undefined.
1172		1204
1173	=head3 Watcher-Specific Functions and Data Members	1205	=head3 Watcher-Specific Functions and Data Members
1174		1206
…		…
1195	This will act as if the timer timed out and restart it again if it is	1227	This will act as if the timer timed out and restart it again if it is
1196	repeating. The exact semantics are:	1228	repeating. The exact semantics are:
1197		1229
1198	If the timer is pending, its pending status is cleared.	1230	If the timer is pending, its pending status is cleared.
1199		1231
1200	If the timer is started but nonrepeating, stop it (as if it timed out).	1232	If the timer is started but non-repeating, stop it (as if it timed out).
1201		1233
1202	If the timer is repeating, either start it if necessary (with the	1234	If the timer is repeating, either start it if necessary (with the
1203	C<repeat> value), or reset the running timer to the C<repeat> value.	1235	C<repeat> value), or reset the running timer to the C<repeat> value.
1204		1236
1205	This sounds a bit complicated, but here is a useful and typical	1237	This sounds a bit complicated, but here is a useful and typical
1206	example: Imagine you have a tcp connection and you want a so-called idle	1238	example: Imagine you have a TCP connection and you want a so-called idle
1207	timeout, that is, you want to be called when there have been, say, 60	1239	timeout, that is, you want to be called when there have been, say, 60
1208	seconds of inactivity on the socket. The easiest way to do this is to	1240	seconds of inactivity on the socket. The easiest way to do this is to
1209	configure an C<ev_timer> with a C<repeat> value of C<60> and then call	1241	configure an C<ev_timer> with a C<repeat> value of C<60> and then call
1210	C<ev_timer_again> each time you successfully read or write some data. If	1242	C<ev_timer_again> each time you successfully read or write some data. If
1211	you go into an idle state where you do not expect data to travel on the	1243	you go into an idle state where you do not expect data to travel on the
…		…
1237		1269
1238	=head3 Examples	1270	=head3 Examples
1239		1271
1240	Example: Create a timer that fires after 60 seconds.	1272	Example: Create a timer that fires after 60 seconds.
1241		1273
1242	static void	1274	static void
1243	one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents)	1275	one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents)
1244	{	1276	{
1245	.. one minute over, w is actually stopped right here	1277	.. one minute over, w is actually stopped right here
1246	}	1278	}
1247		1279
1248	struct ev_timer mytimer;	1280	struct ev_timer mytimer;
1249	ev_timer_init (&mytimer, one_minute_cb, 60., 0.);	1281	ev_timer_init (&mytimer, one_minute_cb, 60., 0.);
1250	ev_timer_start (loop, &mytimer);	1282	ev_timer_start (loop, &mytimer);
1251		1283
1252	Example: Create a timeout timer that times out after 10 seconds of	1284	Example: Create a timeout timer that times out after 10 seconds of
1253	inactivity.	1285	inactivity.
1254		1286
1255	static void	1287	static void
1256	timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents)	1288	timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents)
1257	{	1289	{
1258	.. ten seconds without any activity	1290	.. ten seconds without any activity
1259	}	1291	}
1260		1292
1261	struct ev_timer mytimer;	1293	struct ev_timer mytimer;
1262	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */	1294	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */
1263	ev_timer_again (&mytimer); /* start timer */	1295	ev_timer_again (&mytimer); /* start timer */
1264	ev_loop (loop, 0);	1296	ev_loop (loop, 0);
1265		1297
1266	// and in some piece of code that gets executed on any "activity":	1298	// and in some piece of code that gets executed on any "activity":
1267	// reset the timeout to start ticking again at 10 seconds	1299	// reset the timeout to start ticking again at 10 seconds
1268	ev_timer_again (&mytimer);	1300	ev_timer_again (&mytimer);
1269		1301
1270		1302
1271	=head2 C<ev_periodic> - to cron or not to cron?	1303	=head2 C<ev_periodic> - to cron or not to cron?
1272		1304
1273	Periodic watchers are also timers of a kind, but they are very versatile	1305	Periodic watchers are also timers of a kind, but they are very versatile
1274	(and unfortunately a bit complex).	1306	(and unfortunately a bit complex).
1275		1307
1276	Unlike C<ev_timer>'s, they are not based on real time (or relative time)	1308	Unlike C<ev_timer>'s, they are not based on real time (or relative time)
1277	but on wallclock time (absolute time). You can tell a periodic watcher	1309	but on wall clock time (absolute time). You can tell a periodic watcher
1278	to trigger after some specific point in time. For example, if you tell a	1310	to trigger after some specific point in time. For example, if you tell a
1279	periodic watcher to trigger in 10 seconds (by specifiying e.g. C<ev_now ()	1311	periodic watcher to trigger in 10 seconds (by specifying e.g. C<ev_now ()
1280	+ 10.>, that is, an absolute time not a delay) and then reset your system	1312	+ 10.>, that is, an absolute time not a delay) and then reset your system
1281	clock to january of the previous year, then it will take more than year	1313	clock to January of the previous year, then it will take more than year
1282	to trigger the event (unlike an C<ev_timer>, which would still trigger	1314	to trigger the event (unlike an C<ev_timer>, which would still trigger
1283	roughly 10 seconds later as it uses a relative timeout).	1315	roughly 10 seconds later as it uses a relative timeout).
1284		1316
1285	C<ev_periodic>s can also be used to implement vastly more complex timers,	1317	C<ev_periodic>s can also be used to implement vastly more complex timers,
1286	such as triggering an event on each "midnight, local time", or other	1318	such as triggering an event on each "midnight, local time", or other
1287	complicated, rules.	1319	complicated, rules.
1288		1320
1289	As with timers, the callback is guarenteed to be invoked only when the	1321	As with timers, the callback is guaranteed to be invoked only when the
1290	time (C<at>) has passed, but if multiple periodic timers become ready	1322	time (C<at>) has passed, but if multiple periodic timers become ready
1291	during the same loop iteration then order of execution is undefined.	1323	during the same loop iteration then order of execution is undefined.
1292		1324
1293	=head3 Watcher-Specific Functions and Data Members	1325	=head3 Watcher-Specific Functions and Data Members
1294		1326
…		…
1303		1335
1304	=over 4	1336	=over 4
1305		1337
1306	=item * absolute timer (at = time, interval = reschedule_cb = 0)	1338	=item * absolute timer (at = time, interval = reschedule_cb = 0)
1307		1339
1308	In this configuration the watcher triggers an event after the wallclock	1340	In this configuration the watcher triggers an event after the wall clock
1309	time C<at> has passed and doesn't repeat. It will not adjust when a time	1341	time C<at> has passed and doesn't repeat. It will not adjust when a time
1310	jump occurs, that is, if it is to be run at January 1st 2011 then it will	1342	jump occurs, that is, if it is to be run at January 1st 2011 then it will
1311	run when the system time reaches or surpasses this time.	1343	run when the system time reaches or surpasses this time.
1312		1344
1313	=item * repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)	1345	=item * repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)
…		…
1321	the hour:	1353	the hour:
1322		1354
1323	ev_periodic_set (&periodic, 0., 3600., 0);	1355	ev_periodic_set (&periodic, 0., 3600., 0);
1324		1356
1325	This doesn't mean there will always be 3600 seconds in between triggers,	1357	This doesn't mean there will always be 3600 seconds in between triggers,
1326	but only that the the callback will be called when the system time shows a	1358	but only that the callback will be called when the system time shows a
1327	full hour (UTC), or more correctly, when the system time is evenly divisible	1359	full hour (UTC), or more correctly, when the system time is evenly divisible
1328	by 3600.	1360	by 3600.
1329		1361
1330	Another way to think about it (for the mathematically inclined) is that	1362	Another way to think about it (for the mathematically inclined) is that
1331	C<ev_periodic> will try to run the callback in this mode at the next possible	1363	C<ev_periodic> will try to run the callback in this mode at the next possible
1332	time where C<time = at (mod interval)>, regardless of any time jumps.	1364	time where C<time = at (mod interval)>, regardless of any time jumps.
1333		1365
1334	For numerical stability it is preferable that the C<at> value is near	1366	For numerical stability it is preferable that the C<at> value is near
1335	C<ev_now ()> (the current time), but there is no range requirement for	1367	C<ev_now ()> (the current time), but there is no range requirement for
1336	this value, and in fact is often specified as zero.	1368	this value, and in fact is often specified as zero.
		1369
		1370	Note also that there is an upper limit to how often a timer can fire (CPU
		1371	speed for example), so if C<interval> is very small then timing stability
		1372	will of course deteriorate. Libev itself tries to be exact to be about one
		1373	millisecond (if the OS supports it and the machine is fast enough).
1337		1374
1338	=item * manual reschedule mode (at and interval ignored, reschedule_cb = callback)	1375	=item * manual reschedule mode (at and interval ignored, reschedule_cb = callback)
1339		1376
1340	In this mode the values for C<interval> and C<at> are both being	1377	In this mode the values for C<interval> and C<at> are both being
1341	ignored. Instead, each time the periodic watcher gets scheduled, the	1378	ignored. Instead, each time the periodic watcher gets scheduled, the
…		…
1409		1446
1410	=head3 Examples	1447	=head3 Examples
1411		1448
1412	Example: Call a callback every hour, or, more precisely, whenever the	1449	Example: Call a callback every hour, or, more precisely, whenever the
1413	system clock is divisible by 3600. The callback invocation times have	1450	system clock is divisible by 3600. The callback invocation times have
1414	potentially a lot of jittering, but good long-term stability.	1451	potentially a lot of jitter, but good long-term stability.
1415		1452
1416	static void	1453	static void
1417	clock_cb (struct ev_loop *loop, struct ev_io *w, int revents)	1454	clock_cb (struct ev_loop *loop, struct ev_io *w, int revents)
1418	{	1455	{
1419	... its now a full hour (UTC, or TAI or whatever your clock follows)	1456	... its now a full hour (UTC, or TAI or whatever your clock follows)
1420	}	1457	}
1421		1458
1422	struct ev_periodic hourly_tick;	1459	struct ev_periodic hourly_tick;
1423	ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);	1460	ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);
1424	ev_periodic_start (loop, &hourly_tick);	1461	ev_periodic_start (loop, &hourly_tick);
1425		1462
1426	Example: The same as above, but use a reschedule callback to do it:	1463	Example: The same as above, but use a reschedule callback to do it:
1427		1464
1428	#include <math.h>	1465	#include <math.h>
1429		1466
1430	static ev_tstamp	1467	static ev_tstamp
1431	my_scheduler_cb (struct ev_periodic *w, ev_tstamp now)	1468	my_scheduler_cb (struct ev_periodic *w, ev_tstamp now)
1432	{	1469	{
1433	return fmod (now, 3600.) + 3600.;	1470	return fmod (now, 3600.) + 3600.;
1434	}	1471	}
1435		1472
1436	ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);	1473	ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);
1437		1474
1438	Example: Call a callback every hour, starting now:	1475	Example: Call a callback every hour, starting now:
1439		1476
1440	struct ev_periodic hourly_tick;	1477	struct ev_periodic hourly_tick;
1441	ev_periodic_init (&hourly_tick, clock_cb,	1478	ev_periodic_init (&hourly_tick, clock_cb,
1442	fmod (ev_now (loop), 3600.), 3600., 0);	1479	fmod (ev_now (loop), 3600.), 3600., 0);
1443	ev_periodic_start (loop, &hourly_tick);	1480	ev_periodic_start (loop, &hourly_tick);
1444		1481
1445		1482
1446	=head2 C<ev_signal> - signal me when a signal gets signalled!	1483	=head2 C<ev_signal> - signal me when a signal gets signalled!
1447		1484
1448	Signal watchers will trigger an event when the process receives a specific	1485	Signal watchers will trigger an event when the process receives a specific
…		…
1456	as you don't register any with libev). Similarly, when the last signal	1493	as you don't register any with libev). Similarly, when the last signal
1457	watcher for a signal is stopped libev will reset the signal handler to	1494	watcher for a signal is stopped libev will reset the signal handler to
1458	SIG_DFL (regardless of what it was set to before).	1495	SIG_DFL (regardless of what it was set to before).
1459		1496
1460	If possible and supported, libev will install its handlers with	1497	If possible and supported, libev will install its handlers with
1461	C<SA_RESTART> behaviour enabled, so syscalls should not be unduly	1498	C<SA_RESTART> behaviour enabled, so system calls should not be unduly
1462	interrupted. If you have a problem with syscalls getting interrupted by	1499	interrupted. If you have a problem with system calls getting interrupted by
1463	signals you can block all signals in an C<ev_check> watcher and unblock	1500	signals you can block all signals in an C<ev_check> watcher and unblock
1464	them in an C<ev_prepare> watcher.	1501	them in an C<ev_prepare> watcher.
1465		1502
1466	=head3 Watcher-Specific Functions and Data Members	1503	=head3 Watcher-Specific Functions and Data Members
1467		1504
…		…
1482		1519
1483	=head3 Examples	1520	=head3 Examples
1484		1521
1485	Example: Try to exit cleanly on SIGINT and SIGTERM.	1522	Example: Try to exit cleanly on SIGINT and SIGTERM.
1486		1523
1487	static void	1524	static void
1488	sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)	1525	sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)
1489	{	1526	{
1490	ev_unloop (loop, EVUNLOOP_ALL);	1527	ev_unloop (loop, EVUNLOOP_ALL);
1491	}	1528	}
1492		1529
1493	struct ev_signal signal_watcher;	1530	struct ev_signal signal_watcher;
1494	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);	1531	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
1495	ev_signal_start (loop, &sigint_cb);	1532	ev_signal_start (loop, &sigint_cb);
1496		1533
1497		1534
1498	=head2 C<ev_child> - watch out for process status changes	1535	=head2 C<ev_child> - watch out for process status changes
1499		1536
1500	Child watchers trigger when your process receives a SIGCHLD in response to	1537	Child watchers trigger when your process receives a SIGCHLD in response to
…		…
1502	is permissible to install a child watcher I<after> the child has been	1539	is permissible to install a child watcher I<after> the child has been
1503	forked (which implies it might have already exited), as long as the event	1540	forked (which implies it might have already exited), as long as the event
1504	loop isn't entered (or is continued from a watcher).	1541	loop isn't entered (or is continued from a watcher).
1505		1542
1506	Only the default event loop is capable of handling signals, and therefore	1543	Only the default event loop is capable of handling signals, and therefore
1507	you can only rgeister child watchers in the default event loop.	1544	you can only register child watchers in the default event loop.
1508		1545
1509	=head3 Process Interaction	1546	=head3 Process Interaction
1510		1547
1511	Libev grabs C<SIGCHLD> as soon as the default event loop is	1548	Libev grabs C<SIGCHLD> as soon as the default event loop is
1512	initialised. This is necessary to guarantee proper behaviour even if	1549	initialised. This is necessary to guarantee proper behaviour even if
1513	the first child watcher is started after the child exits. The occurance	1550	the first child watcher is started after the child exits. The occurrence
1514	of C<SIGCHLD> is recorded asynchronously, but child reaping is done	1551	of C<SIGCHLD> is recorded asynchronously, but child reaping is done
1515	synchronously as part of the event loop processing. Libev always reaps all	1552	synchronously as part of the event loop processing. Libev always reaps all
1516	children, even ones not watched.	1553	children, even ones not watched.
1517		1554
1518	=head3 Overriding the Built-In Processing	1555	=head3 Overriding the Built-In Processing
…		…
1560	=head3 Examples	1597	=head3 Examples
1561		1598
1562	Example: C<fork()> a new process and install a child handler to wait for	1599	Example: C<fork()> a new process and install a child handler to wait for
1563	its completion.	1600	its completion.
1564		1601
1565	ev_child cw;	1602	ev_child cw;
1566		1603
1567	static void	1604	static void
1568	child_cb (EV_P_ struct ev_child *w, int revents)	1605	child_cb (EV_P_ struct ev_child *w, int revents)
1569	{	1606	{
1570	ev_child_stop (EV_A_ w);	1607	ev_child_stop (EV_A_ w);
1571	printf ("process %d exited with status %x\n", w->rpid, w->rstatus);	1608	printf ("process %d exited with status %x\n", w->rpid, w->rstatus);
1572	}	1609	}
1573		1610
1574	pid_t pid = fork ();	1611	pid_t pid = fork ();
1575		1612
1576	if (pid < 0)	1613	if (pid < 0)
1577	// error	1614	// error
1578	else if (pid == 0)	1615	else if (pid == 0)
1579	{	1616	{
1580	// the forked child executes here	1617	// the forked child executes here
1581	exit (1);	1618	exit (1);
1582	}	1619	}
1583	else	1620	else
1584	{	1621	{
1585	ev_child_init (&cw, child_cb, pid, 0);	1622	ev_child_init (&cw, child_cb, pid, 0);
1586	ev_child_start (EV_DEFAULT_ &cw);	1623	ev_child_start (EV_DEFAULT_ &cw);
1587	}	1624	}
1588		1625
1589		1626
1590	=head2 C<ev_stat> - did the file attributes just change?	1627	=head2 C<ev_stat> - did the file attributes just change?
1591		1628
1592	This watches a filesystem path for attribute changes. That is, it calls	1629	This watches a file system path for attribute changes. That is, it calls
1593	C<stat> regularly (or when the OS says it changed) and sees if it changed	1630	C<stat> regularly (or when the OS says it changed) and sees if it changed
1594	compared to the last time, invoking the callback if it did.	1631	compared to the last time, invoking the callback if it did.
1595		1632
1596	The path does not need to exist: changing from "path exists" to "path does	1633	The path does not need to exist: changing from "path exists" to "path does
1597	not exist" is a status change like any other. The condition "path does	1634	not exist" is a status change like any other. The condition "path does
…		…
1631	disabled large file support, you get the 32 bit version of the stat	1668	disabled large file support, you get the 32 bit version of the stat
1632	structure. When using the library from programs that change the ABI to	1669	structure. When using the library from programs that change the ABI to
1633	use 64 bit file offsets the programs will fail. In that case you have to	1670	use 64 bit file offsets the programs will fail. In that case you have to
1634	compile libev with the same flags to get binary compatibility. This is	1671	compile libev with the same flags to get binary compatibility. This is
1635	obviously the case with any flags that change the ABI, but the problem is	1672	obviously the case with any flags that change the ABI, but the problem is
1636	most noticably with ev_stat and largefile support.	1673	most noticeably with ev_stat and large file support.
1637		1674
1638	=head3 Inotify	1675	=head3 Inotify
1639		1676
1640	When C<inotify (7)> support has been compiled into libev (generally only	1677	When C<inotify (7)> support has been compiled into libev (generally only
1641	available on Linux) and present at runtime, it will be used to speed up	1678	available on Linux) and present at runtime, it will be used to speed up
…		…
1651	implement this functionality, due to the requirement of having a file	1688	implement this functionality, due to the requirement of having a file
1652	descriptor open on the object at all times).	1689	descriptor open on the object at all times).
1653		1690
1654	=head3 The special problem of stat time resolution	1691	=head3 The special problem of stat time resolution
1655		1692
1656	The C<stat ()> syscall only supports full-second resolution portably, and	1693	The C<stat ()> system call only supports full-second resolution portably, and
1657	even on systems where the resolution is higher, many filesystems still	1694	even on systems where the resolution is higher, many file systems still
1658	only support whole seconds.	1695	only support whole seconds.
1659		1696
1660	That means that, if the time is the only thing that changes, you can	1697	That means that, if the time is the only thing that changes, you can
1661	easily miss updates: on the first update, C<ev_stat> detects a change and	1698	easily miss updates: on the first update, C<ev_stat> detects a change and
1662	calls your callback, which does something. When there is another update	1699	calls your callback, which does something. When there is another update
…		…
1722		1759
1723	The specified interval.	1760	The specified interval.
1724		1761
1725	=item const char *path [read-only]	1762	=item const char *path [read-only]
1726		1763
1727	The filesystem path that is being watched.	1764	The file system path that is being watched.
1728		1765
1729	=back	1766	=back
1730		1767
1731	=head3 Examples	1768	=head3 Examples
1732		1769
1733	Example: Watch C</etc/passwd> for attribute changes.	1770	Example: Watch C</etc/passwd> for attribute changes.
1734		1771
1735	static void	1772	static void
1736	passwd_cb (struct ev_loop *loop, ev_stat *w, int revents)	1773	passwd_cb (struct ev_loop *loop, ev_stat *w, int revents)
1737	{	1774	{
1738	/* /etc/passwd changed in some way */	1775	/* /etc/passwd changed in some way */
1739	if (w->attr.st_nlink)	1776	if (w->attr.st_nlink)
1740	{	1777	{
1741	printf ("passwd current size %ld\n", (long)w->attr.st_size);	1778	printf ("passwd current size %ld\n", (long)w->attr.st_size);
1742	printf ("passwd current atime %ld\n", (long)w->attr.st_mtime);	1779	printf ("passwd current atime %ld\n", (long)w->attr.st_mtime);
1743	printf ("passwd current mtime %ld\n", (long)w->attr.st_mtime);	1780	printf ("passwd current mtime %ld\n", (long)w->attr.st_mtime);
1744	}	1781	}
1745	else	1782	else
1746	/* you shalt not abuse printf for puts */	1783	/* you shalt not abuse printf for puts */
1747	puts ("wow, /etc/passwd is not there, expect problems. "	1784	puts ("wow, /etc/passwd is not there, expect problems. "
1748	"if this is windows, they already arrived\n");	1785	"if this is windows, they already arrived\n");
1749	}	1786	}
1750		1787
1751	...	1788	...
1752	ev_stat passwd;	1789	ev_stat passwd;
1753		1790
1754	ev_stat_init (&passwd, passwd_cb, "/etc/passwd", 0.);	1791	ev_stat_init (&passwd, passwd_cb, "/etc/passwd", 0.);
1755	ev_stat_start (loop, &passwd);	1792	ev_stat_start (loop, &passwd);
1756		1793
1757	Example: Like above, but additionally use a one-second delay so we do not	1794	Example: Like above, but additionally use a one-second delay so we do not
1758	miss updates (however, frequent updates will delay processing, too, so	1795	miss updates (however, frequent updates will delay processing, too, so
1759	one might do the work both on C<ev_stat> callback invocation I<and> on	1796	one might do the work both on C<ev_stat> callback invocation I<and> on
1760	C<ev_timer> callback invocation).	1797	C<ev_timer> callback invocation).
1761		1798
1762	static ev_stat passwd;	1799	static ev_stat passwd;
1763	static ev_timer timer;	1800	static ev_timer timer;
1764		1801
1765	static void	1802	static void
1766	timer_cb (EV_P_ ev_timer *w, int revents)	1803	timer_cb (EV_P_ ev_timer *w, int revents)
1767	{	1804	{
1768	ev_timer_stop (EV_A_ w);	1805	ev_timer_stop (EV_A_ w);
1769		1806
1770	/* now it's one second after the most recent passwd change */	1807	/* now it's one second after the most recent passwd change */
1771	}	1808	}
1772		1809
1773	static void	1810	static void
1774	stat_cb (EV_P_ ev_stat *w, int revents)	1811	stat_cb (EV_P_ ev_stat *w, int revents)
1775	{	1812	{
1776	/* reset the one-second timer */	1813	/* reset the one-second timer */
1777	ev_timer_again (EV_A_ &timer);	1814	ev_timer_again (EV_A_ &timer);
1778	}	1815	}
1779		1816
1780	...	1817	...
1781	ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.);	1818	ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.);
1782	ev_stat_start (loop, &passwd);	1819	ev_stat_start (loop, &passwd);
1783	ev_timer_init (&timer, timer_cb, 0., 1.02);	1820	ev_timer_init (&timer, timer_cb, 0., 1.02);
1784		1821
1785		1822
1786	=head2 C<ev_idle> - when you've got nothing better to do...	1823	=head2 C<ev_idle> - when you've got nothing better to do...
1787		1824
1788	Idle watchers trigger events when no other events of the same or higher	1825	Idle watchers trigger events when no other events of the same or higher
…		…
1819	=head3 Examples	1856	=head3 Examples
1820		1857
1821	Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the	1858	Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the
1822	callback, free it. Also, use no error checking, as usual.	1859	callback, free it. Also, use no error checking, as usual.
1823		1860
1824	static void	1861	static void
1825	idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents)	1862	idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents)
1826	{	1863	{
1827	free (w);	1864	free (w);
1828	// now do something you wanted to do when the program has	1865	// now do something you wanted to do when the program has
1829	// no longer anything immediate to do.	1866	// no longer anything immediate to do.
1830	}	1867	}
1831		1868
1832	struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle));	1869	struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle));
1833	ev_idle_init (idle_watcher, idle_cb);	1870	ev_idle_init (idle_watcher, idle_cb);
1834	ev_idle_start (loop, idle_cb);	1871	ev_idle_start (loop, idle_cb);
1835		1872
1836		1873
1837	=head2 C<ev_prepare> and C<ev_check> - customise your event loop!	1874	=head2 C<ev_prepare> and C<ev_check> - customise your event loop!
1838		1875
1839	Prepare and check watchers are usually (but not always) used in tandem:	1876	Prepare and check watchers are usually (but not always) used in tandem:
…		…
1858		1895
1859	This is done by examining in each prepare call which file descriptors need	1896	This is done by examining in each prepare call which file descriptors need
1860	to be watched by the other library, registering C<ev_io> watchers for	1897	to be watched by the other library, registering C<ev_io> watchers for
1861	them and starting an C<ev_timer> watcher for any timeouts (many libraries	1898	them and starting an C<ev_timer> watcher for any timeouts (many libraries
1862	provide just this functionality). Then, in the check watcher you check for	1899	provide just this functionality). Then, in the check watcher you check for
1863	any events that occured (by checking the pending status of all watchers	1900	any events that occurred (by checking the pending status of all watchers
1864	and stopping them) and call back into the library. The I/O and timer	1901	and stopping them) and call back into the library. The I/O and timer
1865	callbacks will never actually be called (but must be valid nevertheless,	1902	callbacks will never actually be called (but must be valid nevertheless,
1866	because you never know, you know?).	1903	because you never know, you know?).
1867		1904
1868	As another example, the Perl Coro module uses these hooks to integrate	1905	As another example, the Perl Coro module uses these hooks to integrate
…		…
1911	and in a check watcher, destroy them and call into libadns. What follows	1948	and in a check watcher, destroy them and call into libadns. What follows
1912	is pseudo-code only of course. This requires you to either use a low	1949	is pseudo-code only of course. This requires you to either use a low
1913	priority for the check watcher or use C<ev_clear_pending> explicitly, as	1950	priority for the check watcher or use C<ev_clear_pending> explicitly, as
1914	the callbacks for the IO/timeout watchers might not have been called yet.	1951	the callbacks for the IO/timeout watchers might not have been called yet.
1915		1952
1916	static ev_io iow [nfd];	1953	static ev_io iow [nfd];
1917	static ev_timer tw;	1954	static ev_timer tw;
1918		1955
1919	static void	1956	static void
1920	io_cb (ev_loop *loop, ev_io *w, int revents)	1957	io_cb (ev_loop *loop, ev_io *w, int revents)
1921	{	1958	{
1922	}	1959	}
1923		1960
1924	// create io watchers for each fd and a timer before blocking	1961	// create io watchers for each fd and a timer before blocking
1925	static void	1962	static void
1926	adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents)	1963	adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents)
1927	{	1964	{
1928	int timeout = 3600000;	1965	int timeout = 3600000;
1929	struct pollfd fds [nfd];	1966	struct pollfd fds [nfd];
1930	// actual code will need to loop here and realloc etc.	1967	// actual code will need to loop here and realloc etc.
1931	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));	1968	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
1932		1969
1933	/* the callback is illegal, but won't be called as we stop during check */	1970	/* the callback is illegal, but won't be called as we stop during check */
1934	ev_timer_init (&tw, 0, timeout * 1e-3);	1971	ev_timer_init (&tw, 0, timeout * 1e-3);
1935	ev_timer_start (loop, &tw);	1972	ev_timer_start (loop, &tw);
1936		1973
1937	// create one ev_io per pollfd	1974	// create one ev_io per pollfd
1938	for (int i = 0; i < nfd; ++i)	1975	for (int i = 0; i < nfd; ++i)
1939	{	1976	{
1940	ev_io_init (iow + i, io_cb, fds [i].fd,	1977	ev_io_init (iow + i, io_cb, fds [i].fd,
1941	((fds [i].events & POLLIN ? EV_READ : 0)	1978	((fds [i].events & POLLIN ? EV_READ : 0)
1942	| (fds [i].events & POLLOUT ? EV_WRITE : 0)));	1979	| (fds [i].events & POLLOUT ? EV_WRITE : 0)));
1943		1980
1944	fds [i].revents = 0;	1981	fds [i].revents = 0;
1945	ev_io_start (loop, iow + i);	1982	ev_io_start (loop, iow + i);
1946	}	1983	}
1947	}	1984	}
1948		1985
1949	// stop all watchers after blocking	1986	// stop all watchers after blocking
1950	static void	1987	static void
1951	adns_check_cb (ev_loop *loop, ev_check *w, int revents)	1988	adns_check_cb (ev_loop *loop, ev_check *w, int revents)
1952	{	1989	{
1953	ev_timer_stop (loop, &tw);	1990	ev_timer_stop (loop, &tw);
1954		1991
1955	for (int i = 0; i < nfd; ++i)	1992	for (int i = 0; i < nfd; ++i)
1956	{	1993	{
1957	// set the relevant poll flags	1994	// set the relevant poll flags
1958	// could also call adns_processreadable etc. here	1995	// could also call adns_processreadable etc. here
1959	struct pollfd *fd = fds + i;	1996	struct pollfd *fd = fds + i;
1960	int revents = ev_clear_pending (iow + i);	1997	int revents = ev_clear_pending (iow + i);
1961	if (revents & EV_READ ) fd->revents |= fd->events & POLLIN;	1998	if (revents & EV_READ ) fd->revents |= fd->events & POLLIN;
1962	if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT;	1999	if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT;
1963		2000
1964	// now stop the watcher	2001	// now stop the watcher
1965	ev_io_stop (loop, iow + i);	2002	ev_io_stop (loop, iow + i);
1966	}	2003	}
1967		2004
1968	adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));	2005	adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));
1969	}	2006	}
1970		2007
1971	Method 2: This would be just like method 1, but you run C<adns_afterpoll>	2008	Method 2: This would be just like method 1, but you run C<adns_afterpoll>
1972	in the prepare watcher and would dispose of the check watcher.	2009	in the prepare watcher and would dispose of the check watcher.
1973		2010
1974	Method 3: If the module to be embedded supports explicit event	2011	Method 3: If the module to be embedded supports explicit event
1975	notification (adns does), you can also make use of the actual watcher	2012	notification (libadns does), you can also make use of the actual watcher
1976	callbacks, and only destroy/create the watchers in the prepare watcher.	2013	callbacks, and only destroy/create the watchers in the prepare watcher.
1977		2014
1978	static void	2015	static void
1979	timer_cb (EV_P_ ev_timer *w, int revents)	2016	timer_cb (EV_P_ ev_timer *w, int revents)
1980	{	2017	{
1981	adns_state ads = (adns_state)w->data;	2018	adns_state ads = (adns_state)w->data;
1982	update_now (EV_A);	2019	update_now (EV_A);
1983		2020
1984	adns_processtimeouts (ads, &tv_now);	2021	adns_processtimeouts (ads, &tv_now);
1985	}	2022	}
1986		2023
1987	static void	2024	static void
1988	io_cb (EV_P_ ev_io *w, int revents)	2025	io_cb (EV_P_ ev_io *w, int revents)
1989	{	2026	{
1990	adns_state ads = (adns_state)w->data;	2027	adns_state ads = (adns_state)w->data;
1991	update_now (EV_A);	2028	update_now (EV_A);
1992		2029
1993	if (revents & EV_READ ) adns_processreadable (ads, w->fd, &tv_now);	2030	if (revents & EV_READ ) adns_processreadable (ads, w->fd, &tv_now);
1994	if (revents & EV_WRITE) adns_processwriteable (ads, w->fd, &tv_now);	2031	if (revents & EV_WRITE) adns_processwriteable (ads, w->fd, &tv_now);
1995	}	2032	}
1996		2033
1997	// do not ever call adns_afterpoll	2034	// do not ever call adns_afterpoll
1998		2035
1999	Method 4: Do not use a prepare or check watcher because the module you	2036	Method 4: Do not use a prepare or check watcher because the module you
2000	want to embed is too inflexible to support it. Instead, youc na override	2037	want to embed is too inflexible to support it. Instead, you can override
2001	their poll function. The drawback with this solution is that the main	2038	their poll function. The drawback with this solution is that the main
2002	loop is now no longer controllable by EV. The C<Glib::EV> module does	2039	loop is now no longer controllable by EV. The C<Glib::EV> module does
2003	this.	2040	this.
2004		2041
2005	static gint	2042	static gint
2006	event_poll_func (GPollFD *fds, guint nfds, gint timeout)	2043	event_poll_func (GPollFD *fds, guint nfds, gint timeout)
2007	{	2044	{
2008	int got_events = 0;	2045	int got_events = 0;
2009		2046
2010	for (n = 0; n < nfds; ++n)	2047	for (n = 0; n < nfds; ++n)
2011	// create/start io watcher that sets the relevant bits in fds[n] and increment got_events	2048	// create/start io watcher that sets the relevant bits in fds[n] and increment got_events
2012		2049
2013	if (timeout >= 0)	2050	if (timeout >= 0)
2014	// create/start timer	2051	// create/start timer
2015		2052
2016	// poll	2053	// poll
2017	ev_loop (EV_A_ 0);	2054	ev_loop (EV_A_ 0);
2018		2055
2019	// stop timer again	2056	// stop timer again
2020	if (timeout >= 0)	2057	if (timeout >= 0)
2021	ev_timer_stop (EV_A_ &to);	2058	ev_timer_stop (EV_A_ &to);
2022		2059
2023	// stop io watchers again - their callbacks should have set	2060	// stop io watchers again - their callbacks should have set
2024	for (n = 0; n < nfds; ++n)	2061	for (n = 0; n < nfds; ++n)
2025	ev_io_stop (EV_A_ iow [n]);	2062	ev_io_stop (EV_A_ iow [n]);
2026		2063
2027	return got_events;	2064	return got_events;
2028	}	2065	}
2029		2066
2030		2067
2031	=head2 C<ev_embed> - when one backend isn't enough...	2068	=head2 C<ev_embed> - when one backend isn't enough...
2032		2069
2033	This is a rather advanced watcher type that lets you embed one event loop	2070	This is a rather advanced watcher type that lets you embed one event loop
…		…
2089		2126
2090	Configures the watcher to embed the given loop, which must be	2127	Configures the watcher to embed the given loop, which must be
2091	embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be	2128	embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be
2092	invoked automatically, otherwise it is the responsibility of the callback	2129	invoked automatically, otherwise it is the responsibility of the callback
2093	to invoke it (it will continue to be called until the sweep has been done,	2130	to invoke it (it will continue to be called until the sweep has been done,
2094	if you do not want thta, you need to temporarily stop the embed watcher).	2131	if you do not want that, you need to temporarily stop the embed watcher).
2095		2132
2096	=item ev_embed_sweep (loop, ev_embed *)	2133	=item ev_embed_sweep (loop, ev_embed *)
2097		2134
2098	Make a single, non-blocking sweep over the embedded loop. This works	2135	Make a single, non-blocking sweep over the embedded loop. This works
2099	similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most	2136	similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most
2100	apropriate way for embedded loops.	2137	appropriate way for embedded loops.
2101		2138
2102	=item struct ev_loop *other [read-only]	2139	=item struct ev_loop *other [read-only]
2103		2140
2104	The embedded event loop.	2141	The embedded event loop.
2105		2142
…		…
2107		2144
2108	=head3 Examples	2145	=head3 Examples
2109		2146
2110	Example: Try to get an embeddable event loop and embed it into the default	2147	Example: Try to get an embeddable event loop and embed it into the default
2111	event loop. If that is not possible, use the default loop. The default	2148	event loop. If that is not possible, use the default loop. The default
2112	loop is stored in C<loop_hi>, while the mebeddable loop is stored in	2149	loop is stored in C<loop_hi>, while the embeddable loop is stored in
2113	C<loop_lo> (which is C<loop_hi> in the acse no embeddable loop can be	2150	C<loop_lo> (which is C<loop_hi> in the case no embeddable loop can be
2114	used).	2151	used).
2115		2152
2116	struct ev_loop *loop_hi = ev_default_init (0);	2153	struct ev_loop *loop_hi = ev_default_init (0);
2117	struct ev_loop *loop_lo = 0;	2154	struct ev_loop *loop_lo = 0;
2118	struct ev_embed embed;	2155	struct ev_embed embed;
2119		2156
2120	// see if there is a chance of getting one that works	2157	// see if there is a chance of getting one that works
2121	// (remember that a flags value of 0 means autodetection)	2158	// (remember that a flags value of 0 means autodetection)
2122	loop_lo = ev_embeddable_backends () & ev_recommended_backends ()	2159	loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
2123	? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())	2160	? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
2124	: 0;	2161	: 0;
2125		2162
2126	// if we got one, then embed it, otherwise default to loop_hi	2163	// if we got one, then embed it, otherwise default to loop_hi
2127	if (loop_lo)	2164	if (loop_lo)
2128	{	2165	{
2129	ev_embed_init (&embed, 0, loop_lo);	2166	ev_embed_init (&embed, 0, loop_lo);
2130	ev_embed_start (loop_hi, &embed);	2167	ev_embed_start (loop_hi, &embed);
2131	}	2168	}
2132	else	2169	else
2133	loop_lo = loop_hi;	2170	loop_lo = loop_hi;
2134		2171
2135	Example: Check if kqueue is available but not recommended and create	2172	Example: Check if kqueue is available but not recommended and create
2136	a kqueue backend for use with sockets (which usually work with any	2173	a kqueue backend for use with sockets (which usually work with any
2137	kqueue implementation). Store the kqueue/socket-only event loop in	2174	kqueue implementation). Store the kqueue/socket-only event loop in
2138	C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).	2175	C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).
2139		2176
2140	struct ev_loop *loop = ev_default_init (0);	2177	struct ev_loop *loop = ev_default_init (0);
2141	struct ev_loop *loop_socket = 0;	2178	struct ev_loop *loop_socket = 0;
2142	struct ev_embed embed;	2179	struct ev_embed embed;
2143		2180
2144	if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)	2181	if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
2145	if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))	2182	if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
2146	{	2183	{
2147	ev_embed_init (&embed, 0, loop_socket);	2184	ev_embed_init (&embed, 0, loop_socket);
2148	ev_embed_start (loop, &embed);	2185	ev_embed_start (loop, &embed);
2149	}	2186	}
2150		2187
2151	if (!loop_socket)	2188	if (!loop_socket)
2152	loop_socket = loop;	2189	loop_socket = loop;
2153		2190
2154	// now use loop_socket for all sockets, and loop for everything else	2191	// now use loop_socket for all sockets, and loop for everything else
2155		2192
2156		2193
2157	=head2 C<ev_fork> - the audacity to resume the event loop after a fork	2194	=head2 C<ev_fork> - the audacity to resume the event loop after a fork
2158		2195
2159	Fork watchers are called when a C<fork ()> was detected (usually because	2196	Fork watchers are called when a C<fork ()> was detected (usually because
…		…
2212		2249
2213	=item queueing from a signal handler context	2250	=item queueing from a signal handler context
2214		2251
2215	To implement race-free queueing, you simply add to the queue in the signal	2252	To implement race-free queueing, you simply add to the queue in the signal
2216	handler but you block the signal handler in the watcher callback. Here is an example that does that for	2253	handler but you block the signal handler in the watcher callback. Here is an example that does that for
2217	some fictitiuous SIGUSR1 handler:	2254	some fictitious SIGUSR1 handler:
2218		2255
2219	static ev_async mysig;	2256	static ev_async mysig;
2220		2257
2221	static void	2258	static void
2222	sigusr1_handler (void)	2259	sigusr1_handler (void)
…		…
2296	=item ev_async_send (loop, ev_async *)	2333	=item ev_async_send (loop, ev_async *)
2297		2334
2298	Sends/signals/activates the given C<ev_async> watcher, that is, feeds	2335	Sends/signals/activates the given C<ev_async> watcher, that is, feeds
2299	an C<EV_ASYNC> event on the watcher into the event loop. Unlike	2336	an C<EV_ASYNC> event on the watcher into the event loop. Unlike
2300	C<ev_feed_event>, this call is safe to do in other threads, signal or	2337	C<ev_feed_event>, this call is safe to do in other threads, signal or
2301	similar contexts (see the dicusssion of C<EV_ATOMIC_T> in the embedding	2338	similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding
2302	section below on what exactly this means).	2339	section below on what exactly this means).
2303		2340
2304	This call incurs the overhead of a syscall only once per loop iteration,	2341	This call incurs the overhead of a system call only once per loop iteration,
2305	so while the overhead might be noticable, it doesn't apply to repeated	2342	so while the overhead might be noticeable, it doesn't apply to repeated
2306	calls to C<ev_async_send>.	2343	calls to C<ev_async_send>.
2307		2344
2308	=item bool = ev_async_pending (ev_async *)	2345	=item bool = ev_async_pending (ev_async *)
2309		2346
2310	Returns a non-zero value when C<ev_async_send> has been called on the	2347	Returns a non-zero value when C<ev_async_send> has been called on the
…		…
2312	event loop.	2349	event loop.
2313		2350
2314	C<ev_async_send> sets a flag in the watcher and wakes up the loop. When	2351	C<ev_async_send> sets a flag in the watcher and wakes up the loop. When
2315	the loop iterates next and checks for the watcher to have become active,	2352	the loop iterates next and checks for the watcher to have become active,
2316	it will reset the flag again. C<ev_async_pending> can be used to very	2353	it will reset the flag again. C<ev_async_pending> can be used to very
2317	quickly check wether invoking the loop might be a good idea.	2354	quickly check whether invoking the loop might be a good idea.
2318		2355
2319	Not that this does I<not> check wether the watcher itself is pending, only	2356	Not that this does I<not> check whether the watcher itself is pending, only
2320	wether it has been requested to make this watcher pending.	2357	whether it has been requested to make this watcher pending.
2321		2358
2322	=back	2359	=back
2323		2360
2324		2361
2325	=head1 OTHER FUNCTIONS	2362	=head1 OTHER FUNCTIONS
…		…
2336	or timeout without having to allocate/configure/start/stop/free one or	2373	or timeout without having to allocate/configure/start/stop/free one or
2337	more watchers yourself.	2374	more watchers yourself.
2338		2375
2339	If C<fd> is less than 0, then no I/O watcher will be started and events	2376	If C<fd> is less than 0, then no I/O watcher will be started and events
2340	is being ignored. Otherwise, an C<ev_io> watcher for the given C<fd> and	2377	is being ignored. Otherwise, an C<ev_io> watcher for the given C<fd> and
2341	C<events> set will be craeted and started.	2378	C<events> set will be created and started.
2342		2379
2343	If C<timeout> is less than 0, then no timeout watcher will be	2380	If C<timeout> is less than 0, then no timeout watcher will be
2344	started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and	2381	started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and
2345	repeat = 0) will be started. While C<0> is a valid timeout, it is of	2382	repeat = 0) will be started. While C<0> is a valid timeout, it is of
2346	dubious value.	2383	dubious value.
…		…
2348	The callback has the type C<void (*cb)(int revents, void *arg)> and gets	2385	The callback has the type C<void (*cb)(int revents, void *arg)> and gets
2349	passed an C<revents> set like normal event callbacks (a combination of	2386	passed an C<revents> set like normal event callbacks (a combination of
2350	C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg>	2387	C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg>
2351	value passed to C<ev_once>:	2388	value passed to C<ev_once>:
2352		2389
2353	static void stdin_ready (int revents, void *arg)	2390	static void stdin_ready (int revents, void *arg)
2354	{	2391	{
2355	if (revents & EV_TIMEOUT)	2392	if (revents & EV_TIMEOUT)
2356	/* doh, nothing entered */;	2393	/* doh, nothing entered */;
2357	else if (revents & EV_READ)	2394	else if (revents & EV_READ)
2358	/* stdin might have data for us, joy! */;	2395	/* stdin might have data for us, joy! */;
2359	}	2396	}
2360		2397
2361	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);	2398	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
2362		2399
2363	=item ev_feed_event (ev_loop *, watcher *, int revents)	2400	=item ev_feed_event (ev_loop *, watcher *, int revents)
2364		2401
2365	Feeds the given event set into the event loop, as if the specified event	2402	Feeds the given event set into the event loop, as if the specified event
2366	had happened for the specified watcher (which must be a pointer to an	2403	had happened for the specified watcher (which must be a pointer to an
…		…
2371	Feed an event on the given fd, as if a file descriptor backend detected	2408	Feed an event on the given fd, as if a file descriptor backend detected
2372	the given events it.	2409	the given events it.
2373		2410
2374	=item ev_feed_signal_event (ev_loop *loop, int signum)	2411	=item ev_feed_signal_event (ev_loop *loop, int signum)
2375		2412
2376	Feed an event as if the given signal occured (C<loop> must be the default	2413	Feed an event as if the given signal occurred (C<loop> must be the default
2377	loop!).	2414	loop!).
2378		2415
2379	=back	2416	=back
2380		2417
2381		2418
…		…
2410	=back	2447	=back
2411		2448
2412	=head1 C++ SUPPORT	2449	=head1 C++ SUPPORT
2413		2450
2414	Libev comes with some simplistic wrapper classes for C++ that mainly allow	2451	Libev comes with some simplistic wrapper classes for C++ that mainly allow
2415	you to use some convinience methods to start/stop watchers and also change	2452	you to use some convenience methods to start/stop watchers and also change
2416	the callback model to a model using method callbacks on objects.	2453	the callback model to a model using method callbacks on objects.
2417		2454
2418	To use it,	2455	To use it,
2419		2456
2420	#include <ev++.h>	2457	#include <ev++.h>
2421		2458
2422	This automatically includes F<ev.h> and puts all of its definitions (many	2459	This automatically includes F<ev.h> and puts all of its definitions (many
2423	of them macros) into the global namespace. All C++ specific things are	2460	of them macros) into the global namespace. All C++ specific things are
2424	put into the C<ev> namespace. It should support all the same embedding	2461	put into the C<ev> namespace. It should support all the same embedding
2425	options as F<ev.h>, most notably C<EV_MULTIPLICITY>.	2462	options as F<ev.h>, most notably C<EV_MULTIPLICITY>.
…		…
2492	your compiler is good :), then the method will be fully inlined into the	2529	your compiler is good :), then the method will be fully inlined into the
2493	thunking function, making it as fast as a direct C callback.	2530	thunking function, making it as fast as a direct C callback.
2494		2531
2495	Example: simple class declaration and watcher initialisation	2532	Example: simple class declaration and watcher initialisation
2496		2533
2497	struct myclass	2534	struct myclass
2498	{	2535	{
2499	void io_cb (ev::io &w, int revents) { }	2536	void io_cb (ev::io &w, int revents) { }
2500	}	2537	}
2501		2538
2502	myclass obj;	2539	myclass obj;
2503	ev::io iow;	2540	ev::io iow;
2504	iow.set <myclass, &myclass::io_cb> (&obj);	2541	iow.set <myclass, &myclass::io_cb> (&obj);
2505		2542
2506	=item w->set<function> (void *data = 0)	2543	=item w->set<function> (void *data = 0)
2507		2544
2508	Also sets a callback, but uses a static method or plain function as	2545	Also sets a callback, but uses a static method or plain function as
2509	callback. The optional C<data> argument will be stored in the watcher's	2546	callback. The optional C<data> argument will be stored in the watcher's
…		…
2513		2550
2514	See the method-C<set> above for more details.	2551	See the method-C<set> above for more details.
2515		2552
2516	Example:	2553	Example:
2517		2554
2518	static void io_cb (ev::io &w, int revents) { }	2555	static void io_cb (ev::io &w, int revents) { }
2519	iow.set <io_cb> ();	2556	iow.set <io_cb> ();
2520		2557
2521	=item w->set (struct ev_loop *)	2558	=item w->set (struct ev_loop *)
2522		2559
2523	Associates a different C<struct ev_loop> with this watcher. You can only	2560	Associates a different C<struct ev_loop> with this watcher. You can only
2524	do this when the watcher is inactive (and not pending either).	2561	do this when the watcher is inactive (and not pending either).
2525		2562
2526	=item w->set ([args])	2563	=item w->set ([arguments])
2527		2564
2528	Basically the same as C<ev_TYPE_set>, with the same args. Must be	2565	Basically the same as C<ev_TYPE_set>, with the same arguments. Must be
2529	called at least once. Unlike the C counterpart, an active watcher gets	2566	called at least once. Unlike the C counterpart, an active watcher gets
2530	automatically stopped and restarted when reconfiguring it with this	2567	automatically stopped and restarted when reconfiguring it with this
2531	method.	2568	method.
2532		2569
2533	=item w->start ()	2570	=item w->start ()
…		…
2557	=back	2594	=back
2558		2595
2559	Example: Define a class with an IO and idle watcher, start one of them in	2596	Example: Define a class with an IO and idle watcher, start one of them in
2560	the constructor.	2597	the constructor.
2561		2598
2562	class myclass	2599	class myclass
2563	{	2600	{
2564	ev::io io; void io_cb (ev::io &w, int revents);	2601	ev::io io; void io_cb (ev::io &w, int revents);
2565	ev:idle idle void idle_cb (ev::idle &w, int revents);	2602	ev:idle idle void idle_cb (ev::idle &w, int revents);
2566		2603
2567	myclass (int fd)	2604	myclass (int fd)
2568	{	2605	{
2569	io .set <myclass, &myclass::io_cb > (this);	2606	io .set <myclass, &myclass::io_cb > (this);
2570	idle.set <myclass, &myclass::idle_cb> (this);	2607	idle.set <myclass, &myclass::idle_cb> (this);
2571		2608
2572	io.start (fd, ev::READ);	2609	io.start (fd, ev::READ);
2573	}	2610	}
2574	};	2611	};
2575		2612
2576		2613
2577	=head1 OTHER LANGUAGE BINDINGS	2614	=head1 OTHER LANGUAGE BINDINGS
2578		2615
2579	Libev does not offer other language bindings itself, but bindings for a	2616	Libev does not offer other language bindings itself, but bindings for a
2580	numbe rof languages exist in the form of third-party packages. If you know	2617	number of languages exist in the form of third-party packages. If you know
2581	any interesting language binding in addition to the ones listed here, drop	2618	any interesting language binding in addition to the ones listed here, drop
2582	me a note.	2619	me a note.
2583		2620
2584	=over 4	2621	=over 4
2585		2622
…		…
2589	libev. EV is developed together with libev. Apart from the EV core module,	2626	libev. EV is developed together with libev. Apart from the EV core module,
2590	there are additional modules that implement libev-compatible interfaces	2627	there are additional modules that implement libev-compatible interfaces
2591	to C<libadns> (C<EV::ADNS>), C<Net::SNMP> (C<Net::SNMP::EV>) and the	2628	to C<libadns> (C<EV::ADNS>), C<Net::SNMP> (C<Net::SNMP::EV>) and the
2592	C<libglib> event core (C<Glib::EV> and C<EV::Glib>).	2629	C<libglib> event core (C<Glib::EV> and C<EV::Glib>).
2593		2630
2594	It can be found and installed via CPAN, its homepage is found at	2631	It can be found and installed via CPAN, its homepage is at
2595	L<http://software.schmorp.de/pkg/EV>.	2632	L<http://software.schmorp.de/pkg/EV>.
2596		2633
		2634	=item Python
		2635
		2636	Python bindings can be found at L<http://code.google.com/p/pyev/>. It
		2637	seems to be quite complete and well-documented. Note, however, that the
		2638	patch they require for libev is outright dangerous as it breaks the ABI
		2639	for everybody else, and therefore, should never be applied in an installed
		2640	libev (if python requires an incompatible ABI then it needs to embed
		2641	libev).
		2642
2597	=item Ruby	2643	=item Ruby
2598		2644
2599	Tony Arcieri has written a ruby extension that offers access to a subset	2645	Tony Arcieri has written a ruby extension that offers access to a subset
2600	of the libev API and adds filehandle abstractions, asynchronous DNS and	2646	of the libev API and adds file handle abstractions, asynchronous DNS and
2601	more on top of it. It can be found via gem servers. Its homepage is at	2647	more on top of it. It can be found via gem servers. Its homepage is at
2602	L<http://rev.rubyforge.org/>.	2648	L<http://rev.rubyforge.org/>.
2603		2649
2604	=item D	2650	=item D
2605		2651
…		…
2609	=back	2655	=back
2610		2656
2611		2657
2612	=head1 MACRO MAGIC	2658	=head1 MACRO MAGIC
2613		2659
2614	Libev can be compiled with a variety of options, the most fundamantal	2660	Libev can be compiled with a variety of options, the most fundamental
2615	of which is C<EV_MULTIPLICITY>. This option determines whether (most)	2661	of which is C<EV_MULTIPLICITY>. This option determines whether (most)
2616	functions and callbacks have an initial C<struct ev_loop *> argument.	2662	functions and callbacks have an initial C<struct ev_loop *> argument.
2617		2663
2618	To make it easier to write programs that cope with either variant, the	2664	To make it easier to write programs that cope with either variant, the
2619	following macros are defined:	2665	following macros are defined:
…		…
2624		2670
2625	This provides the loop I<argument> for functions, if one is required ("ev	2671	This provides the loop I<argument> for functions, if one is required ("ev
2626	loop argument"). The C<EV_A> form is used when this is the sole argument,	2672	loop argument"). The C<EV_A> form is used when this is the sole argument,
2627	C<EV_A_> is used when other arguments are following. Example:	2673	C<EV_A_> is used when other arguments are following. Example:
2628		2674
2629	ev_unref (EV_A);	2675	ev_unref (EV_A);
2630	ev_timer_add (EV_A_ watcher);	2676	ev_timer_add (EV_A_ watcher);
2631	ev_loop (EV_A_ 0);	2677	ev_loop (EV_A_ 0);
2632		2678
2633	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,	2679	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,
2634	which is often provided by the following macro.	2680	which is often provided by the following macro.
2635		2681
2636	=item C<EV_P>, C<EV_P_>	2682	=item C<EV_P>, C<EV_P_>
2637		2683
2638	This provides the loop I<parameter> for functions, if one is required ("ev	2684	This provides the loop I<parameter> for functions, if one is required ("ev
2639	loop parameter"). The C<EV_P> form is used when this is the sole parameter,	2685	loop parameter"). The C<EV_P> form is used when this is the sole parameter,
2640	C<EV_P_> is used when other parameters are following. Example:	2686	C<EV_P_> is used when other parameters are following. Example:
2641		2687
2642	// this is how ev_unref is being declared	2688	// this is how ev_unref is being declared
2643	static void ev_unref (EV_P);	2689	static void ev_unref (EV_P);
2644		2690
2645	// this is how you can declare your typical callback	2691	// this is how you can declare your typical callback
2646	static void cb (EV_P_ ev_timer *w, int revents)	2692	static void cb (EV_P_ ev_timer *w, int revents)
2647		2693
2648	It declares a parameter C<loop> of type C<struct ev_loop *>, quite	2694	It declares a parameter C<loop> of type C<struct ev_loop *>, quite
2649	suitable for use with C<EV_A>.	2695	suitable for use with C<EV_A>.
2650		2696
2651	=item C<EV_DEFAULT>, C<EV_DEFAULT_>	2697	=item C<EV_DEFAULT>, C<EV_DEFAULT_>
…		…
2667		2713
2668	Example: Declare and initialise a check watcher, utilising the above	2714	Example: Declare and initialise a check watcher, utilising the above
2669	macros so it will work regardless of whether multiple loops are supported	2715	macros so it will work regardless of whether multiple loops are supported
2670	or not.	2716	or not.
2671		2717
2672	static void	2718	static void
2673	check_cb (EV_P_ ev_timer *w, int revents)	2719	check_cb (EV_P_ ev_timer *w, int revents)
2674	{	2720	{
2675	ev_check_stop (EV_A_ w);	2721	ev_check_stop (EV_A_ w);
2676	}	2722	}
2677		2723
2678	ev_check check;	2724	ev_check check;
2679	ev_check_init (&check, check_cb);	2725	ev_check_init (&check, check_cb);
2680	ev_check_start (EV_DEFAULT_ &check);	2726	ev_check_start (EV_DEFAULT_ &check);
2681	ev_loop (EV_DEFAULT_ 0);	2727	ev_loop (EV_DEFAULT_ 0);
2682		2728
2683	=head1 EMBEDDING	2729	=head1 EMBEDDING
2684		2730
2685	Libev can (and often is) directly embedded into host	2731	Libev can (and often is) directly embedded into host
2686	applications. Examples of applications that embed it include the Deliantra	2732	applications. Examples of applications that embed it include the Deliantra
…		…
2693	libev somewhere in your source tree).	2739	libev somewhere in your source tree).
2694		2740
2695	=head2 FILESETS	2741	=head2 FILESETS
2696		2742
2697	Depending on what features you need you need to include one or more sets of files	2743	Depending on what features you need you need to include one or more sets of files
2698	in your app.	2744	in your application.
2699		2745
2700	=head3 CORE EVENT LOOP	2746	=head3 CORE EVENT LOOP
2701		2747
2702	To include only the libev core (all the C<ev_*> functions), with manual	2748	To include only the libev core (all the C<ev_*> functions), with manual
2703	configuration (no autoconf):	2749	configuration (no autoconf):
2704		2750
2705	#define EV_STANDALONE 1	2751	#define EV_STANDALONE 1
2706	#include "ev.c"	2752	#include "ev.c"
2707		2753
2708	This will automatically include F<ev.h>, too, and should be done in a	2754	This will automatically include F<ev.h>, too, and should be done in a
2709	single C source file only to provide the function implementations. To use	2755	single C source file only to provide the function implementations. To use
2710	it, do the same for F<ev.h> in all files wishing to use this API (best	2756	it, do the same for F<ev.h> in all files wishing to use this API (best
2711	done by writing a wrapper around F<ev.h> that you can include instead and	2757	done by writing a wrapper around F<ev.h> that you can include instead and
2712	where you can put other configuration options):	2758	where you can put other configuration options):
2713		2759
2714	#define EV_STANDALONE 1	2760	#define EV_STANDALONE 1
2715	#include "ev.h"	2761	#include "ev.h"
2716		2762
2717	Both header files and implementation files can be compiled with a C++	2763	Both header files and implementation files can be compiled with a C++
2718	compiler (at least, thats a stated goal, and breakage will be treated	2764	compiler (at least, thats a stated goal, and breakage will be treated
2719	as a bug).	2765	as a bug).
2720		2766
2721	You need the following files in your source tree, or in a directory	2767	You need the following files in your source tree, or in a directory
2722	in your include path (e.g. in libev/ when using -Ilibev):	2768	in your include path (e.g. in libev/ when using -Ilibev):
2723		2769
2724	ev.h	2770	ev.h
2725	ev.c	2771	ev.c
2726	ev_vars.h	2772	ev_vars.h
2727	ev_wrap.h	2773	ev_wrap.h
2728		2774
2729	ev_win32.c required on win32 platforms only	2775	ev_win32.c required on win32 platforms only
2730		2776
2731	ev_select.c only when select backend is enabled (which is enabled by default)	2777	ev_select.c only when select backend is enabled (which is enabled by default)
2732	ev_poll.c only when poll backend is enabled (disabled by default)	2778	ev_poll.c only when poll backend is enabled (disabled by default)
2733	ev_epoll.c only when the epoll backend is enabled (disabled by default)	2779	ev_epoll.c only when the epoll backend is enabled (disabled by default)
2734	ev_kqueue.c only when the kqueue backend is enabled (disabled by default)	2780	ev_kqueue.c only when the kqueue backend is enabled (disabled by default)
2735	ev_port.c only when the solaris port backend is enabled (disabled by default)	2781	ev_port.c only when the solaris port backend is enabled (disabled by default)
2736		2782
2737	F<ev.c> includes the backend files directly when enabled, so you only need	2783	F<ev.c> includes the backend files directly when enabled, so you only need
2738	to compile this single file.	2784	to compile this single file.
2739		2785
2740	=head3 LIBEVENT COMPATIBILITY API	2786	=head3 LIBEVENT COMPATIBILITY API
2741		2787
2742	To include the libevent compatibility API, also include:	2788	To include the libevent compatibility API, also include:
2743		2789
2744	#include "event.c"	2790	#include "event.c"
2745		2791
2746	in the file including F<ev.c>, and:	2792	in the file including F<ev.c>, and:
2747		2793
2748	#include "event.h"	2794	#include "event.h"
2749		2795
2750	in the files that want to use the libevent API. This also includes F<ev.h>.	2796	in the files that want to use the libevent API. This also includes F<ev.h>.
2751		2797
2752	You need the following additional files for this:	2798	You need the following additional files for this:
2753		2799
2754	event.h	2800	event.h
2755	event.c	2801	event.c
2756		2802
2757	=head3 AUTOCONF SUPPORT	2803	=head3 AUTOCONF SUPPORT
2758		2804
2759	Instead of using C<EV_STANDALONE=1> and providing your config in	2805	Instead of using C<EV_STANDALONE=1> and providing your configuration in
2760	whatever way you want, you can also C<m4_include([libev.m4])> in your	2806	whatever way you want, you can also C<m4_include([libev.m4])> in your
2761	F<configure.ac> and leave C<EV_STANDALONE> undefined. F<ev.c> will then	2807	F<configure.ac> and leave C<EV_STANDALONE> undefined. F<ev.c> will then
2762	include F<config.h> and configure itself accordingly.	2808	include F<config.h> and configure itself accordingly.
2763		2809
2764	For this of course you need the m4 file:	2810	For this of course you need the m4 file:
2765		2811
2766	libev.m4	2812	libev.m4
2767		2813
2768	=head2 PREPROCESSOR SYMBOLS/MACROS	2814	=head2 PREPROCESSOR SYMBOLS/MACROS
2769		2815
2770	Libev can be configured via a variety of preprocessor symbols you have to	2816	Libev can be configured via a variety of preprocessor symbols you have to
2771	define before including any of its files. The default in the absense of	2817	define before including any of its files. The default in the absence of
2772	autoconf is noted for every option.	2818	autoconf is noted for every option.
2773		2819
2774	=over 4	2820	=over 4
2775		2821
2776	=item EV_STANDALONE	2822	=item EV_STANDALONE
…		…
2782	F<event.h> that are not directly supported by the libev core alone.	2828	F<event.h> that are not directly supported by the libev core alone.
2783		2829
2784	=item EV_USE_MONOTONIC	2830	=item EV_USE_MONOTONIC
2785		2831
2786	If defined to be C<1>, libev will try to detect the availability of the	2832	If defined to be C<1>, libev will try to detect the availability of the
2787	monotonic clock option at both compiletime and runtime. Otherwise no use	2833	monotonic clock option at both compile time and runtime. Otherwise no use
2788	of the monotonic clock option will be attempted. If you enable this, you	2834	of the monotonic clock option will be attempted. If you enable this, you
2789	usually have to link against librt or something similar. Enabling it when	2835	usually have to link against librt or something similar. Enabling it when
2790	the functionality isn't available is safe, though, although you have	2836	the functionality isn't available is safe, though, although you have
2791	to make sure you link against any libraries where the C<clock_gettime>	2837	to make sure you link against any libraries where the C<clock_gettime>
2792	function is hiding in (often F<-lrt>).	2838	function is hiding in (often F<-lrt>).
2793		2839
2794	=item EV_USE_REALTIME	2840	=item EV_USE_REALTIME
2795		2841
2796	If defined to be C<1>, libev will try to detect the availability of the	2842	If defined to be C<1>, libev will try to detect the availability of the
2797	realtime clock option at compiletime (and assume its availability at	2843	real-time clock option at compile time (and assume its availability at
2798	runtime if successful). Otherwise no use of the realtime clock option will	2844	runtime if successful). Otherwise no use of the real-time clock option will
2799	be attempted. This effectively replaces C<gettimeofday> by C<clock_get	2845	be attempted. This effectively replaces C<gettimeofday> by C<clock_get
2800	(CLOCK_REALTIME, ...)> and will not normally affect correctness. See the	2846	(CLOCK_REALTIME, ...)> and will not normally affect correctness. See the
2801	note about libraries in the description of C<EV_USE_MONOTONIC>, though.	2847	note about libraries in the description of C<EV_USE_MONOTONIC>, though.
2802		2848
2803	=item EV_USE_NANOSLEEP	2849	=item EV_USE_NANOSLEEP
…		…
2814	2.7 or newer, otherwise disabled.	2860	2.7 or newer, otherwise disabled.
2815		2861
2816	=item EV_USE_SELECT	2862	=item EV_USE_SELECT
2817		2863
2818	If undefined or defined to be C<1>, libev will compile in support for the	2864	If undefined or defined to be C<1>, libev will compile in support for the
2819	C<select>(2) backend. No attempt at autodetection will be done: if no	2865	C<select>(2) backend. No attempt at auto-detection will be done: if no
2820	other method takes over, select will be it. Otherwise the select backend	2866	other method takes over, select will be it. Otherwise the select backend
2821	will not be compiled in.	2867	will not be compiled in.
2822		2868
2823	=item EV_SELECT_USE_FD_SET	2869	=item EV_SELECT_USE_FD_SET
2824		2870
2825	If defined to C<1>, then the select backend will use the system C<fd_set>	2871	If defined to C<1>, then the select backend will use the system C<fd_set>
2826	structure. This is useful if libev doesn't compile due to a missing	2872	structure. This is useful if libev doesn't compile due to a missing
2827	C<NFDBITS> or C<fd_mask> definition or it misguesses the bitset layout on	2873	C<NFDBITS> or C<fd_mask> definition or it mis-guesses the bitset layout on
2828	exotic systems. This usually limits the range of file descriptors to some	2874	exotic systems. This usually limits the range of file descriptors to some
2829	low limit such as 1024 or might have other limitations (winsocket only	2875	low limit such as 1024 or might have other limitations (winsocket only
2830	allows 64 sockets). The C<FD_SETSIZE> macro, set before compilation, might	2876	allows 64 sockets). The C<FD_SETSIZE> macro, set before compilation, might
2831	influence the size of the C<fd_set> used.	2877	influence the size of the C<fd_set> used.
2832		2878
…		…
2881	otherwise another method will be used as fallback. This is the preferred	2927	otherwise another method will be used as fallback. This is the preferred
2882	backend for Solaris 10 systems.	2928	backend for Solaris 10 systems.
2883		2929
2884	=item EV_USE_DEVPOLL	2930	=item EV_USE_DEVPOLL
2885		2931
2886	reserved for future expansion, works like the USE symbols above.	2932	Reserved for future expansion, works like the USE symbols above.
2887		2933
2888	=item EV_USE_INOTIFY	2934	=item EV_USE_INOTIFY
2889		2935
2890	If defined to be C<1>, libev will compile in support for the Linux inotify	2936	If defined to be C<1>, libev will compile in support for the Linux inotify
2891	interface to speed up C<ev_stat> watchers. Its actual availability will	2937	interface to speed up C<ev_stat> watchers. Its actual availability will
…		…
2898	access is atomic with respect to other threads or signal contexts. No such	2944	access is atomic with respect to other threads or signal contexts. No such
2899	type is easily found in the C language, so you can provide your own type	2945	type is easily found in the C language, so you can provide your own type
2900	that you know is safe for your purposes. It is used both for signal handler "locking"	2946	that you know is safe for your purposes. It is used both for signal handler "locking"
2901	as well as for signal and thread safety in C<ev_async> watchers.	2947	as well as for signal and thread safety in C<ev_async> watchers.
2902		2948
2903	In the absense of this define, libev will use C<sig_atomic_t volatile>	2949	In the absence of this define, libev will use C<sig_atomic_t volatile>
2904	(from F<signal.h>), which is usually good enough on most platforms.	2950	(from F<signal.h>), which is usually good enough on most platforms.
2905		2951
2906	=item EV_H	2952	=item EV_H
2907		2953
2908	The name of the F<ev.h> header file used to include it. The default if	2954	The name of the F<ev.h> header file used to include it. The default if
…		…
2947	When doing priority-based operations, libev usually has to linearly search	2993	When doing priority-based operations, libev usually has to linearly search
2948	all the priorities, so having many of them (hundreds) uses a lot of space	2994	all the priorities, so having many of them (hundreds) uses a lot of space
2949	and time, so using the defaults of five priorities (-2 .. +2) is usually	2995	and time, so using the defaults of five priorities (-2 .. +2) is usually
2950	fine.	2996	fine.
2951		2997
2952	If your embedding app does not need any priorities, defining these both to	2998	If your embedding application does not need any priorities, defining these both to
2953	C<0> will save some memory and cpu.	2999	C<0> will save some memory and CPU.
2954		3000
2955	=item EV_PERIODIC_ENABLE	3001	=item EV_PERIODIC_ENABLE
2956		3002
2957	If undefined or defined to be C<1>, then periodic timers are supported. If	3003	If undefined or defined to be C<1>, then periodic timers are supported. If
2958	defined to be C<0>, then they are not. Disabling them saves a few kB of	3004	defined to be C<0>, then they are not. Disabling them saves a few kB of
…		…
2986		3032
2987	=item EV_MINIMAL	3033	=item EV_MINIMAL
2988		3034
2989	If you need to shave off some kilobytes of code at the expense of some	3035	If you need to shave off some kilobytes of code at the expense of some
2990	speed, define this symbol to C<1>. Currently this is used to override some	3036	speed, define this symbol to C<1>. Currently this is used to override some
2991	inlining decisions, saves roughly 30% codesize of amd64. It also selects a	3037	inlining decisions, saves roughly 30% code size on amd64. It also selects a
2992	much smaller 2-heap for timer management over the default 4-heap.	3038	much smaller 2-heap for timer management over the default 4-heap.
2993		3039
2994	=item EV_PID_HASHSIZE	3040	=item EV_PID_HASHSIZE
2995		3041
2996	C<ev_child> watchers use a small hash table to distribute workload by	3042	C<ev_child> watchers use a small hash table to distribute workload by
…		…
3009	=item EV_USE_4HEAP	3055	=item EV_USE_4HEAP
3010		3056
3011	Heaps are not very cache-efficient. To improve the cache-efficiency of the	3057	Heaps are not very cache-efficient. To improve the cache-efficiency of the
3012	timer and periodics heap, libev uses a 4-heap when this symbol is defined	3058	timer and periodics heap, libev uses a 4-heap when this symbol is defined
3013	to C<1>. The 4-heap uses more complicated (longer) code but has	3059	to C<1>. The 4-heap uses more complicated (longer) code but has
3014	noticably faster performance with many (thousands) of watchers.	3060	noticeably faster performance with many (thousands) of watchers.
3015		3061
3016	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>	3062	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>
3017	(disabled).	3063	(disabled).
3018		3064
3019	=item EV_HEAP_CACHE_AT	3065	=item EV_HEAP_CACHE_AT
…		…
3021	Heaps are not very cache-efficient. To improve the cache-efficiency of the	3067	Heaps are not very cache-efficient. To improve the cache-efficiency of the
3022	timer and periodics heap, libev can cache the timestamp (I<at>) within	3068	timer and periodics heap, libev can cache the timestamp (I<at>) within
3023	the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>),	3069	the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>),
3024	which uses 8-12 bytes more per watcher and a few hundred bytes more code,	3070	which uses 8-12 bytes more per watcher and a few hundred bytes more code,
3025	but avoids random read accesses on heap changes. This improves performance	3071	but avoids random read accesses on heap changes. This improves performance
3026	noticably with with many (hundreds) of watchers.	3072	noticeably with with many (hundreds) of watchers.
3027		3073
3028	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>	3074	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>
3029	(disabled).	3075	(disabled).
		3076
		3077	=item EV_VERIFY
		3078
		3079	Controls how much internal verification (see C<ev_loop_verify ()>) will
		3080	be done: If set to C<0>, no internal verification code will be compiled
		3081	in. If set to C<1>, then verification code will be compiled in, but not
		3082	called. If set to C<2>, then the internal verification code will be
		3083	called once per loop, which can slow down libev. If set to C<3>, then the
		3084	verification code will be called very frequently, which will slow down
		3085	libev considerably.
		3086
		3087	The default is C<1>, unless C<EV_MINIMAL> is set, in which case it will be
		3088	C<0.>
3030		3089
3031	=item EV_COMMON	3090	=item EV_COMMON
3032		3091
3033	By default, all watchers have a C<void *data> member. By redefining	3092	By default, all watchers have a C<void *data> member. By redefining
3034	this macro to a something else you can include more and other types of	3093	this macro to a something else you can include more and other types of
3035	members. You have to define it each time you include one of the files,	3094	members. You have to define it each time you include one of the files,
3036	though, and it must be identical each time.	3095	though, and it must be identical each time.
3037		3096
3038	For example, the perl EV module uses something like this:	3097	For example, the perl EV module uses something like this:
3039		3098
3040	#define EV_COMMON \	3099	#define EV_COMMON \
3041	SV *self; /* contains this struct */ \	3100	SV *self; /* contains this struct */ \
3042	SV *cb_sv, *fh /* note no trailing ";" */	3101	SV *cb_sv, *fh /* note no trailing ";" */
3043		3102
3044	=item EV_CB_DECLARE (type)	3103	=item EV_CB_DECLARE (type)
3045		3104
3046	=item EV_CB_INVOKE (watcher, revents)	3105	=item EV_CB_INVOKE (watcher, revents)
3047		3106
…		…
3054	avoid the C<struct ev_loop *> as first argument in all cases, or to use	3113	avoid the C<struct ev_loop *> as first argument in all cases, or to use
3055	method calls instead of plain function calls in C++.	3114	method calls instead of plain function calls in C++.
3056		3115
3057	=head2 EXPORTED API SYMBOLS	3116	=head2 EXPORTED API SYMBOLS
3058		3117
3059	If you need to re-export the API (e.g. via a dll) and you need a list of	3118	If you need to re-export the API (e.g. via a DLL) and you need a list of
3060	exported symbols, you can use the provided F<Symbol.*> files which list	3119	exported symbols, you can use the provided F<Symbol.*> files which list
3061	all public symbols, one per line:	3120	all public symbols, one per line:
3062		3121
3063	Symbols.ev for libev proper	3122	Symbols.ev for libev proper
3064	Symbols.event for the libevent emulation	3123	Symbols.event for the libevent emulation
3065		3124
3066	This can also be used to rename all public symbols to avoid clashes with	3125	This can also be used to rename all public symbols to avoid clashes with
3067	multiple versions of libev linked together (which is obviously bad in	3126	multiple versions of libev linked together (which is obviously bad in
3068	itself, but sometimes it is inconvinient to avoid this).	3127	itself, but sometimes it is inconvenient to avoid this).
3069		3128
3070	A sed command like this will create wrapper C<#define>'s that you need to	3129	A sed command like this will create wrapper C<#define>'s that you need to
3071	include before including F<ev.h>:	3130	include before including F<ev.h>:
3072		3131
3073	<Symbols.ev sed -e "s/.*/#define & myprefix_&/" >wrap.h	3132	<Symbols.ev sed -e "s/.*/#define & myprefix_&/" >wrap.h
…		…
3090	file.	3149	file.
3091		3150
3092	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file	3151	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file
3093	that everybody includes and which overrides some configure choices:	3152	that everybody includes and which overrides some configure choices:
3094		3153
3095	#define EV_MINIMAL 1	3154	#define EV_MINIMAL 1
3096	#define EV_USE_POLL 0	3155	#define EV_USE_POLL 0
3097	#define EV_MULTIPLICITY 0	3156	#define EV_MULTIPLICITY 0
3098	#define EV_PERIODIC_ENABLE 0	3157	#define EV_PERIODIC_ENABLE 0
3099	#define EV_STAT_ENABLE 0	3158	#define EV_STAT_ENABLE 0
3100	#define EV_FORK_ENABLE 0	3159	#define EV_FORK_ENABLE 0
3101	#define EV_CONFIG_H <config.h>	3160	#define EV_CONFIG_H <config.h>
3102	#define EV_MINPRI 0	3161	#define EV_MINPRI 0
3103	#define EV_MAXPRI 0	3162	#define EV_MAXPRI 0
3104		3163
3105	#include "ev++.h"	3164	#include "ev++.h"
3106		3165
3107	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:	3166	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
3108		3167
3109	#include "ev_cpp.h"	3168	#include "ev_cpp.h"
3110	#include "ev.c"	3169	#include "ev.c"
3111		3170
3112		3171
3113	=head1 THREADS AND COROUTINES	3172	=head1 THREADS AND COROUTINES
3114		3173
3115	=head2 THREADS	3174	=head2 THREADS
3116		3175
3117	Libev itself is completely threadsafe, but it uses no locking. This	3176	Libev itself is completely thread-safe, but it uses no locking. This
3118	means that you can use as many loops as you want in parallel, as long as	3177	means that you can use as many loops as you want in parallel, as long as
3119	only one thread ever calls into one libev function with the same loop	3178	only one thread ever calls into one libev function with the same loop
3120	parameter.	3179	parameter.
3121		3180
3122	Or put differently: calls with different loop parameters can be done in	3181	Or put differently: calls with different loop parameters can be done in
…		…
3129	help you but by giving some generic advice:	3188	help you but by giving some generic advice:
3130		3189
3131	=over 4	3190	=over 4
3132		3191
3133	=item * most applications have a main thread: use the default libev loop	3192	=item * most applications have a main thread: use the default libev loop
3134	in that thread, or create a seperate thread running only the default loop.	3193	in that thread, or create a separate thread running only the default loop.
3135		3194
3136	This helps integrating other libraries or software modules that use libev	3195	This helps integrating other libraries or software modules that use libev
3137	themselves and don't care/know about threading.	3196	themselves and don't care/know about threading.
3138		3197
3139	=item * one loop per thread is usually a good model.	3198	=item * one loop per thread is usually a good model.
3140		3199
3141	Doing this is almost never wrong, sometimes a better-performance model	3200	Doing this is almost never wrong, sometimes a better-performance model
3142	exists, but it is always a good start.	3201	exists, but it is always a good start.
3143		3202
3144	=item * other models exist, such as the leader/follower pattern, where one	3203	=item * other models exist, such as the leader/follower pattern, where one
3145	loop is handed through multiple threads in a kind of round-robbin fashion.	3204	loop is handed through multiple threads in a kind of round-robin fashion.
3146		3205
3147	Chosing a model is hard - look around, learn, know that usually you cna do	3206	Choosing a model is hard - look around, learn, know that usually you can do
3148	better than you currently do :-)	3207	better than you currently do :-)
3149		3208
3150	=item * often you need to talk to some other thread which blocks in the	3209	=item * often you need to talk to some other thread which blocks in the
3151	event loop - C<ev_async> watchers can be used to wake them up from other	3210	event loop - C<ev_async> watchers can be used to wake them up from other
3152	threads safely (or from signal contexts...).	3211	threads safely (or from signal contexts...).
3153		3212
3154	=back	3213	=back
3155		3214
3156	=head2 COROUTINES	3215	=head2 COROUTINES
3157		3216
3158	Libev is much more accomodating to coroutines ("cooperative threads"):	3217	Libev is much more accommodating to coroutines ("cooperative threads"):
3159	libev fully supports nesting calls to it's functions from different	3218	libev fully supports nesting calls to it's functions from different
3160	coroutines (e.g. you can call C<ev_loop> on the same loop from two	3219	coroutines (e.g. you can call C<ev_loop> on the same loop from two
3161	different coroutines and switch freely between both coroutines running the	3220	different coroutines and switch freely between both coroutines running the
3162	loop, as long as you don't confuse yourself). The only exception is that	3221	loop, as long as you don't confuse yourself). The only exception is that
3163	you must not do this from C<ev_periodic> reschedule callbacks.	3222	you must not do this from C<ev_periodic> reschedule callbacks.
…		…
3211		3270
3212	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)	3271	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)
3213		3272
3214	A change means an I/O watcher gets started or stopped, which requires	3273	A change means an I/O watcher gets started or stopped, which requires
3215	libev to recalculate its status (and possibly tell the kernel, depending	3274	libev to recalculate its status (and possibly tell the kernel, depending
3216	on backend and wether C<ev_io_set> was used).	3275	on backend and whether C<ev_io_set> was used).
3217		3276
3218	=item Activating one watcher (putting it into the pending state): O(1)	3277	=item Activating one watcher (putting it into the pending state): O(1)
3219		3278
3220	=item Priority handling: O(number_of_priorities)	3279	=item Priority handling: O(number_of_priorities)
3221		3280
…		…
3228		3287
3229	=item Processing ev_async_send: O(number_of_async_watchers)	3288	=item Processing ev_async_send: O(number_of_async_watchers)
3230		3289
3231	=item Processing signals: O(max_signal_number)	3290	=item Processing signals: O(max_signal_number)
3232		3291
3233	Sending involves a syscall I<iff> there were no other C<ev_async_send>	3292	Sending involves a system call I<iff> there were no other C<ev_async_send>
3234	calls in the current loop iteration. Checking for async and signal events	3293	calls in the current loop iteration. Checking for async and signal events
3235	involves iterating over all running async watchers or all signal numbers.	3294	involves iterating over all running async watchers or all signal numbers.
3236		3295
3237	=back	3296	=back
3238		3297
3239		3298
3240	=head1 Win32 platform limitations and workarounds	3299	=head1 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS
3241		3300
3242	Win32 doesn't support any of the standards (e.g. POSIX) that libev	3301	Win32 doesn't support any of the standards (e.g. POSIX) that libev
3243	requires, and its I/O model is fundamentally incompatible with the POSIX	3302	requires, and its I/O model is fundamentally incompatible with the POSIX
3244	model. Libev still offers limited functionality on this platform in	3303	model. Libev still offers limited functionality on this platform in
3245	the form of the C<EVBACKEND_SELECT> backend, and only supports socket	3304	the form of the C<EVBACKEND_SELECT> backend, and only supports socket
…		…
3252	way (note also that glib is the slowest event library known to man).	3311	way (note also that glib is the slowest event library known to man).
3253		3312
3254	There is no supported compilation method available on windows except	3313	There is no supported compilation method available on windows except
3255	embedding it into other applications.	3314	embedding it into other applications.
3256		3315
		3316	Not a libev limitation but worth mentioning: windows apparently doesn't
		3317	accept large writes: instead of resulting in a partial write, windows will
		3318	either accept everything or return C<ENOBUFS> if the buffer is too large,
		3319	so make sure you only write small amounts into your sockets (less than a
		3320	megabyte seems safe, but thsi apparently depends on the amount of memory
		3321	available).
		3322
3257	Due to the many, low, and arbitrary limits on the win32 platform and	3323	Due to the many, low, and arbitrary limits on the win32 platform and
3258	the abysmal performance of winsockets, using a large number of sockets	3324	the abysmal performance of winsockets, using a large number of sockets
3259	is not recommended (and not reasonable). If your program needs to use	3325	is not recommended (and not reasonable). If your program needs to use
3260	more than a hundred or so sockets, then likely it needs to use a totally	3326	more than a hundred or so sockets, then likely it needs to use a totally
3261	different implementation for windows, as libev offers the POSIX readiness	3327	different implementation for windows, as libev offers the POSIX readiness
3262	notification model, which cannot be implemented efficiently on windows	3328	notification model, which cannot be implemented efficiently on windows
3263	(microsoft monopoly games).	3329	(Microsoft monopoly games).
3264		3330
3265	=over 4	3331	=over 4
3266		3332
3267	=item The winsocket select function	3333	=item The winsocket select function
3268		3334
3269	The winsocket C<select> function doesn't follow POSIX in that it requires	3335	The winsocket C<select> function doesn't follow POSIX in that it
3270	socket I<handles> and not socket I<file descriptors>. This makes select	3336	requires socket I<handles> and not socket I<file descriptors> (it is
3271	very inefficient, and also requires a mapping from file descriptors	3337	also extremely buggy). This makes select very inefficient, and also
3272	to socket handles. See the discussion of the C<EV_SELECT_USE_FD_SET>,	3338	requires a mapping from file descriptors to socket handles. See the
3273	C<EV_SELECT_IS_WINSOCKET> and C<EV_FD_TO_WIN32_HANDLE> preprocessor	3339	discussion of the C<EV_SELECT_USE_FD_SET>, C<EV_SELECT_IS_WINSOCKET> and
3274	symbols for more info.	3340	C<EV_FD_TO_WIN32_HANDLE> preprocessor symbols for more info.
3275		3341
3276	The configuration for a "naked" win32 using the microsoft runtime	3342	The configuration for a "naked" win32 using the Microsoft runtime
3277	libraries and raw winsocket select is:	3343	libraries and raw winsocket select is:
3278		3344
3279	#define EV_USE_SELECT 1	3345	#define EV_USE_SELECT 1
3280	#define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */	3346	#define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */
3281		3347
3282	Note that winsockets handling of fd sets is O(n), so you can easily get a	3348	Note that winsockets handling of fd sets is O(n), so you can easily get a
3283	complexity in the O(n²) range when using win32.	3349	complexity in the O(n²) range when using win32.
3284		3350
3285	=item Limited number of file descriptors	3351	=item Limited number of file descriptors
3286		3352
3287	Windows has numerous arbitrary (and low) limits on things.	3353	Windows has numerous arbitrary (and low) limits on things.
3288		3354
3289	Early versions of winsocket's select only supported waiting for a maximum	3355	Early versions of winsocket's select only supported waiting for a maximum
3290	of C<64> handles (probably owning to the fact that all windows kernels	3356	of C<64> handles (probably owning to the fact that all windows kernels
3291	can only wait for C<64> things at the same time internally; microsoft	3357	can only wait for C<64> things at the same time internally; Microsoft
3292	recommends spawning a chain of threads and wait for 63 handles and the	3358	recommends spawning a chain of threads and wait for 63 handles and the
3293	previous thread in each. Great).	3359	previous thread in each. Great).
3294		3360
3295	Newer versions support more handles, but you need to define C<FD_SETSIZE>	3361	Newer versions support more handles, but you need to define C<FD_SETSIZE>
3296	to some high number (e.g. C<2048>) before compiling the winsocket select	3362	to some high number (e.g. C<2048>) before compiling the winsocket select
3297	call (which might be in libev or elsewhere, for example, perl does its own	3363	call (which might be in libev or elsewhere, for example, perl does its own
3298	select emulation on windows).	3364	select emulation on windows).
3299		3365
3300	Another limit is the number of file descriptors in the microsoft runtime	3366	Another limit is the number of file descriptors in the Microsoft runtime
3301	libraries, which by default is C<64> (there must be a hidden I<64> fetish	3367	libraries, which by default is C<64> (there must be a hidden I<64> fetish
3302	or something like this inside microsoft). You can increase this by calling	3368	or something like this inside Microsoft). You can increase this by calling
3303	C<_setmaxstdio>, which can increase this limit to C<2048> (another	3369	C<_setmaxstdio>, which can increase this limit to C<2048> (another
3304	arbitrary limit), but is broken in many versions of the microsoft runtime	3370	arbitrary limit), but is broken in many versions of the Microsoft runtime
3305	libraries.	3371	libraries.
3306		3372
3307	This might get you to about C<512> or C<2048> sockets (depending on	3373	This might get you to about C<512> or C<2048> sockets (depending on
3308	windows version and/or the phase of the moon). To get more, you need to	3374	windows version and/or the phase of the moon). To get more, you need to
3309	wrap all I/O functions and provide your own fd management, but the cost of	3375	wrap all I/O functions and provide your own fd management, but the cost of
…		…
3316		3382
3317	In addition to a working ISO-C implementation, libev relies on a few	3383	In addition to a working ISO-C implementation, libev relies on a few
3318	additional extensions:	3384	additional extensions:
3319		3385
3320	=over 4	3386	=over 4
		3387
		3388	=item C<void (*)(ev_watcher_type *, int revents)> must have compatible
		3389	calling conventions regardless of C<ev_watcher_type *>.
		3390
		3391	Libev assumes not only that all watcher pointers have the same internal
		3392	structure (guaranteed by POSIX but not by ISO C for example), but it also
		3393	assumes that the same (machine) code can be used to call any watcher
		3394	callback: The watcher callbacks have different type signatures, but libev
		3395	calls them using an C<ev_watcher *> internally.
3321		3396
3322	=item C<sig_atomic_t volatile> must be thread-atomic as well	3397	=item C<sig_atomic_t volatile> must be thread-atomic as well
3323		3398
3324	The type C<sig_atomic_t volatile> (or whatever is defined as	3399	The type C<sig_atomic_t volatile> (or whatever is defined as
3325	C<EV_ATOMIC_T>) must be atomic w.r.t. accesses from different	3400	C<EV_ATOMIC_T>) must be atomic w.r.t. accesses from different
…		…
3357	=back	3432	=back
3358		3433
3359	If you know of other additional requirements drop me a note.	3434	If you know of other additional requirements drop me a note.
3360		3435
3361		3436
		3437	=head1 COMPILER WARNINGS
		3438
		3439	Depending on your compiler and compiler settings, you might get no or a
		3440	lot of warnings when compiling libev code. Some people are apparently
		3441	scared by this.
		3442
		3443	However, these are unavoidable for many reasons. For one, each compiler
		3444	has different warnings, and each user has different tastes regarding
		3445	warning options. "Warn-free" code therefore cannot be a goal except when
		3446	targeting a specific compiler and compiler-version.
		3447
		3448	Another reason is that some compiler warnings require elaborate
		3449	workarounds, or other changes to the code that make it less clear and less
		3450	maintainable.
		3451
		3452	And of course, some compiler warnings are just plain stupid, or simply
		3453	wrong (because they don't actually warn about the condition their message
		3454	seems to warn about).
		3455
		3456	While libev is written to generate as few warnings as possible,
		3457	"warn-free" code is not a goal, and it is recommended not to build libev
		3458	with any compiler warnings enabled unless you are prepared to cope with
		3459	them (e.g. by ignoring them). Remember that warnings are just that:
		3460	warnings, not errors, or proof of bugs.
		3461
		3462
3362	=head1 VALGRIND	3463	=head1 VALGRIND
3363		3464
3364	Valgrind has a special section here because it is a popular tool that is	3465	Valgrind has a special section here because it is a popular tool that is
3365	highly useful, but valgrind reports are very hard to interpret.	3466	highly useful, but valgrind reports are very hard to interpret.
3366		3467
…		…
3369		3470
3370	==2274== definitely lost: 0 bytes in 0 blocks.	3471	==2274== definitely lost: 0 bytes in 0 blocks.
3371	==2274== possibly lost: 0 bytes in 0 blocks.	3472	==2274== possibly lost: 0 bytes in 0 blocks.
3372	==2274== still reachable: 256 bytes in 1 blocks.	3473	==2274== still reachable: 256 bytes in 1 blocks.
3373		3474
3374	then there is no memory leak. Similarly, under some circumstances,	3475	Then there is no memory leak. Similarly, under some circumstances,
3375	valgrind might report kernel bugs as if it were a bug in libev, or it	3476	valgrind might report kernel bugs as if it were a bug in libev, or it
3376	might be confused (it is a very good tool, but only a tool).	3477	might be confused (it is a very good tool, but only a tool).
3377		3478
3378	If you are unsure about something, feel free to contact the mailing list	3479	If you are unsure about something, feel free to contact the mailing list
3379	with the full valgrind report and an explanation on why you think this is	3480	with the full valgrind report and an explanation on why you think this is

Diff Legend

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