ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.159 by root, Thu May 22 02:44:57 2008 UTC vs.
Revision 1.169 by root, Fri Jun 20 23:31:19 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.
693		714
694	=item ev_loop_verify (loop)	715	=item ev_loop_verify (loop)
695		716
696	This function only does something when C<EV_VERIFY> support has been	717	This function only does something when C<EV_VERIFY> support has been
697	compiled in. It tries to go through all internal structures and checks	718	compiled in. It tries to go through all internal structures and checks
…		…
709		730
710	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
711	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
712	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:
713		734
714	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)
715	{	736	{
716	ev_io_stop (w);	737	ev_io_stop (w);
717	ev_unloop (loop, EVUNLOOP_ALL);	738	ev_unloop (loop, EVUNLOOP_ALL);
718	}	739	}
719		740
720	struct ev_loop *loop = ev_default_loop (0);	741	struct ev_loop *loop = ev_default_loop (0);
721	struct ev_io stdin_watcher;	742	struct ev_io stdin_watcher;
722	ev_init (&stdin_watcher, my_cb);	743	ev_init (&stdin_watcher, my_cb);
723	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);	744	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);
724	ev_io_start (loop, &stdin_watcher);	745	ev_io_start (loop, &stdin_watcher);
725	ev_loop (loop, 0);	746	ev_loop (loop, 0);
726		747
727	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
728	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,
729	although this can sometimes be quite valid).	750	although this can sometimes be quite valid).
730		751
731	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
732	(watcher *, callback)>, which expects a callback to be provided. This	753	(watcher *, callback)>, which expects a callback to be provided. This
733	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
734	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
735	is readable and/or writable).	756	is readable and/or writable).
736		757
737	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
738	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
…		…
814		835
815	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>).
816		837
817	=item C<EV_ERROR>	838	=item C<EV_ERROR>
818		839
819	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
820	happen because the watcher could not be properly started because libev	841	happen because the watcher could not be properly started because libev
821	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
822	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
823	with the watcher being stopped.	844	with the watcher being stopped.
824		845
825	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,
826	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
827	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
828	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
829	programs, though, so beware.	850	programs, though, so beware.
830		851
831	=back	852	=back
832		853
833	=head2 GENERIC WATCHER FUNCTIONS	854	=head2 GENERIC WATCHER FUNCTIONS
…		…
863	Although some watcher types do not have type-specific arguments	884	Although some watcher types do not have type-specific arguments
864	(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.
865		886
866	=item C<ev_TYPE_init> (ev_TYPE *watcher, callback, [args])	887	=item C<ev_TYPE_init> (ev_TYPE *watcher, callback, [args])
867		888
868	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
869	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
870	a watcher. The same limitations apply, of course.	891	a watcher. The same limitations apply, of course.
871		892
872	=item C<ev_TYPE_start> (loop *, ev_TYPE *watcher)	893	=item C<ev_TYPE_start> (loop *, ev_TYPE *watcher)
873		894
874	Starts (activates) the given watcher. Only active watchers will receive	895	Starts (activates) the given watcher. Only active watchers will receive
…		…
957	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
958	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
959	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
960	data:	981	data:
961		982
962	struct my_io	983	struct my_io
963	{	984	{
964	struct ev_io io;	985	struct ev_io io;
965	int otherfd;	986	int otherfd;
966	void *somedata;	987	void *somedata;
967	struct whatever *mostinteresting;	988	struct whatever *mostinteresting;
968	}	989	}
969		990
970	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
971	can cast it back to your own type:	992	can cast it back to your own type:
972		993
973	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)
974	{	995	{
975	struct my_io *w = (struct my_io *)w_;	996	struct my_io *w = (struct my_io *)w_;
976	...	997	...
977	}	998	}
978		999
979	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
980	instead have been omitted.	1001	instead have been omitted.
981		1002
982	Another common scenario is having some data structure with multiple	1003	Another common scenario is having some data structure with multiple
983	watchers:	1004	watchers:
984		1005
985	struct my_biggy	1006	struct my_biggy
986	{	1007	{
987	int some_data;	1008	int some_data;
988	ev_timer t1;	1009	ev_timer t1;
989	ev_timer t2;	1010	ev_timer t2;
990	}	1011	}
991		1012
992	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,
993	you need to use C<offsetof>:	1014	you need to use C<offsetof>:
994		1015
995	#include <stddef.h>	1016	#include <stddef.h>
996		1017
997	static void	1018	static void
998	t1_cb (EV_P_ struct ev_timer *w, int revents)	1019	t1_cb (EV_P_ struct ev_timer *w, int revents)
999	{	1020	{
1000	struct my_biggy big = (struct my_biggy *	1021	struct my_biggy big = (struct my_biggy *
1001	(((char *)w) - offsetof (struct my_biggy, t1));	1022	(((char *)w) - offsetof (struct my_biggy, t1));
1002	}	1023	}
1003		1024
1004	static void	1025	static void
1005	t2_cb (EV_P_ struct ev_timer *w, int revents)	1026	t2_cb (EV_P_ struct ev_timer *w, int revents)
1006	{	1027	{
1007	struct my_biggy big = (struct my_biggy *	1028	struct my_biggy big = (struct my_biggy *
1008	(((char *)w) - offsetof (struct my_biggy, t2));	1029	(((char *)w) - offsetof (struct my_biggy, t2));
1009	}	1030	}
1010		1031
1011		1032
1012	=head1 WATCHER TYPES	1033	=head1 WATCHER TYPES
1013		1034
1014	This section describes each watcher in detail, but will not repeat	1035	This section describes each watcher in detail, but will not repeat
…		…
1046		1067
1047	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
1048	receive "spurious" readiness notifications, that is your callback might	1069	receive "spurious" readiness notifications, that is your callback might
1049	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
1050	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
1051	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
1052	this situation even with a relatively standard program structure. Thus	1073	this situation even with a relatively standard program structure. Thus
1053	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
1054	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.
1055		1076
1056	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
1057	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
1058	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
1059	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
1060	its own, so its quite safe to use).	1081	its own, so its quite safe to use).
1061		1082
1062	=head3 The special problem of disappearing file descriptors	1083	=head3 The special problem of disappearing file descriptors
…		…
1122	=item ev_io_init (ev_io *, callback, int fd, int events)	1143	=item ev_io_init (ev_io *, callback, int fd, int events)
1123		1144
1124	=item ev_io_set (ev_io *, int fd, int events)	1145	=item ev_io_set (ev_io *, int fd, int events)
1125		1146
1126	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
1127	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
1128	C<EV_READ | EV_WRITE> to receive the given events.	1149	C<EV_READ | EV_WRITE> to receive the given events.
1129		1150
1130	=item int fd [read-only]	1151	=item int fd [read-only]
1131		1152
1132	The file descriptor being watched.	1153	The file descriptor being watched.
…		…
1141		1162
1142	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
1143	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
1144	attempt to read a whole line in the callback.	1165	attempt to read a whole line in the callback.
1145		1166
1146	static void	1167	static void
1147	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)
1148	{	1169	{
1149	ev_io_stop (loop, w);	1170	ev_io_stop (loop, w);
1150	.. 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
1151	}	1172	}
1152		1173
1153	...	1174	...
1154	struct ev_loop *loop = ev_default_init (0);	1175	struct ev_loop *loop = ev_default_init (0);
1155	struct ev_io stdin_readable;	1176	struct ev_io stdin_readable;
1156	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);
1157	ev_io_start (loop, &stdin_readable);	1178	ev_io_start (loop, &stdin_readable);
1158	ev_loop (loop, 0);	1179	ev_loop (loop, 0);
1159		1180
1160		1181
1161	=head2 C<ev_timer> - relative and optionally repeating timeouts	1182	=head2 C<ev_timer> - relative and optionally repeating timeouts
1162		1183
1163	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
1164	given time, and optionally repeating in regular intervals after that.	1185	given time, and optionally repeating in regular intervals after that.
1165		1186
1166	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
1167	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
1168	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
1169	detecting time jumps is hard, and some inaccuracies are unavoidable (the	1190	detecting time jumps is hard, and some inaccuracies are unavoidable (the
1170	monotonic clock option helps a lot here).	1191	monotonic clock option helps a lot here).
1171		1192
1172	The relative timeouts are calculated relative to the C<ev_now ()>	1193	The relative timeouts are calculated relative to the C<ev_now ()>
…		…
1175	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
1176	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:
1177		1198
1178	ev_timer_set (&timer, after + ev_now () - ev_time (), 0.);	1199	ev_timer_set (&timer, after + ev_now () - ev_time (), 0.);
1179		1200
1180	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,
1181	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
1182	order of execution is undefined.	1203	order of execution is undefined.
1183		1204
1184	=head3 Watcher-Specific Functions and Data Members	1205	=head3 Watcher-Specific Functions and Data Members
1185		1206
…		…
1206	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
1207	repeating. The exact semantics are:	1228	repeating. The exact semantics are:
1208		1229
1209	If the timer is pending, its pending status is cleared.	1230	If the timer is pending, its pending status is cleared.
1210		1231
1211	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).
1212		1233
1213	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
1214	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.
1215		1236
1216	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
1217	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
1218	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
1219	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
1220	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
1221	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
1222	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
…		…
1248		1269
1249	=head3 Examples	1270	=head3 Examples
1250		1271
1251	Example: Create a timer that fires after 60 seconds.	1272	Example: Create a timer that fires after 60 seconds.
1252		1273
1253	static void	1274	static void
1254	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)
1255	{	1276	{
1256	.. one minute over, w is actually stopped right here	1277	.. one minute over, w is actually stopped right here
1257	}	1278	}
1258		1279
1259	struct ev_timer mytimer;	1280	struct ev_timer mytimer;
1260	ev_timer_init (&mytimer, one_minute_cb, 60., 0.);	1281	ev_timer_init (&mytimer, one_minute_cb, 60., 0.);
1261	ev_timer_start (loop, &mytimer);	1282	ev_timer_start (loop, &mytimer);
1262		1283
1263	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
1264	inactivity.	1285	inactivity.
1265		1286
1266	static void	1287	static void
1267	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)
1268	{	1289	{
1269	.. ten seconds without any activity	1290	.. ten seconds without any activity
1270	}	1291	}
1271		1292
1272	struct ev_timer mytimer;	1293	struct ev_timer mytimer;
1273	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 */
1274	ev_timer_again (&mytimer); /* start timer */	1295	ev_timer_again (&mytimer); /* start timer */
1275	ev_loop (loop, 0);	1296	ev_loop (loop, 0);
1276		1297
1277	// 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":
1278	// reset the timeout to start ticking again at 10 seconds	1299	// reset the timeout to start ticking again at 10 seconds
1279	ev_timer_again (&mytimer);	1300	ev_timer_again (&mytimer);
1280		1301
1281		1302
1282	=head2 C<ev_periodic> - to cron or not to cron?	1303	=head2 C<ev_periodic> - to cron or not to cron?
1283		1304
1284	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
1285	(and unfortunately a bit complex).	1306	(and unfortunately a bit complex).
1286		1307
1287	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)
1288	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
1289	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
1290	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 ()
1291	+ 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
1292	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
1293	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
1294	roughly 10 seconds later as it uses a relative timeout).	1315	roughly 10 seconds later as it uses a relative timeout).
1295		1316
1296	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,
1297	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
1298	complicated, rules.	1319	complicated, rules.
1299		1320
1300	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
1301	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
1302	during the same loop iteration then order of execution is undefined.	1323	during the same loop iteration then order of execution is undefined.
1303		1324
1304	=head3 Watcher-Specific Functions and Data Members	1325	=head3 Watcher-Specific Functions and Data Members
1305		1326
…		…
1314		1335
1315	=over 4	1336	=over 4
1316		1337
1317	=item * absolute timer (at = time, interval = reschedule_cb = 0)	1338	=item * absolute timer (at = time, interval = reschedule_cb = 0)
1318		1339
1319	In this configuration the watcher triggers an event after the wallclock	1340	In this configuration the watcher triggers an event after the wall clock
1320	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
1321	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
1322	run when the system time reaches or surpasses this time.	1343	run when the system time reaches or surpasses this time.
1323		1344
1324	=item * repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)	1345	=item * repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)
…		…
1332	the hour:	1353	the hour:
1333		1354
1334	ev_periodic_set (&periodic, 0., 3600., 0);	1355	ev_periodic_set (&periodic, 0., 3600., 0);
1335		1356
1336	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,
1337	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
1338	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
1339	by 3600.	1360	by 3600.
1340		1361
1341	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
1342	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
…		…
1344		1365
1345	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
1346	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
1347	this value, and in fact is often specified as zero.	1368	this value, and in fact is often specified as zero.
1348		1369
1349	Note also that there is an upper limit to how often a timer can fire (cpu	1370	Note also that there is an upper limit to how often a timer can fire (CPU
1350	speed for example), so if C<interval> is very small then timing stability	1371	speed for example), so if C<interval> is very small then timing stability
1351	will of course detoriate. Libev itself tries to be exact to be about one	1372	will of course deteriorate. Libev itself tries to be exact to be about one
1352	millisecond (if the OS supports it and the machine is fast enough).	1373	millisecond (if the OS supports it and the machine is fast enough).
1353		1374
1354	=item * manual reschedule mode (at and interval ignored, reschedule_cb = callback)	1375	=item * manual reschedule mode (at and interval ignored, reschedule_cb = callback)
1355		1376
1356	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
…		…
1425		1446
1426	=head3 Examples	1447	=head3 Examples
1427		1448
1428	Example: Call a callback every hour, or, more precisely, whenever the	1449	Example: Call a callback every hour, or, more precisely, whenever the
1429	system clock is divisible by 3600. The callback invocation times have	1450	system clock is divisible by 3600. The callback invocation times have
1430	potentially a lot of jittering, but good long-term stability.	1451	potentially a lot of jitter, but good long-term stability.
1431		1452
1432	static void	1453	static void
1433	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)
1434	{	1455	{
1435	... 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)
1436	}	1457	}
1437		1458
1438	struct ev_periodic hourly_tick;	1459	struct ev_periodic hourly_tick;
1439	ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);	1460	ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);
1440	ev_periodic_start (loop, &hourly_tick);	1461	ev_periodic_start (loop, &hourly_tick);
1441		1462
1442	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:
1443		1464
1444	#include <math.h>	1465	#include <math.h>
1445		1466
1446	static ev_tstamp	1467	static ev_tstamp
1447	my_scheduler_cb (struct ev_periodic *w, ev_tstamp now)	1468	my_scheduler_cb (struct ev_periodic *w, ev_tstamp now)
1448	{	1469	{
1449	return fmod (now, 3600.) + 3600.;	1470	return fmod (now, 3600.) + 3600.;
1450	}	1471	}
1451		1472
1452	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);
1453		1474
1454	Example: Call a callback every hour, starting now:	1475	Example: Call a callback every hour, starting now:
1455		1476
1456	struct ev_periodic hourly_tick;	1477	struct ev_periodic hourly_tick;
1457	ev_periodic_init (&hourly_tick, clock_cb,	1478	ev_periodic_init (&hourly_tick, clock_cb,
1458	fmod (ev_now (loop), 3600.), 3600., 0);	1479	fmod (ev_now (loop), 3600.), 3600., 0);
1459	ev_periodic_start (loop, &hourly_tick);	1480	ev_periodic_start (loop, &hourly_tick);
1460		1481
1461		1482
1462	=head2 C<ev_signal> - signal me when a signal gets signalled!	1483	=head2 C<ev_signal> - signal me when a signal gets signalled!
1463		1484
1464	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
…		…
1472	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
1473	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
1474	SIG_DFL (regardless of what it was set to before).	1495	SIG_DFL (regardless of what it was set to before).
1475		1496
1476	If possible and supported, libev will install its handlers with	1497	If possible and supported, libev will install its handlers with
1477	C<SA_RESTART> behaviour enabled, so syscalls should not be unduly	1498	C<SA_RESTART> behaviour enabled, so system calls should not be unduly
1478	interrupted. If you have a problem with syscalls getting interrupted by	1499	interrupted. If you have a problem with system calls getting interrupted by
1479	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
1480	them in an C<ev_prepare> watcher.	1501	them in an C<ev_prepare> watcher.
1481		1502
1482	=head3 Watcher-Specific Functions and Data Members	1503	=head3 Watcher-Specific Functions and Data Members
1483		1504
…		…
1498		1519
1499	=head3 Examples	1520	=head3 Examples
1500		1521
1501	Example: Try to exit cleanly on SIGINT and SIGTERM.	1522	Example: Try to exit cleanly on SIGINT and SIGTERM.
1502		1523
1503	static void	1524	static void
1504	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)
1505	{	1526	{
1506	ev_unloop (loop, EVUNLOOP_ALL);	1527	ev_unloop (loop, EVUNLOOP_ALL);
1507	}	1528	}
1508		1529
1509	struct ev_signal signal_watcher;	1530	struct ev_signal signal_watcher;
1510	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);	1531	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
1511	ev_signal_start (loop, &sigint_cb);	1532	ev_signal_start (loop, &sigint_cb);
1512		1533
1513		1534
1514	=head2 C<ev_child> - watch out for process status changes	1535	=head2 C<ev_child> - watch out for process status changes
1515		1536
1516	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
…		…
1518	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
1519	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
1520	loop isn't entered (or is continued from a watcher).	1541	loop isn't entered (or is continued from a watcher).
1521		1542
1522	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
1523	you can only rgeister child watchers in the default event loop.	1544	you can only register child watchers in the default event loop.
1524		1545
1525	=head3 Process Interaction	1546	=head3 Process Interaction
1526		1547
1527	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
1528	initialised. This is necessary to guarantee proper behaviour even if	1549	initialised. This is necessary to guarantee proper behaviour even if
1529	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
1530	of C<SIGCHLD> is recorded asynchronously, but child reaping is done	1551	of C<SIGCHLD> is recorded asynchronously, but child reaping is done
1531	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
1532	children, even ones not watched.	1553	children, even ones not watched.
1533		1554
1534	=head3 Overriding the Built-In Processing	1555	=head3 Overriding the Built-In Processing
…		…
1576	=head3 Examples	1597	=head3 Examples
1577		1598
1578	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
1579	its completion.	1600	its completion.
1580		1601
1581	ev_child cw;	1602	ev_child cw;
1582		1603
1583	static void	1604	static void
1584	child_cb (EV_P_ struct ev_child *w, int revents)	1605	child_cb (EV_P_ struct ev_child *w, int revents)
1585	{	1606	{
1586	ev_child_stop (EV_A_ w);	1607	ev_child_stop (EV_A_ w);
1587	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);
1588	}	1609	}
1589		1610
1590	pid_t pid = fork ();	1611	pid_t pid = fork ();
1591		1612
1592	if (pid < 0)	1613	if (pid < 0)
1593	// error	1614	// error
1594	else if (pid == 0)	1615	else if (pid == 0)
1595	{	1616	{
1596	// the forked child executes here	1617	// the forked child executes here
1597	exit (1);	1618	exit (1);
1598	}	1619	}
1599	else	1620	else
1600	{	1621	{
1601	ev_child_init (&cw, child_cb, pid, 0);	1622	ev_child_init (&cw, child_cb, pid, 0);
1602	ev_child_start (EV_DEFAULT_ &cw);	1623	ev_child_start (EV_DEFAULT_ &cw);
1603	}	1624	}
1604		1625
1605		1626
1606	=head2 C<ev_stat> - did the file attributes just change?	1627	=head2 C<ev_stat> - did the file attributes just change?
1607		1628
1608	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
1609	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
1610	compared to the last time, invoking the callback if it did.	1631	compared to the last time, invoking the callback if it did.
1611		1632
1612	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
1613	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
…		…
1641	will be no polling.	1662	will be no polling.
1642		1663
1643	=head3 ABI Issues (Largefile Support)	1664	=head3 ABI Issues (Largefile Support)
1644		1665
1645	Libev by default (unless the user overrides this) uses the default	1666	Libev by default (unless the user overrides this) uses the default
1646	compilation environment, which means that on systems with optionally	1667	compilation environment, which means that on systems with large file
1647	disabled large file support, you get the 32 bit version of the stat	1668	support disabled by default, you get the 32 bit version of the stat
1648	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
1649	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
1650	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
1651	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
1652	most noticably with ev_stat and largefile support.	1673	most noticeably disabled with ev_stat and large file support.
		1674
		1675	The solution for this is to lobby your distribution maker to make large
		1676	file interfaces available by default (as e.g. FreeBSD does) and not
		1677	optional. Libev cannot simply switch on large file support because it has
		1678	to exchange stat structures with application programs compiled using the
		1679	default compilation environment.
1653		1680
1654	=head3 Inotify	1681	=head3 Inotify
1655		1682
1656	When C<inotify (7)> support has been compiled into libev (generally only	1683	When C<inotify (7)> support has been compiled into libev (generally only
1657	available on Linux) and present at runtime, it will be used to speed up	1684	available on Linux) and present at runtime, it will be used to speed up
…		…
1667	implement this functionality, due to the requirement of having a file	1694	implement this functionality, due to the requirement of having a file
1668	descriptor open on the object at all times).	1695	descriptor open on the object at all times).
1669		1696
1670	=head3 The special problem of stat time resolution	1697	=head3 The special problem of stat time resolution
1671		1698
1672	The C<stat ()> syscall only supports full-second resolution portably, and	1699	The C<stat ()> system call only supports full-second resolution portably, and
1673	even on systems where the resolution is higher, many filesystems still	1700	even on systems where the resolution is higher, many file systems still
1674	only support whole seconds.	1701	only support whole seconds.
1675		1702
1676	That means that, if the time is the only thing that changes, you can	1703	That means that, if the time is the only thing that changes, you can
1677	easily miss updates: on the first update, C<ev_stat> detects a change and	1704	easily miss updates: on the first update, C<ev_stat> detects a change and
1678	calls your callback, which does something. When there is another update	1705	calls your callback, which does something. When there is another update
…		…
1738		1765
1739	The specified interval.	1766	The specified interval.
1740		1767
1741	=item const char *path [read-only]	1768	=item const char *path [read-only]
1742		1769
1743	The filesystem path that is being watched.	1770	The file system path that is being watched.
1744		1771
1745	=back	1772	=back
1746		1773
1747	=head3 Examples	1774	=head3 Examples
1748		1775
1749	Example: Watch C</etc/passwd> for attribute changes.	1776	Example: Watch C</etc/passwd> for attribute changes.
1750		1777
1751	static void	1778	static void
1752	passwd_cb (struct ev_loop *loop, ev_stat *w, int revents)	1779	passwd_cb (struct ev_loop *loop, ev_stat *w, int revents)
1753	{	1780	{
1754	/* /etc/passwd changed in some way */	1781	/* /etc/passwd changed in some way */
1755	if (w->attr.st_nlink)	1782	if (w->attr.st_nlink)
1756	{	1783	{
1757	printf ("passwd current size %ld\n", (long)w->attr.st_size);	1784	printf ("passwd current size %ld\n", (long)w->attr.st_size);
1758	printf ("passwd current atime %ld\n", (long)w->attr.st_mtime);	1785	printf ("passwd current atime %ld\n", (long)w->attr.st_mtime);
1759	printf ("passwd current mtime %ld\n", (long)w->attr.st_mtime);	1786	printf ("passwd current mtime %ld\n", (long)w->attr.st_mtime);
1760	}	1787	}
1761	else	1788	else
1762	/* you shalt not abuse printf for puts */	1789	/* you shalt not abuse printf for puts */
1763	puts ("wow, /etc/passwd is not there, expect problems. "	1790	puts ("wow, /etc/passwd is not there, expect problems. "
1764	"if this is windows, they already arrived\n");	1791	"if this is windows, they already arrived\n");
1765	}	1792	}
1766		1793
1767	...	1794	...
1768	ev_stat passwd;	1795	ev_stat passwd;
1769		1796
1770	ev_stat_init (&passwd, passwd_cb, "/etc/passwd", 0.);	1797	ev_stat_init (&passwd, passwd_cb, "/etc/passwd", 0.);
1771	ev_stat_start (loop, &passwd);	1798	ev_stat_start (loop, &passwd);
1772		1799
1773	Example: Like above, but additionally use a one-second delay so we do not	1800	Example: Like above, but additionally use a one-second delay so we do not
1774	miss updates (however, frequent updates will delay processing, too, so	1801	miss updates (however, frequent updates will delay processing, too, so
1775	one might do the work both on C<ev_stat> callback invocation I<and> on	1802	one might do the work both on C<ev_stat> callback invocation I<and> on
1776	C<ev_timer> callback invocation).	1803	C<ev_timer> callback invocation).
1777		1804
1778	static ev_stat passwd;	1805	static ev_stat passwd;
1779	static ev_timer timer;	1806	static ev_timer timer;
1780		1807
1781	static void	1808	static void
1782	timer_cb (EV_P_ ev_timer *w, int revents)	1809	timer_cb (EV_P_ ev_timer *w, int revents)
1783	{	1810	{
1784	ev_timer_stop (EV_A_ w);	1811	ev_timer_stop (EV_A_ w);
1785		1812
1786	/* now it's one second after the most recent passwd change */	1813	/* now it's one second after the most recent passwd change */
1787	}	1814	}
1788		1815
1789	static void	1816	static void
1790	stat_cb (EV_P_ ev_stat *w, int revents)	1817	stat_cb (EV_P_ ev_stat *w, int revents)
1791	{	1818	{
1792	/* reset the one-second timer */	1819	/* reset the one-second timer */
1793	ev_timer_again (EV_A_ &timer);	1820	ev_timer_again (EV_A_ &timer);
1794	}	1821	}
1795		1822
1796	...	1823	...
1797	ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.);	1824	ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.);
1798	ev_stat_start (loop, &passwd);	1825	ev_stat_start (loop, &passwd);
1799	ev_timer_init (&timer, timer_cb, 0., 1.02);	1826	ev_timer_init (&timer, timer_cb, 0., 1.02);
1800		1827
1801		1828
1802	=head2 C<ev_idle> - when you've got nothing better to do...	1829	=head2 C<ev_idle> - when you've got nothing better to do...
1803		1830
1804	Idle watchers trigger events when no other events of the same or higher	1831	Idle watchers trigger events when no other events of the same or higher
…		…
1835	=head3 Examples	1862	=head3 Examples
1836		1863
1837	Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the	1864	Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the
1838	callback, free it. Also, use no error checking, as usual.	1865	callback, free it. Also, use no error checking, as usual.
1839		1866
1840	static void	1867	static void
1841	idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents)	1868	idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents)
1842	{	1869	{
1843	free (w);	1870	free (w);
1844	// now do something you wanted to do when the program has	1871	// now do something you wanted to do when the program has
1845	// no longer anything immediate to do.	1872	// no longer anything immediate to do.
1846	}	1873	}
1847		1874
1848	struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle));	1875	struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle));
1849	ev_idle_init (idle_watcher, idle_cb);	1876	ev_idle_init (idle_watcher, idle_cb);
1850	ev_idle_start (loop, idle_cb);	1877	ev_idle_start (loop, idle_cb);
1851		1878
1852		1879
1853	=head2 C<ev_prepare> and C<ev_check> - customise your event loop!	1880	=head2 C<ev_prepare> and C<ev_check> - customise your event loop!
1854		1881
1855	Prepare and check watchers are usually (but not always) used in tandem:	1882	Prepare and check watchers are usually (but not always) used in tandem:
…		…
1874		1901
1875	This is done by examining in each prepare call which file descriptors need	1902	This is done by examining in each prepare call which file descriptors need
1876	to be watched by the other library, registering C<ev_io> watchers for	1903	to be watched by the other library, registering C<ev_io> watchers for
1877	them and starting an C<ev_timer> watcher for any timeouts (many libraries	1904	them and starting an C<ev_timer> watcher for any timeouts (many libraries
1878	provide just this functionality). Then, in the check watcher you check for	1905	provide just this functionality). Then, in the check watcher you check for
1879	any events that occured (by checking the pending status of all watchers	1906	any events that occurred (by checking the pending status of all watchers
1880	and stopping them) and call back into the library. The I/O and timer	1907	and stopping them) and call back into the library. The I/O and timer
1881	callbacks will never actually be called (but must be valid nevertheless,	1908	callbacks will never actually be called (but must be valid nevertheless,
1882	because you never know, you know?).	1909	because you never know, you know?).
1883		1910
1884	As another example, the Perl Coro module uses these hooks to integrate	1911	As another example, the Perl Coro module uses these hooks to integrate
…		…
1927	and in a check watcher, destroy them and call into libadns. What follows	1954	and in a check watcher, destroy them and call into libadns. What follows
1928	is pseudo-code only of course. This requires you to either use a low	1955	is pseudo-code only of course. This requires you to either use a low
1929	priority for the check watcher or use C<ev_clear_pending> explicitly, as	1956	priority for the check watcher or use C<ev_clear_pending> explicitly, as
1930	the callbacks for the IO/timeout watchers might not have been called yet.	1957	the callbacks for the IO/timeout watchers might not have been called yet.
1931		1958
1932	static ev_io iow [nfd];	1959	static ev_io iow [nfd];
1933	static ev_timer tw;	1960	static ev_timer tw;
1934		1961
1935	static void	1962	static void
1936	io_cb (ev_loop *loop, ev_io *w, int revents)	1963	io_cb (ev_loop *loop, ev_io *w, int revents)
1937	{	1964	{
1938	}	1965	}
1939		1966
1940	// create io watchers for each fd and a timer before blocking	1967	// create io watchers for each fd and a timer before blocking
1941	static void	1968	static void
1942	adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents)	1969	adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents)
1943	{	1970	{
1944	int timeout = 3600000;	1971	int timeout = 3600000;
1945	struct pollfd fds [nfd];	1972	struct pollfd fds [nfd];
1946	// actual code will need to loop here and realloc etc.	1973	// actual code will need to loop here and realloc etc.
1947	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));	1974	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
1948		1975
1949	/* the callback is illegal, but won't be called as we stop during check */	1976	/* the callback is illegal, but won't be called as we stop during check */
1950	ev_timer_init (&tw, 0, timeout * 1e-3);	1977	ev_timer_init (&tw, 0, timeout * 1e-3);
1951	ev_timer_start (loop, &tw);	1978	ev_timer_start (loop, &tw);
1952		1979
1953	// create one ev_io per pollfd	1980	// create one ev_io per pollfd
1954	for (int i = 0; i < nfd; ++i)	1981	for (int i = 0; i < nfd; ++i)
1955	{	1982	{
1956	ev_io_init (iow + i, io_cb, fds [i].fd,	1983	ev_io_init (iow + i, io_cb, fds [i].fd,
1957	((fds [i].events & POLLIN ? EV_READ : 0)	1984	((fds [i].events & POLLIN ? EV_READ : 0)
1958	| (fds [i].events & POLLOUT ? EV_WRITE : 0)));	1985	| (fds [i].events & POLLOUT ? EV_WRITE : 0)));
1959		1986
1960	fds [i].revents = 0;	1987	fds [i].revents = 0;
1961	ev_io_start (loop, iow + i);	1988	ev_io_start (loop, iow + i);
1962	}	1989	}
1963	}	1990	}
1964		1991
1965	// stop all watchers after blocking	1992	// stop all watchers after blocking
1966	static void	1993	static void
1967	adns_check_cb (ev_loop *loop, ev_check *w, int revents)	1994	adns_check_cb (ev_loop *loop, ev_check *w, int revents)
1968	{	1995	{
1969	ev_timer_stop (loop, &tw);	1996	ev_timer_stop (loop, &tw);
1970		1997
1971	for (int i = 0; i < nfd; ++i)	1998	for (int i = 0; i < nfd; ++i)
1972	{	1999	{
1973	// set the relevant poll flags	2000	// set the relevant poll flags
1974	// could also call adns_processreadable etc. here	2001	// could also call adns_processreadable etc. here
1975	struct pollfd *fd = fds + i;	2002	struct pollfd *fd = fds + i;
1976	int revents = ev_clear_pending (iow + i);	2003	int revents = ev_clear_pending (iow + i);
1977	if (revents & EV_READ ) fd->revents |= fd->events & POLLIN;	2004	if (revents & EV_READ ) fd->revents |= fd->events & POLLIN;
1978	if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT;	2005	if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT;
1979		2006
1980	// now stop the watcher	2007	// now stop the watcher
1981	ev_io_stop (loop, iow + i);	2008	ev_io_stop (loop, iow + i);
1982	}	2009	}
1983		2010
1984	adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));	2011	adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));
1985	}	2012	}
1986		2013
1987	Method 2: This would be just like method 1, but you run C<adns_afterpoll>	2014	Method 2: This would be just like method 1, but you run C<adns_afterpoll>
1988	in the prepare watcher and would dispose of the check watcher.	2015	in the prepare watcher and would dispose of the check watcher.
1989		2016
1990	Method 3: If the module to be embedded supports explicit event	2017	Method 3: If the module to be embedded supports explicit event
1991	notification (adns does), you can also make use of the actual watcher	2018	notification (libadns does), you can also make use of the actual watcher
1992	callbacks, and only destroy/create the watchers in the prepare watcher.	2019	callbacks, and only destroy/create the watchers in the prepare watcher.
1993		2020
1994	static void	2021	static void
1995	timer_cb (EV_P_ ev_timer *w, int revents)	2022	timer_cb (EV_P_ ev_timer *w, int revents)
1996	{	2023	{
1997	adns_state ads = (adns_state)w->data;	2024	adns_state ads = (adns_state)w->data;
1998	update_now (EV_A);	2025	update_now (EV_A);
1999		2026
2000	adns_processtimeouts (ads, &tv_now);	2027	adns_processtimeouts (ads, &tv_now);
2001	}	2028	}
2002		2029
2003	static void	2030	static void
2004	io_cb (EV_P_ ev_io *w, int revents)	2031	io_cb (EV_P_ ev_io *w, int revents)
2005	{	2032	{
2006	adns_state ads = (adns_state)w->data;	2033	adns_state ads = (adns_state)w->data;
2007	update_now (EV_A);	2034	update_now (EV_A);
2008		2035
2009	if (revents & EV_READ ) adns_processreadable (ads, w->fd, &tv_now);	2036	if (revents & EV_READ ) adns_processreadable (ads, w->fd, &tv_now);
2010	if (revents & EV_WRITE) adns_processwriteable (ads, w->fd, &tv_now);	2037	if (revents & EV_WRITE) adns_processwriteable (ads, w->fd, &tv_now);
2011	}	2038	}
2012		2039
2013	// do not ever call adns_afterpoll	2040	// do not ever call adns_afterpoll
2014		2041
2015	Method 4: Do not use a prepare or check watcher because the module you	2042	Method 4: Do not use a prepare or check watcher because the module you
2016	want to embed is too inflexible to support it. Instead, youc na override	2043	want to embed is too inflexible to support it. Instead, you can override
2017	their poll function. The drawback with this solution is that the main	2044	their poll function. The drawback with this solution is that the main
2018	loop is now no longer controllable by EV. The C<Glib::EV> module does	2045	loop is now no longer controllable by EV. The C<Glib::EV> module does
2019	this.	2046	this.
2020		2047
2021	static gint	2048	static gint
2022	event_poll_func (GPollFD *fds, guint nfds, gint timeout)	2049	event_poll_func (GPollFD *fds, guint nfds, gint timeout)
2023	{	2050	{
2024	int got_events = 0;	2051	int got_events = 0;
2025		2052
2026	for (n = 0; n < nfds; ++n)	2053	for (n = 0; n < nfds; ++n)
2027	// create/start io watcher that sets the relevant bits in fds[n] and increment got_events	2054	// create/start io watcher that sets the relevant bits in fds[n] and increment got_events
2028		2055
2029	if (timeout >= 0)	2056	if (timeout >= 0)
2030	// create/start timer	2057	// create/start timer
2031		2058
2032	// poll	2059	// poll
2033	ev_loop (EV_A_ 0);	2060	ev_loop (EV_A_ 0);
2034		2061
2035	// stop timer again	2062	// stop timer again
2036	if (timeout >= 0)	2063	if (timeout >= 0)
2037	ev_timer_stop (EV_A_ &to);	2064	ev_timer_stop (EV_A_ &to);
2038		2065
2039	// stop io watchers again - their callbacks should have set	2066	// stop io watchers again - their callbacks should have set
2040	for (n = 0; n < nfds; ++n)	2067	for (n = 0; n < nfds; ++n)
2041	ev_io_stop (EV_A_ iow [n]);	2068	ev_io_stop (EV_A_ iow [n]);
2042		2069
2043	return got_events;	2070	return got_events;
2044	}	2071	}
2045		2072
2046		2073
2047	=head2 C<ev_embed> - when one backend isn't enough...	2074	=head2 C<ev_embed> - when one backend isn't enough...
2048		2075
2049	This is a rather advanced watcher type that lets you embed one event loop	2076	This is a rather advanced watcher type that lets you embed one event loop
…		…
2105		2132
2106	Configures the watcher to embed the given loop, which must be	2133	Configures the watcher to embed the given loop, which must be
2107	embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be	2134	embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be
2108	invoked automatically, otherwise it is the responsibility of the callback	2135	invoked automatically, otherwise it is the responsibility of the callback
2109	to invoke it (it will continue to be called until the sweep has been done,	2136	to invoke it (it will continue to be called until the sweep has been done,
2110	if you do not want thta, you need to temporarily stop the embed watcher).	2137	if you do not want that, you need to temporarily stop the embed watcher).
2111		2138
2112	=item ev_embed_sweep (loop, ev_embed *)	2139	=item ev_embed_sweep (loop, ev_embed *)
2113		2140
2114	Make a single, non-blocking sweep over the embedded loop. This works	2141	Make a single, non-blocking sweep over the embedded loop. This works
2115	similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most	2142	similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most
2116	apropriate way for embedded loops.	2143	appropriate way for embedded loops.
2117		2144
2118	=item struct ev_loop *other [read-only]	2145	=item struct ev_loop *other [read-only]
2119		2146
2120	The embedded event loop.	2147	The embedded event loop.
2121		2148
…		…
2123		2150
2124	=head3 Examples	2151	=head3 Examples
2125		2152
2126	Example: Try to get an embeddable event loop and embed it into the default	2153	Example: Try to get an embeddable event loop and embed it into the default
2127	event loop. If that is not possible, use the default loop. The default	2154	event loop. If that is not possible, use the default loop. The default
2128	loop is stored in C<loop_hi>, while the mebeddable loop is stored in	2155	loop is stored in C<loop_hi>, while the embeddable loop is stored in
2129	C<loop_lo> (which is C<loop_hi> in the acse no embeddable loop can be	2156	C<loop_lo> (which is C<loop_hi> in the case no embeddable loop can be
2130	used).	2157	used).
2131		2158
2132	struct ev_loop *loop_hi = ev_default_init (0);	2159	struct ev_loop *loop_hi = ev_default_init (0);
2133	struct ev_loop *loop_lo = 0;	2160	struct ev_loop *loop_lo = 0;
2134	struct ev_embed embed;	2161	struct ev_embed embed;
2135		2162
2136	// see if there is a chance of getting one that works	2163	// see if there is a chance of getting one that works
2137	// (remember that a flags value of 0 means autodetection)	2164	// (remember that a flags value of 0 means autodetection)
2138	loop_lo = ev_embeddable_backends () & ev_recommended_backends ()	2165	loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
2139	? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())	2166	? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
2140	: 0;	2167	: 0;
2141		2168
2142	// if we got one, then embed it, otherwise default to loop_hi	2169	// if we got one, then embed it, otherwise default to loop_hi
2143	if (loop_lo)	2170	if (loop_lo)
2144	{	2171	{
2145	ev_embed_init (&embed, 0, loop_lo);	2172	ev_embed_init (&embed, 0, loop_lo);
2146	ev_embed_start (loop_hi, &embed);	2173	ev_embed_start (loop_hi, &embed);
2147	}	2174	}
2148	else	2175	else
2149	loop_lo = loop_hi;	2176	loop_lo = loop_hi;
2150		2177
2151	Example: Check if kqueue is available but not recommended and create	2178	Example: Check if kqueue is available but not recommended and create
2152	a kqueue backend for use with sockets (which usually work with any	2179	a kqueue backend for use with sockets (which usually work with any
2153	kqueue implementation). Store the kqueue/socket-only event loop in	2180	kqueue implementation). Store the kqueue/socket-only event loop in
2154	C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).	2181	C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).
2155		2182
2156	struct ev_loop *loop = ev_default_init (0);	2183	struct ev_loop *loop = ev_default_init (0);
2157	struct ev_loop *loop_socket = 0;	2184	struct ev_loop *loop_socket = 0;
2158	struct ev_embed embed;	2185	struct ev_embed embed;
2159		2186
2160	if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)	2187	if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
2161	if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))	2188	if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
2162	{	2189	{
2163	ev_embed_init (&embed, 0, loop_socket);	2190	ev_embed_init (&embed, 0, loop_socket);
2164	ev_embed_start (loop, &embed);	2191	ev_embed_start (loop, &embed);
2165	}	2192	}
2166		2193
2167	if (!loop_socket)	2194	if (!loop_socket)
2168	loop_socket = loop;	2195	loop_socket = loop;
2169		2196
2170	// now use loop_socket for all sockets, and loop for everything else	2197	// now use loop_socket for all sockets, and loop for everything else
2171		2198
2172		2199
2173	=head2 C<ev_fork> - the audacity to resume the event loop after a fork	2200	=head2 C<ev_fork> - the audacity to resume the event loop after a fork
2174		2201
2175	Fork watchers are called when a C<fork ()> was detected (usually because	2202	Fork watchers are called when a C<fork ()> was detected (usually because
…		…
2228		2255
2229	=item queueing from a signal handler context	2256	=item queueing from a signal handler context
2230		2257
2231	To implement race-free queueing, you simply add to the queue in the signal	2258	To implement race-free queueing, you simply add to the queue in the signal
2232	handler but you block the signal handler in the watcher callback. Here is an example that does that for	2259	handler but you block the signal handler in the watcher callback. Here is an example that does that for
2233	some fictitiuous SIGUSR1 handler:	2260	some fictitious SIGUSR1 handler:
2234		2261
2235	static ev_async mysig;	2262	static ev_async mysig;
2236		2263
2237	static void	2264	static void
2238	sigusr1_handler (void)	2265	sigusr1_handler (void)
…		…
2312	=item ev_async_send (loop, ev_async *)	2339	=item ev_async_send (loop, ev_async *)
2313		2340
2314	Sends/signals/activates the given C<ev_async> watcher, that is, feeds	2341	Sends/signals/activates the given C<ev_async> watcher, that is, feeds
2315	an C<EV_ASYNC> event on the watcher into the event loop. Unlike	2342	an C<EV_ASYNC> event on the watcher into the event loop. Unlike
2316	C<ev_feed_event>, this call is safe to do in other threads, signal or	2343	C<ev_feed_event>, this call is safe to do in other threads, signal or
2317	similar contexts (see the dicusssion of C<EV_ATOMIC_T> in the embedding	2344	similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding
2318	section below on what exactly this means).	2345	section below on what exactly this means).
2319		2346
2320	This call incurs the overhead of a syscall only once per loop iteration,	2347	This call incurs the overhead of a system call only once per loop iteration,
2321	so while the overhead might be noticable, it doesn't apply to repeated	2348	so while the overhead might be noticeable, it doesn't apply to repeated
2322	calls to C<ev_async_send>.	2349	calls to C<ev_async_send>.
2323		2350
2324	=item bool = ev_async_pending (ev_async *)	2351	=item bool = ev_async_pending (ev_async *)
2325		2352
2326	Returns a non-zero value when C<ev_async_send> has been called on the	2353	Returns a non-zero value when C<ev_async_send> has been called on the
…		…
2328	event loop.	2355	event loop.
2329		2356
2330	C<ev_async_send> sets a flag in the watcher and wakes up the loop. When	2357	C<ev_async_send> sets a flag in the watcher and wakes up the loop. When
2331	the loop iterates next and checks for the watcher to have become active,	2358	the loop iterates next and checks for the watcher to have become active,
2332	it will reset the flag again. C<ev_async_pending> can be used to very	2359	it will reset the flag again. C<ev_async_pending> can be used to very
2333	quickly check wether invoking the loop might be a good idea.	2360	quickly check whether invoking the loop might be a good idea.
2334		2361
2335	Not that this does I<not> check wether the watcher itself is pending, only	2362	Not that this does I<not> check whether the watcher itself is pending, only
2336	wether it has been requested to make this watcher pending.	2363	whether it has been requested to make this watcher pending.
2337		2364
2338	=back	2365	=back
2339		2366
2340		2367
2341	=head1 OTHER FUNCTIONS	2368	=head1 OTHER FUNCTIONS
…		…
2352	or timeout without having to allocate/configure/start/stop/free one or	2379	or timeout without having to allocate/configure/start/stop/free one or
2353	more watchers yourself.	2380	more watchers yourself.
2354		2381
2355	If C<fd> is less than 0, then no I/O watcher will be started and events	2382	If C<fd> is less than 0, then no I/O watcher will be started and events
2356	is being ignored. Otherwise, an C<ev_io> watcher for the given C<fd> and	2383	is being ignored. Otherwise, an C<ev_io> watcher for the given C<fd> and
2357	C<events> set will be craeted and started.	2384	C<events> set will be created and started.
2358		2385
2359	If C<timeout> is less than 0, then no timeout watcher will be	2386	If C<timeout> is less than 0, then no timeout watcher will be
2360	started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and	2387	started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and
2361	repeat = 0) will be started. While C<0> is a valid timeout, it is of	2388	repeat = 0) will be started. While C<0> is a valid timeout, it is of
2362	dubious value.	2389	dubious value.
…		…
2364	The callback has the type C<void (*cb)(int revents, void *arg)> and gets	2391	The callback has the type C<void (*cb)(int revents, void *arg)> and gets
2365	passed an C<revents> set like normal event callbacks (a combination of	2392	passed an C<revents> set like normal event callbacks (a combination of
2366	C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg>	2393	C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg>
2367	value passed to C<ev_once>:	2394	value passed to C<ev_once>:
2368		2395
2369	static void stdin_ready (int revents, void *arg)	2396	static void stdin_ready (int revents, void *arg)
2370	{	2397	{
2371	if (revents & EV_TIMEOUT)	2398	if (revents & EV_TIMEOUT)
2372	/* doh, nothing entered */;	2399	/* doh, nothing entered */;
2373	else if (revents & EV_READ)	2400	else if (revents & EV_READ)
2374	/* stdin might have data for us, joy! */;	2401	/* stdin might have data for us, joy! */;
2375	}	2402	}
2376		2403
2377	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);	2404	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
2378		2405
2379	=item ev_feed_event (ev_loop *, watcher *, int revents)	2406	=item ev_feed_event (ev_loop *, watcher *, int revents)
2380		2407
2381	Feeds the given event set into the event loop, as if the specified event	2408	Feeds the given event set into the event loop, as if the specified event
2382	had happened for the specified watcher (which must be a pointer to an	2409	had happened for the specified watcher (which must be a pointer to an
…		…
2387	Feed an event on the given fd, as if a file descriptor backend detected	2414	Feed an event on the given fd, as if a file descriptor backend detected
2388	the given events it.	2415	the given events it.
2389		2416
2390	=item ev_feed_signal_event (ev_loop *loop, int signum)	2417	=item ev_feed_signal_event (ev_loop *loop, int signum)
2391		2418
2392	Feed an event as if the given signal occured (C<loop> must be the default	2419	Feed an event as if the given signal occurred (C<loop> must be the default
2393	loop!).	2420	loop!).
2394		2421
2395	=back	2422	=back
2396		2423
2397		2424
…		…
2426	=back	2453	=back
2427		2454
2428	=head1 C++ SUPPORT	2455	=head1 C++ SUPPORT
2429		2456
2430	Libev comes with some simplistic wrapper classes for C++ that mainly allow	2457	Libev comes with some simplistic wrapper classes for C++ that mainly allow
2431	you to use some convinience methods to start/stop watchers and also change	2458	you to use some convenience methods to start/stop watchers and also change
2432	the callback model to a model using method callbacks on objects.	2459	the callback model to a model using method callbacks on objects.
2433		2460
2434	To use it,	2461	To use it,
2435		2462
2436	#include <ev++.h>	2463	#include <ev++.h>
2437		2464
2438	This automatically includes F<ev.h> and puts all of its definitions (many	2465	This automatically includes F<ev.h> and puts all of its definitions (many
2439	of them macros) into the global namespace. All C++ specific things are	2466	of them macros) into the global namespace. All C++ specific things are
2440	put into the C<ev> namespace. It should support all the same embedding	2467	put into the C<ev> namespace. It should support all the same embedding
2441	options as F<ev.h>, most notably C<EV_MULTIPLICITY>.	2468	options as F<ev.h>, most notably C<EV_MULTIPLICITY>.
…		…
2508	your compiler is good :), then the method will be fully inlined into the	2535	your compiler is good :), then the method will be fully inlined into the
2509	thunking function, making it as fast as a direct C callback.	2536	thunking function, making it as fast as a direct C callback.
2510		2537
2511	Example: simple class declaration and watcher initialisation	2538	Example: simple class declaration and watcher initialisation
2512		2539
2513	struct myclass	2540	struct myclass
2514	{	2541	{
2515	void io_cb (ev::io &w, int revents) { }	2542	void io_cb (ev::io &w, int revents) { }
2516	}	2543	}
2517		2544
2518	myclass obj;	2545	myclass obj;
2519	ev::io iow;	2546	ev::io iow;
2520	iow.set <myclass, &myclass::io_cb> (&obj);	2547	iow.set <myclass, &myclass::io_cb> (&obj);
2521		2548
2522	=item w->set<function> (void *data = 0)	2549	=item w->set<function> (void *data = 0)
2523		2550
2524	Also sets a callback, but uses a static method or plain function as	2551	Also sets a callback, but uses a static method or plain function as
2525	callback. The optional C<data> argument will be stored in the watcher's	2552	callback. The optional C<data> argument will be stored in the watcher's
…		…
2529		2556
2530	See the method-C<set> above for more details.	2557	See the method-C<set> above for more details.
2531		2558
2532	Example:	2559	Example:
2533		2560
2534	static void io_cb (ev::io &w, int revents) { }	2561	static void io_cb (ev::io &w, int revents) { }
2535	iow.set <io_cb> ();	2562	iow.set <io_cb> ();
2536		2563
2537	=item w->set (struct ev_loop *)	2564	=item w->set (struct ev_loop *)
2538		2565
2539	Associates a different C<struct ev_loop> with this watcher. You can only	2566	Associates a different C<struct ev_loop> with this watcher. You can only
2540	do this when the watcher is inactive (and not pending either).	2567	do this when the watcher is inactive (and not pending either).
2541		2568
2542	=item w->set ([args])	2569	=item w->set ([arguments])
2543		2570
2544	Basically the same as C<ev_TYPE_set>, with the same args. Must be	2571	Basically the same as C<ev_TYPE_set>, with the same arguments. Must be
2545	called at least once. Unlike the C counterpart, an active watcher gets	2572	called at least once. Unlike the C counterpart, an active watcher gets
2546	automatically stopped and restarted when reconfiguring it with this	2573	automatically stopped and restarted when reconfiguring it with this
2547	method.	2574	method.
2548		2575
2549	=item w->start ()	2576	=item w->start ()
…		…
2573	=back	2600	=back
2574		2601
2575	Example: Define a class with an IO and idle watcher, start one of them in	2602	Example: Define a class with an IO and idle watcher, start one of them in
2576	the constructor.	2603	the constructor.
2577		2604
2578	class myclass	2605	class myclass
2579	{	2606	{
2580	ev::io io; void io_cb (ev::io &w, int revents);	2607	ev::io io; void io_cb (ev::io &w, int revents);
2581	ev:idle idle void idle_cb (ev::idle &w, int revents);	2608	ev:idle idle void idle_cb (ev::idle &w, int revents);
2582		2609
2583	myclass (int fd)	2610	myclass (int fd)
2584	{	2611	{
2585	io .set <myclass, &myclass::io_cb > (this);	2612	io .set <myclass, &myclass::io_cb > (this);
2586	idle.set <myclass, &myclass::idle_cb> (this);	2613	idle.set <myclass, &myclass::idle_cb> (this);
2587		2614
2588	io.start (fd, ev::READ);	2615	io.start (fd, ev::READ);
2589	}	2616	}
2590	};	2617	};
2591		2618
2592		2619
2593	=head1 OTHER LANGUAGE BINDINGS	2620	=head1 OTHER LANGUAGE BINDINGS
2594		2621
2595	Libev does not offer other language bindings itself, but bindings for a	2622	Libev does not offer other language bindings itself, but bindings for a
2596	numbe rof languages exist in the form of third-party packages. If you know	2623	number of languages exist in the form of third-party packages. If you know
2597	any interesting language binding in addition to the ones listed here, drop	2624	any interesting language binding in addition to the ones listed here, drop
2598	me a note.	2625	me a note.
2599		2626
2600	=over 4	2627	=over 4
2601		2628
…		…
2605	libev. EV is developed together with libev. Apart from the EV core module,	2632	libev. EV is developed together with libev. Apart from the EV core module,
2606	there are additional modules that implement libev-compatible interfaces	2633	there are additional modules that implement libev-compatible interfaces
2607	to C<libadns> (C<EV::ADNS>), C<Net::SNMP> (C<Net::SNMP::EV>) and the	2634	to C<libadns> (C<EV::ADNS>), C<Net::SNMP> (C<Net::SNMP::EV>) and the
2608	C<libglib> event core (C<Glib::EV> and C<EV::Glib>).	2635	C<libglib> event core (C<Glib::EV> and C<EV::Glib>).
2609		2636
2610	It can be found and installed via CPAN, its homepage is found at	2637	It can be found and installed via CPAN, its homepage is at
2611	L<http://software.schmorp.de/pkg/EV>.	2638	L<http://software.schmorp.de/pkg/EV>.
2612		2639
		2640	=item Python
		2641
		2642	Python bindings can be found at L<http://code.google.com/p/pyev/>. It
		2643	seems to be quite complete and well-documented. Note, however, that the
		2644	patch they require for libev is outright dangerous as it breaks the ABI
		2645	for everybody else, and therefore, should never be applied in an installed
		2646	libev (if python requires an incompatible ABI then it needs to embed
		2647	libev).
		2648
2613	=item Ruby	2649	=item Ruby
2614		2650
2615	Tony Arcieri has written a ruby extension that offers access to a subset	2651	Tony Arcieri has written a ruby extension that offers access to a subset
2616	of the libev API and adds filehandle abstractions, asynchronous DNS and	2652	of the libev API and adds file handle abstractions, asynchronous DNS and
2617	more on top of it. It can be found via gem servers. Its homepage is at	2653	more on top of it. It can be found via gem servers. Its homepage is at
2618	L<http://rev.rubyforge.org/>.	2654	L<http://rev.rubyforge.org/>.
2619		2655
2620	=item D	2656	=item D
2621		2657
…		…
2625	=back	2661	=back
2626		2662
2627		2663
2628	=head1 MACRO MAGIC	2664	=head1 MACRO MAGIC
2629		2665
2630	Libev can be compiled with a variety of options, the most fundamantal	2666	Libev can be compiled with a variety of options, the most fundamental
2631	of which is C<EV_MULTIPLICITY>. This option determines whether (most)	2667	of which is C<EV_MULTIPLICITY>. This option determines whether (most)
2632	functions and callbacks have an initial C<struct ev_loop *> argument.	2668	functions and callbacks have an initial C<struct ev_loop *> argument.
2633		2669
2634	To make it easier to write programs that cope with either variant, the	2670	To make it easier to write programs that cope with either variant, the
2635	following macros are defined:	2671	following macros are defined:
…		…
2640		2676
2641	This provides the loop I<argument> for functions, if one is required ("ev	2677	This provides the loop I<argument> for functions, if one is required ("ev
2642	loop argument"). The C<EV_A> form is used when this is the sole argument,	2678	loop argument"). The C<EV_A> form is used when this is the sole argument,
2643	C<EV_A_> is used when other arguments are following. Example:	2679	C<EV_A_> is used when other arguments are following. Example:
2644		2680
2645	ev_unref (EV_A);	2681	ev_unref (EV_A);
2646	ev_timer_add (EV_A_ watcher);	2682	ev_timer_add (EV_A_ watcher);
2647	ev_loop (EV_A_ 0);	2683	ev_loop (EV_A_ 0);
2648		2684
2649	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,	2685	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,
2650	which is often provided by the following macro.	2686	which is often provided by the following macro.
2651		2687
2652	=item C<EV_P>, C<EV_P_>	2688	=item C<EV_P>, C<EV_P_>
2653		2689
2654	This provides the loop I<parameter> for functions, if one is required ("ev	2690	This provides the loop I<parameter> for functions, if one is required ("ev
2655	loop parameter"). The C<EV_P> form is used when this is the sole parameter,	2691	loop parameter"). The C<EV_P> form is used when this is the sole parameter,
2656	C<EV_P_> is used when other parameters are following. Example:	2692	C<EV_P_> is used when other parameters are following. Example:
2657		2693
2658	// this is how ev_unref is being declared	2694	// this is how ev_unref is being declared
2659	static void ev_unref (EV_P);	2695	static void ev_unref (EV_P);
2660		2696
2661	// this is how you can declare your typical callback	2697	// this is how you can declare your typical callback
2662	static void cb (EV_P_ ev_timer *w, int revents)	2698	static void cb (EV_P_ ev_timer *w, int revents)
2663		2699
2664	It declares a parameter C<loop> of type C<struct ev_loop *>, quite	2700	It declares a parameter C<loop> of type C<struct ev_loop *>, quite
2665	suitable for use with C<EV_A>.	2701	suitable for use with C<EV_A>.
2666		2702
2667	=item C<EV_DEFAULT>, C<EV_DEFAULT_>	2703	=item C<EV_DEFAULT>, C<EV_DEFAULT_>
…		…
2683		2719
2684	Example: Declare and initialise a check watcher, utilising the above	2720	Example: Declare and initialise a check watcher, utilising the above
2685	macros so it will work regardless of whether multiple loops are supported	2721	macros so it will work regardless of whether multiple loops are supported
2686	or not.	2722	or not.
2687		2723
2688	static void	2724	static void
2689	check_cb (EV_P_ ev_timer *w, int revents)	2725	check_cb (EV_P_ ev_timer *w, int revents)
2690	{	2726	{
2691	ev_check_stop (EV_A_ w);	2727	ev_check_stop (EV_A_ w);
2692	}	2728	}
2693		2729
2694	ev_check check;	2730	ev_check check;
2695	ev_check_init (&check, check_cb);	2731	ev_check_init (&check, check_cb);
2696	ev_check_start (EV_DEFAULT_ &check);	2732	ev_check_start (EV_DEFAULT_ &check);
2697	ev_loop (EV_DEFAULT_ 0);	2733	ev_loop (EV_DEFAULT_ 0);
2698		2734
2699	=head1 EMBEDDING	2735	=head1 EMBEDDING
2700		2736
2701	Libev can (and often is) directly embedded into host	2737	Libev can (and often is) directly embedded into host
2702	applications. Examples of applications that embed it include the Deliantra	2738	applications. Examples of applications that embed it include the Deliantra
…		…
2709	libev somewhere in your source tree).	2745	libev somewhere in your source tree).
2710		2746
2711	=head2 FILESETS	2747	=head2 FILESETS
2712		2748
2713	Depending on what features you need you need to include one or more sets of files	2749	Depending on what features you need you need to include one or more sets of files
2714	in your app.	2750	in your application.
2715		2751
2716	=head3 CORE EVENT LOOP	2752	=head3 CORE EVENT LOOP
2717		2753
2718	To include only the libev core (all the C<ev_*> functions), with manual	2754	To include only the libev core (all the C<ev_*> functions), with manual
2719	configuration (no autoconf):	2755	configuration (no autoconf):
2720		2756
2721	#define EV_STANDALONE 1	2757	#define EV_STANDALONE 1
2722	#include "ev.c"	2758	#include "ev.c"
2723		2759
2724	This will automatically include F<ev.h>, too, and should be done in a	2760	This will automatically include F<ev.h>, too, and should be done in a
2725	single C source file only to provide the function implementations. To use	2761	single C source file only to provide the function implementations. To use
2726	it, do the same for F<ev.h> in all files wishing to use this API (best	2762	it, do the same for F<ev.h> in all files wishing to use this API (best
2727	done by writing a wrapper around F<ev.h> that you can include instead and	2763	done by writing a wrapper around F<ev.h> that you can include instead and
2728	where you can put other configuration options):	2764	where you can put other configuration options):
2729		2765
2730	#define EV_STANDALONE 1	2766	#define EV_STANDALONE 1
2731	#include "ev.h"	2767	#include "ev.h"
2732		2768
2733	Both header files and implementation files can be compiled with a C++	2769	Both header files and implementation files can be compiled with a C++
2734	compiler (at least, thats a stated goal, and breakage will be treated	2770	compiler (at least, thats a stated goal, and breakage will be treated
2735	as a bug).	2771	as a bug).
2736		2772
2737	You need the following files in your source tree, or in a directory	2773	You need the following files in your source tree, or in a directory
2738	in your include path (e.g. in libev/ when using -Ilibev):	2774	in your include path (e.g. in libev/ when using -Ilibev):
2739		2775
2740	ev.h	2776	ev.h
2741	ev.c	2777	ev.c
2742	ev_vars.h	2778	ev_vars.h
2743	ev_wrap.h	2779	ev_wrap.h
2744		2780
2745	ev_win32.c required on win32 platforms only	2781	ev_win32.c required on win32 platforms only
2746		2782
2747	ev_select.c only when select backend is enabled (which is enabled by default)	2783	ev_select.c only when select backend is enabled (which is enabled by default)
2748	ev_poll.c only when poll backend is enabled (disabled by default)	2784	ev_poll.c only when poll backend is enabled (disabled by default)
2749	ev_epoll.c only when the epoll backend is enabled (disabled by default)	2785	ev_epoll.c only when the epoll backend is enabled (disabled by default)
2750	ev_kqueue.c only when the kqueue backend is enabled (disabled by default)	2786	ev_kqueue.c only when the kqueue backend is enabled (disabled by default)
2751	ev_port.c only when the solaris port backend is enabled (disabled by default)	2787	ev_port.c only when the solaris port backend is enabled (disabled by default)
2752		2788
2753	F<ev.c> includes the backend files directly when enabled, so you only need	2789	F<ev.c> includes the backend files directly when enabled, so you only need
2754	to compile this single file.	2790	to compile this single file.
2755		2791
2756	=head3 LIBEVENT COMPATIBILITY API	2792	=head3 LIBEVENT COMPATIBILITY API
2757		2793
2758	To include the libevent compatibility API, also include:	2794	To include the libevent compatibility API, also include:
2759		2795
2760	#include "event.c"	2796	#include "event.c"
2761		2797
2762	in the file including F<ev.c>, and:	2798	in the file including F<ev.c>, and:
2763		2799
2764	#include "event.h"	2800	#include "event.h"
2765		2801
2766	in the files that want to use the libevent API. This also includes F<ev.h>.	2802	in the files that want to use the libevent API. This also includes F<ev.h>.
2767		2803
2768	You need the following additional files for this:	2804	You need the following additional files for this:
2769		2805
2770	event.h	2806	event.h
2771	event.c	2807	event.c
2772		2808
2773	=head3 AUTOCONF SUPPORT	2809	=head3 AUTOCONF SUPPORT
2774		2810
2775	Instead of using C<EV_STANDALONE=1> and providing your config in	2811	Instead of using C<EV_STANDALONE=1> and providing your configuration in
2776	whatever way you want, you can also C<m4_include([libev.m4])> in your	2812	whatever way you want, you can also C<m4_include([libev.m4])> in your
2777	F<configure.ac> and leave C<EV_STANDALONE> undefined. F<ev.c> will then	2813	F<configure.ac> and leave C<EV_STANDALONE> undefined. F<ev.c> will then
2778	include F<config.h> and configure itself accordingly.	2814	include F<config.h> and configure itself accordingly.
2779		2815
2780	For this of course you need the m4 file:	2816	For this of course you need the m4 file:
2781		2817
2782	libev.m4	2818	libev.m4
2783		2819
2784	=head2 PREPROCESSOR SYMBOLS/MACROS	2820	=head2 PREPROCESSOR SYMBOLS/MACROS
2785		2821
2786	Libev can be configured via a variety of preprocessor symbols you have to	2822	Libev can be configured via a variety of preprocessor symbols you have to
2787	define before including any of its files. The default in the absense of	2823	define before including any of its files. The default in the absence of
2788	autoconf is noted for every option.	2824	autoconf is noted for every option.
2789		2825
2790	=over 4	2826	=over 4
2791		2827
2792	=item EV_STANDALONE	2828	=item EV_STANDALONE
…		…
2798	F<event.h> that are not directly supported by the libev core alone.	2834	F<event.h> that are not directly supported by the libev core alone.
2799		2835
2800	=item EV_USE_MONOTONIC	2836	=item EV_USE_MONOTONIC
2801		2837
2802	If defined to be C<1>, libev will try to detect the availability of the	2838	If defined to be C<1>, libev will try to detect the availability of the
2803	monotonic clock option at both compiletime and runtime. Otherwise no use	2839	monotonic clock option at both compile time and runtime. Otherwise no use
2804	of the monotonic clock option will be attempted. If you enable this, you	2840	of the monotonic clock option will be attempted. If you enable this, you
2805	usually have to link against librt or something similar. Enabling it when	2841	usually have to link against librt or something similar. Enabling it when
2806	the functionality isn't available is safe, though, although you have	2842	the functionality isn't available is safe, though, although you have
2807	to make sure you link against any libraries where the C<clock_gettime>	2843	to make sure you link against any libraries where the C<clock_gettime>
2808	function is hiding in (often F<-lrt>).	2844	function is hiding in (often F<-lrt>).
2809		2845
2810	=item EV_USE_REALTIME	2846	=item EV_USE_REALTIME
2811		2847
2812	If defined to be C<1>, libev will try to detect the availability of the	2848	If defined to be C<1>, libev will try to detect the availability of the
2813	realtime clock option at compiletime (and assume its availability at	2849	real-time clock option at compile time (and assume its availability at
2814	runtime if successful). Otherwise no use of the realtime clock option will	2850	runtime if successful). Otherwise no use of the real-time clock option will
2815	be attempted. This effectively replaces C<gettimeofday> by C<clock_get	2851	be attempted. This effectively replaces C<gettimeofday> by C<clock_get
2816	(CLOCK_REALTIME, ...)> and will not normally affect correctness. See the	2852	(CLOCK_REALTIME, ...)> and will not normally affect correctness. See the
2817	note about libraries in the description of C<EV_USE_MONOTONIC>, though.	2853	note about libraries in the description of C<EV_USE_MONOTONIC>, though.
2818		2854
2819	=item EV_USE_NANOSLEEP	2855	=item EV_USE_NANOSLEEP
…		…
2830	2.7 or newer, otherwise disabled.	2866	2.7 or newer, otherwise disabled.
2831		2867
2832	=item EV_USE_SELECT	2868	=item EV_USE_SELECT
2833		2869
2834	If undefined or defined to be C<1>, libev will compile in support for the	2870	If undefined or defined to be C<1>, libev will compile in support for the
2835	C<select>(2) backend. No attempt at autodetection will be done: if no	2871	C<select>(2) backend. No attempt at auto-detection will be done: if no
2836	other method takes over, select will be it. Otherwise the select backend	2872	other method takes over, select will be it. Otherwise the select backend
2837	will not be compiled in.	2873	will not be compiled in.
2838		2874
2839	=item EV_SELECT_USE_FD_SET	2875	=item EV_SELECT_USE_FD_SET
2840		2876
2841	If defined to C<1>, then the select backend will use the system C<fd_set>	2877	If defined to C<1>, then the select backend will use the system C<fd_set>
2842	structure. This is useful if libev doesn't compile due to a missing	2878	structure. This is useful if libev doesn't compile due to a missing
2843	C<NFDBITS> or C<fd_mask> definition or it misguesses the bitset layout on	2879	C<NFDBITS> or C<fd_mask> definition or it mis-guesses the bitset layout on
2844	exotic systems. This usually limits the range of file descriptors to some	2880	exotic systems. This usually limits the range of file descriptors to some
2845	low limit such as 1024 or might have other limitations (winsocket only	2881	low limit such as 1024 or might have other limitations (winsocket only
2846	allows 64 sockets). The C<FD_SETSIZE> macro, set before compilation, might	2882	allows 64 sockets). The C<FD_SETSIZE> macro, set before compilation, might
2847	influence the size of the C<fd_set> used.	2883	influence the size of the C<fd_set> used.
2848		2884
…		…
2897	otherwise another method will be used as fallback. This is the preferred	2933	otherwise another method will be used as fallback. This is the preferred
2898	backend for Solaris 10 systems.	2934	backend for Solaris 10 systems.
2899		2935
2900	=item EV_USE_DEVPOLL	2936	=item EV_USE_DEVPOLL
2901		2937
2902	reserved for future expansion, works like the USE symbols above.	2938	Reserved for future expansion, works like the USE symbols above.
2903		2939
2904	=item EV_USE_INOTIFY	2940	=item EV_USE_INOTIFY
2905		2941
2906	If defined to be C<1>, libev will compile in support for the Linux inotify	2942	If defined to be C<1>, libev will compile in support for the Linux inotify
2907	interface to speed up C<ev_stat> watchers. Its actual availability will	2943	interface to speed up C<ev_stat> watchers. Its actual availability will
…		…
2914	access is atomic with respect to other threads or signal contexts. No such	2950	access is atomic with respect to other threads or signal contexts. No such
2915	type is easily found in the C language, so you can provide your own type	2951	type is easily found in the C language, so you can provide your own type
2916	that you know is safe for your purposes. It is used both for signal handler "locking"	2952	that you know is safe for your purposes. It is used both for signal handler "locking"
2917	as well as for signal and thread safety in C<ev_async> watchers.	2953	as well as for signal and thread safety in C<ev_async> watchers.
2918		2954
2919	In the absense of this define, libev will use C<sig_atomic_t volatile>	2955	In the absence of this define, libev will use C<sig_atomic_t volatile>
2920	(from F<signal.h>), which is usually good enough on most platforms.	2956	(from F<signal.h>), which is usually good enough on most platforms.
2921		2957
2922	=item EV_H	2958	=item EV_H
2923		2959
2924	The name of the F<ev.h> header file used to include it. The default if	2960	The name of the F<ev.h> header file used to include it. The default if
…		…
2963	When doing priority-based operations, libev usually has to linearly search	2999	When doing priority-based operations, libev usually has to linearly search
2964	all the priorities, so having many of them (hundreds) uses a lot of space	3000	all the priorities, so having many of them (hundreds) uses a lot of space
2965	and time, so using the defaults of five priorities (-2 .. +2) is usually	3001	and time, so using the defaults of five priorities (-2 .. +2) is usually
2966	fine.	3002	fine.
2967		3003
2968	If your embedding app does not need any priorities, defining these both to	3004	If your embedding application does not need any priorities, defining these both to
2969	C<0> will save some memory and cpu.	3005	C<0> will save some memory and CPU.
2970		3006
2971	=item EV_PERIODIC_ENABLE	3007	=item EV_PERIODIC_ENABLE
2972		3008
2973	If undefined or defined to be C<1>, then periodic timers are supported. If	3009	If undefined or defined to be C<1>, then periodic timers are supported. If
2974	defined to be C<0>, then they are not. Disabling them saves a few kB of	3010	defined to be C<0>, then they are not. Disabling them saves a few kB of
…		…
3002		3038
3003	=item EV_MINIMAL	3039	=item EV_MINIMAL
3004		3040
3005	If you need to shave off some kilobytes of code at the expense of some	3041	If you need to shave off some kilobytes of code at the expense of some
3006	speed, define this symbol to C<1>. Currently this is used to override some	3042	speed, define this symbol to C<1>. Currently this is used to override some
3007	inlining decisions, saves roughly 30% codesize of amd64. It also selects a	3043	inlining decisions, saves roughly 30% code size on amd64. It also selects a
3008	much smaller 2-heap for timer management over the default 4-heap.	3044	much smaller 2-heap for timer management over the default 4-heap.
3009		3045
3010	=item EV_PID_HASHSIZE	3046	=item EV_PID_HASHSIZE
3011		3047
3012	C<ev_child> watchers use a small hash table to distribute workload by	3048	C<ev_child> watchers use a small hash table to distribute workload by
…		…
3025	=item EV_USE_4HEAP	3061	=item EV_USE_4HEAP
3026		3062
3027	Heaps are not very cache-efficient. To improve the cache-efficiency of the	3063	Heaps are not very cache-efficient. To improve the cache-efficiency of the
3028	timer and periodics heap, libev uses a 4-heap when this symbol is defined	3064	timer and periodics heap, libev uses a 4-heap when this symbol is defined
3029	to C<1>. The 4-heap uses more complicated (longer) code but has	3065	to C<1>. The 4-heap uses more complicated (longer) code but has
3030	noticably faster performance with many (thousands) of watchers.	3066	noticeably faster performance with many (thousands) of watchers.
3031		3067
3032	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>	3068	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>
3033	(disabled).	3069	(disabled).
3034		3070
3035	=item EV_HEAP_CACHE_AT	3071	=item EV_HEAP_CACHE_AT
…		…
3037	Heaps are not very cache-efficient. To improve the cache-efficiency of the	3073	Heaps are not very cache-efficient. To improve the cache-efficiency of the
3038	timer and periodics heap, libev can cache the timestamp (I<at>) within	3074	timer and periodics heap, libev can cache the timestamp (I<at>) within
3039	the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>),	3075	the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>),
3040	which uses 8-12 bytes more per watcher and a few hundred bytes more code,	3076	which uses 8-12 bytes more per watcher and a few hundred bytes more code,
3041	but avoids random read accesses on heap changes. This improves performance	3077	but avoids random read accesses on heap changes. This improves performance
3042	noticably with with many (hundreds) of watchers.	3078	noticeably with with many (hundreds) of watchers.
3043		3079
3044	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>	3080	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>
3045	(disabled).	3081	(disabled).
3046		3082
3047	=item EV_VERIFY	3083	=item EV_VERIFY
…		…
3064	members. You have to define it each time you include one of the files,	3100	members. You have to define it each time you include one of the files,
3065	though, and it must be identical each time.	3101	though, and it must be identical each time.
3066		3102
3067	For example, the perl EV module uses something like this:	3103	For example, the perl EV module uses something like this:
3068		3104
3069	#define EV_COMMON \	3105	#define EV_COMMON \
3070	SV *self; /* contains this struct */ \	3106	SV *self; /* contains this struct */ \
3071	SV *cb_sv, *fh /* note no trailing ";" */	3107	SV *cb_sv, *fh /* note no trailing ";" */
3072		3108
3073	=item EV_CB_DECLARE (type)	3109	=item EV_CB_DECLARE (type)
3074		3110
3075	=item EV_CB_INVOKE (watcher, revents)	3111	=item EV_CB_INVOKE (watcher, revents)
3076		3112
…		…
3083	avoid the C<struct ev_loop *> as first argument in all cases, or to use	3119	avoid the C<struct ev_loop *> as first argument in all cases, or to use
3084	method calls instead of plain function calls in C++.	3120	method calls instead of plain function calls in C++.
3085		3121
3086	=head2 EXPORTED API SYMBOLS	3122	=head2 EXPORTED API SYMBOLS
3087		3123
3088	If you need to re-export the API (e.g. via a dll) and you need a list of	3124	If you need to re-export the API (e.g. via a DLL) and you need a list of
3089	exported symbols, you can use the provided F<Symbol.*> files which list	3125	exported symbols, you can use the provided F<Symbol.*> files which list
3090	all public symbols, one per line:	3126	all public symbols, one per line:
3091		3127
3092	Symbols.ev for libev proper	3128	Symbols.ev for libev proper
3093	Symbols.event for the libevent emulation	3129	Symbols.event for the libevent emulation
3094		3130
3095	This can also be used to rename all public symbols to avoid clashes with	3131	This can also be used to rename all public symbols to avoid clashes with
3096	multiple versions of libev linked together (which is obviously bad in	3132	multiple versions of libev linked together (which is obviously bad in
3097	itself, but sometimes it is inconvinient to avoid this).	3133	itself, but sometimes it is inconvenient to avoid this).
3098		3134
3099	A sed command like this will create wrapper C<#define>'s that you need to	3135	A sed command like this will create wrapper C<#define>'s that you need to
3100	include before including F<ev.h>:	3136	include before including F<ev.h>:
3101		3137
3102	<Symbols.ev sed -e "s/.*/#define & myprefix_&/" >wrap.h	3138	<Symbols.ev sed -e "s/.*/#define & myprefix_&/" >wrap.h
…		…
3119	file.	3155	file.
3120		3156
3121	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file	3157	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file
3122	that everybody includes and which overrides some configure choices:	3158	that everybody includes and which overrides some configure choices:
3123		3159
3124	#define EV_MINIMAL 1	3160	#define EV_MINIMAL 1
3125	#define EV_USE_POLL 0	3161	#define EV_USE_POLL 0
3126	#define EV_MULTIPLICITY 0	3162	#define EV_MULTIPLICITY 0
3127	#define EV_PERIODIC_ENABLE 0	3163	#define EV_PERIODIC_ENABLE 0
3128	#define EV_STAT_ENABLE 0	3164	#define EV_STAT_ENABLE 0
3129	#define EV_FORK_ENABLE 0	3165	#define EV_FORK_ENABLE 0
3130	#define EV_CONFIG_H <config.h>	3166	#define EV_CONFIG_H <config.h>
3131	#define EV_MINPRI 0	3167	#define EV_MINPRI 0
3132	#define EV_MAXPRI 0	3168	#define EV_MAXPRI 0
3133		3169
3134	#include "ev++.h"	3170	#include "ev++.h"
3135		3171
3136	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:	3172	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
3137		3173
3138	#include "ev_cpp.h"	3174	#include "ev_cpp.h"
3139	#include "ev.c"	3175	#include "ev.c"
3140		3176
3141		3177
3142	=head1 THREADS AND COROUTINES	3178	=head1 THREADS AND COROUTINES
3143		3179
3144	=head2 THREADS	3180	=head2 THREADS
3145		3181
3146	Libev itself is completely threadsafe, but it uses no locking. This	3182	Libev itself is completely thread-safe, but it uses no locking. This
3147	means that you can use as many loops as you want in parallel, as long as	3183	means that you can use as many loops as you want in parallel, as long as
3148	only one thread ever calls into one libev function with the same loop	3184	only one thread ever calls into one libev function with the same loop
3149	parameter.	3185	parameter.
3150		3186
3151	Or put differently: calls with different loop parameters can be done in	3187	Or put differently: calls with different loop parameters can be done in
…		…
3158	help you but by giving some generic advice:	3194	help you but by giving some generic advice:
3159		3195
3160	=over 4	3196	=over 4
3161		3197
3162	=item * most applications have a main thread: use the default libev loop	3198	=item * most applications have a main thread: use the default libev loop
3163	in that thread, or create a seperate thread running only the default loop.	3199	in that thread, or create a separate thread running only the default loop.
3164		3200
3165	This helps integrating other libraries or software modules that use libev	3201	This helps integrating other libraries or software modules that use libev
3166	themselves and don't care/know about threading.	3202	themselves and don't care/know about threading.
3167		3203
3168	=item * one loop per thread is usually a good model.	3204	=item * one loop per thread is usually a good model.
3169		3205
3170	Doing this is almost never wrong, sometimes a better-performance model	3206	Doing this is almost never wrong, sometimes a better-performance model
3171	exists, but it is always a good start.	3207	exists, but it is always a good start.
3172		3208
3173	=item * other models exist, such as the leader/follower pattern, where one	3209	=item * other models exist, such as the leader/follower pattern, where one
3174	loop is handed through multiple threads in a kind of round-robbin fashion.	3210	loop is handed through multiple threads in a kind of round-robin fashion.
3175		3211
3176	Chosing a model is hard - look around, learn, know that usually you cna do	3212	Choosing a model is hard - look around, learn, know that usually you can do
3177	better than you currently do :-)	3213	better than you currently do :-)
3178		3214
3179	=item * often you need to talk to some other thread which blocks in the	3215	=item * often you need to talk to some other thread which blocks in the
3180	event loop - C<ev_async> watchers can be used to wake them up from other	3216	event loop - C<ev_async> watchers can be used to wake them up from other
3181	threads safely (or from signal contexts...).	3217	threads safely (or from signal contexts...).
3182		3218
3183	=back	3219	=back
3184		3220
3185	=head2 COROUTINES	3221	=head2 COROUTINES
3186		3222
3187	Libev is much more accomodating to coroutines ("cooperative threads"):	3223	Libev is much more accommodating to coroutines ("cooperative threads"):
3188	libev fully supports nesting calls to it's functions from different	3224	libev fully supports nesting calls to it's functions from different
3189	coroutines (e.g. you can call C<ev_loop> on the same loop from two	3225	coroutines (e.g. you can call C<ev_loop> on the same loop from two
3190	different coroutines and switch freely between both coroutines running the	3226	different coroutines and switch freely between both coroutines running the
3191	loop, as long as you don't confuse yourself). The only exception is that	3227	loop, as long as you don't confuse yourself). The only exception is that
3192	you must not do this from C<ev_periodic> reschedule callbacks.	3228	you must not do this from C<ev_periodic> reschedule callbacks.
…		…
3240		3276
3241	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)	3277	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)
3242		3278
3243	A change means an I/O watcher gets started or stopped, which requires	3279	A change means an I/O watcher gets started or stopped, which requires
3244	libev to recalculate its status (and possibly tell the kernel, depending	3280	libev to recalculate its status (and possibly tell the kernel, depending
3245	on backend and wether C<ev_io_set> was used).	3281	on backend and whether C<ev_io_set> was used).
3246		3282
3247	=item Activating one watcher (putting it into the pending state): O(1)	3283	=item Activating one watcher (putting it into the pending state): O(1)
3248		3284
3249	=item Priority handling: O(number_of_priorities)	3285	=item Priority handling: O(number_of_priorities)
3250		3286
…		…
3257		3293
3258	=item Processing ev_async_send: O(number_of_async_watchers)	3294	=item Processing ev_async_send: O(number_of_async_watchers)
3259		3295
3260	=item Processing signals: O(max_signal_number)	3296	=item Processing signals: O(max_signal_number)
3261		3297
3262	Sending involves a syscall I<iff> there were no other C<ev_async_send>	3298	Sending involves a system call I<iff> there were no other C<ev_async_send>
3263	calls in the current loop iteration. Checking for async and signal events	3299	calls in the current loop iteration. Checking for async and signal events
3264	involves iterating over all running async watchers or all signal numbers.	3300	involves iterating over all running async watchers or all signal numbers.
3265		3301
3266	=back	3302	=back
3267		3303
3268		3304
3269	=head1 Win32 platform limitations and workarounds	3305	=head1 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS
3270		3306
3271	Win32 doesn't support any of the standards (e.g. POSIX) that libev	3307	Win32 doesn't support any of the standards (e.g. POSIX) that libev
3272	requires, and its I/O model is fundamentally incompatible with the POSIX	3308	requires, and its I/O model is fundamentally incompatible with the POSIX
3273	model. Libev still offers limited functionality on this platform in	3309	model. Libev still offers limited functionality on this platform in
3274	the form of the C<EVBACKEND_SELECT> backend, and only supports socket	3310	the form of the C<EVBACKEND_SELECT> backend, and only supports socket
…		…
3281	way (note also that glib is the slowest event library known to man).	3317	way (note also that glib is the slowest event library known to man).
3282		3318
3283	There is no supported compilation method available on windows except	3319	There is no supported compilation method available on windows except
3284	embedding it into other applications.	3320	embedding it into other applications.
3285		3321
		3322	Not a libev limitation but worth mentioning: windows apparently doesn't
		3323	accept large writes: instead of resulting in a partial write, windows will
		3324	either accept everything or return C<ENOBUFS> if the buffer is too large,
		3325	so make sure you only write small amounts into your sockets (less than a
		3326	megabyte seems safe, but thsi apparently depends on the amount of memory
		3327	available).
		3328
3286	Due to the many, low, and arbitrary limits on the win32 platform and	3329	Due to the many, low, and arbitrary limits on the win32 platform and
3287	the abysmal performance of winsockets, using a large number of sockets	3330	the abysmal performance of winsockets, using a large number of sockets
3288	is not recommended (and not reasonable). If your program needs to use	3331	is not recommended (and not reasonable). If your program needs to use
3289	more than a hundred or so sockets, then likely it needs to use a totally	3332	more than a hundred or so sockets, then likely it needs to use a totally
3290	different implementation for windows, as libev offers the POSIX readiness	3333	different implementation for windows, as libev offers the POSIX readiness
3291	notification model, which cannot be implemented efficiently on windows	3334	notification model, which cannot be implemented efficiently on windows
3292	(microsoft monopoly games).	3335	(Microsoft monopoly games).
		3336
		3337	A typical way to use libev under windows is to embed it (see the embedding
		3338	section for details) and use the following F<evwrap.h> header file instead
		3339	of F<ev.h>:
		3340
		3341	#define EV_STANDALONE /* keeps ev from requiring config.h */
		3342	#define EV_SELECT_IS_WINSOCKET 1 /* configure libev for windows select */
		3343
		3344	#include "ev.h"
		3345
		3346	And compile the following F<evwrap.c> file into your project (make sure
		3347	you do I<not> compile the F<ev.c> or any other embedded soruce files!):
		3348
		3349	#include "evwrap.h"
		3350	#include "ev.c"
3293		3351
3294	=over 4	3352	=over 4
3295		3353
3296	=item The winsocket select function	3354	=item The winsocket select function
3297		3355
3298	The winsocket C<select> function doesn't follow POSIX in that it requires	3356	The winsocket C<select> function doesn't follow POSIX in that it
3299	socket I<handles> and not socket I<file descriptors>. This makes select	3357	requires socket I<handles> and not socket I<file descriptors> (it is
3300	very inefficient, and also requires a mapping from file descriptors	3358	also extremely buggy). This makes select very inefficient, and also
3301	to socket handles. See the discussion of the C<EV_SELECT_USE_FD_SET>,	3359	requires a mapping from file descriptors to socket handles (the Microsoft
3302	C<EV_SELECT_IS_WINSOCKET> and C<EV_FD_TO_WIN32_HANDLE> preprocessor	3360	C runtime provides the function C<_open_osfhandle> for this). See the
3303	symbols for more info.	3361	discussion of the C<EV_SELECT_USE_FD_SET>, C<EV_SELECT_IS_WINSOCKET> and
		3362	C<EV_FD_TO_WIN32_HANDLE> preprocessor symbols for more info.
3304		3363
3305	The configuration for a "naked" win32 using the microsoft runtime	3364	The configuration for a "naked" win32 using the Microsoft runtime
3306	libraries and raw winsocket select is:	3365	libraries and raw winsocket select is:
3307		3366
3308	#define EV_USE_SELECT 1	3367	#define EV_USE_SELECT 1
3309	#define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */	3368	#define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */
3310		3369
3311	Note that winsockets handling of fd sets is O(n), so you can easily get a	3370	Note that winsockets handling of fd sets is O(n), so you can easily get a
3312	complexity in the O(n²) range when using win32.	3371	complexity in the O(n²) range when using win32.
3313		3372
3314	=item Limited number of file descriptors	3373	=item Limited number of file descriptors
3315		3374
3316	Windows has numerous arbitrary (and low) limits on things.	3375	Windows has numerous arbitrary (and low) limits on things.
3317		3376
3318	Early versions of winsocket's select only supported waiting for a maximum	3377	Early versions of winsocket's select only supported waiting for a maximum
3319	of C<64> handles (probably owning to the fact that all windows kernels	3378	of C<64> handles (probably owning to the fact that all windows kernels
3320	can only wait for C<64> things at the same time internally; microsoft	3379	can only wait for C<64> things at the same time internally; Microsoft
3321	recommends spawning a chain of threads and wait for 63 handles and the	3380	recommends spawning a chain of threads and wait for 63 handles and the
3322	previous thread in each. Great).	3381	previous thread in each. Great).
3323		3382
3324	Newer versions support more handles, but you need to define C<FD_SETSIZE>	3383	Newer versions support more handles, but you need to define C<FD_SETSIZE>
3325	to some high number (e.g. C<2048>) before compiling the winsocket select	3384	to some high number (e.g. C<2048>) before compiling the winsocket select
3326	call (which might be in libev or elsewhere, for example, perl does its own	3385	call (which might be in libev or elsewhere, for example, perl does its own
3327	select emulation on windows).	3386	select emulation on windows).
3328		3387
3329	Another limit is the number of file descriptors in the microsoft runtime	3388	Another limit is the number of file descriptors in the Microsoft runtime
3330	libraries, which by default is C<64> (there must be a hidden I<64> fetish	3389	libraries, which by default is C<64> (there must be a hidden I<64> fetish
3331	or something like this inside microsoft). You can increase this by calling	3390	or something like this inside Microsoft). You can increase this by calling
3332	C<_setmaxstdio>, which can increase this limit to C<2048> (another	3391	C<_setmaxstdio>, which can increase this limit to C<2048> (another
3333	arbitrary limit), but is broken in many versions of the microsoft runtime	3392	arbitrary limit), but is broken in many versions of the Microsoft runtime
3334	libraries.	3393	libraries.
3335		3394
3336	This might get you to about C<512> or C<2048> sockets (depending on	3395	This might get you to about C<512> or C<2048> sockets (depending on
3337	windows version and/or the phase of the moon). To get more, you need to	3396	windows version and/or the phase of the moon). To get more, you need to
3338	wrap all I/O functions and provide your own fd management, but the cost of	3397	wrap all I/O functions and provide your own fd management, but the cost of
…		…
3345		3404
3346	In addition to a working ISO-C implementation, libev relies on a few	3405	In addition to a working ISO-C implementation, libev relies on a few
3347	additional extensions:	3406	additional extensions:
3348		3407
3349	=over 4	3408	=over 4
		3409
		3410	=item C<void (*)(ev_watcher_type *, int revents)> must have compatible
		3411	calling conventions regardless of C<ev_watcher_type *>.
		3412
		3413	Libev assumes not only that all watcher pointers have the same internal
		3414	structure (guaranteed by POSIX but not by ISO C for example), but it also
		3415	assumes that the same (machine) code can be used to call any watcher
		3416	callback: The watcher callbacks have different type signatures, but libev
		3417	calls them using an C<ev_watcher *> internally.
3350		3418
3351	=item C<sig_atomic_t volatile> must be thread-atomic as well	3419	=item C<sig_atomic_t volatile> must be thread-atomic as well
3352		3420
3353	The type C<sig_atomic_t volatile> (or whatever is defined as	3421	The type C<sig_atomic_t volatile> (or whatever is defined as
3354	C<EV_ATOMIC_T>) must be atomic w.r.t. accesses from different	3422	C<EV_ATOMIC_T>) must be atomic w.r.t. accesses from different
…		…
3386	=back	3454	=back
3387		3455
3388	If you know of other additional requirements drop me a note.	3456	If you know of other additional requirements drop me a note.
3389		3457
3390		3458
		3459	=head1 COMPILER WARNINGS
		3460
		3461	Depending on your compiler and compiler settings, you might get no or a
		3462	lot of warnings when compiling libev code. Some people are apparently
		3463	scared by this.
		3464
		3465	However, these are unavoidable for many reasons. For one, each compiler
		3466	has different warnings, and each user has different tastes regarding
		3467	warning options. "Warn-free" code therefore cannot be a goal except when
		3468	targeting a specific compiler and compiler-version.
		3469
		3470	Another reason is that some compiler warnings require elaborate
		3471	workarounds, or other changes to the code that make it less clear and less
		3472	maintainable.
		3473
		3474	And of course, some compiler warnings are just plain stupid, or simply
		3475	wrong (because they don't actually warn about the condition their message
		3476	seems to warn about).
		3477
		3478	While libev is written to generate as few warnings as possible,
		3479	"warn-free" code is not a goal, and it is recommended not to build libev
		3480	with any compiler warnings enabled unless you are prepared to cope with
		3481	them (e.g. by ignoring them). Remember that warnings are just that:
		3482	warnings, not errors, or proof of bugs.
		3483
		3484
3391	=head1 VALGRIND	3485	=head1 VALGRIND
3392		3486
3393	Valgrind has a special section here because it is a popular tool that is	3487	Valgrind has a special section here because it is a popular tool that is
3394	highly useful, but valgrind reports are very hard to interpret.	3488	highly useful, but valgrind reports are very hard to interpret.
3395		3489
…		…
3398		3492
3399	==2274== definitely lost: 0 bytes in 0 blocks.	3493	==2274== definitely lost: 0 bytes in 0 blocks.
3400	==2274== possibly lost: 0 bytes in 0 blocks.	3494	==2274== possibly lost: 0 bytes in 0 blocks.
3401	==2274== still reachable: 256 bytes in 1 blocks.	3495	==2274== still reachable: 256 bytes in 1 blocks.
3402		3496
3403	then there is no memory leak. Similarly, under some circumstances,	3497	Then there is no memory leak. Similarly, under some circumstances,
3404	valgrind might report kernel bugs as if it were a bug in libev, or it	3498	valgrind might report kernel bugs as if it were a bug in libev, or it
3405	might be confused (it is a very good tool, but only a tool).	3499	might be confused (it is a very good tool, but only a tool).
3406		3500
3407	If you are unsure about something, feel free to contact the mailing list	3501	If you are unsure about something, feel free to contact the mailing list
3408	with the full valgrind report and an explanation on why you think this is	3502	with the full valgrind report and an explanation on why you think this is

Diff Legend

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