ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.178 by root, Sat Sep 13 18:25:50 2008 UTC vs.
Revision 1.204 by root, Mon Oct 27 11:08:29 2008 UTC

…		…
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_ 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);
…		…
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_ 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	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);
…		…
103	Libev is very configurable. In this manual the default (and most common)	103	Libev is very configurable. In this manual the default (and most common)
104	configuration will be described, which supports multiple event loops. For	104	configuration will be described, which supports multiple event loops. For
105	more info about various configuration options please have a look at	105	more info about various configuration options please have a look at
106	B<EMBED> section in this manual. If libev was configured without support	106	B<EMBED> section in this manual. If libev was configured without support
107	for multiple event loops, then all functions taking an initial argument of	107	for multiple event loops, then all functions taking an initial argument of
108	name C<loop> (which is always of type C<struct ev_loop *>) will not have	108	name C<loop> (which is always of type C<ev_loop *>) will not have
109	this argument.	109	this argument.
110		110
111	=head2 TIME REPRESENTATION	111	=head2 TIME REPRESENTATION
112		112
113	Libev represents time as a single floating point number, representing the	113	Libev represents time as a single floating point number, representing the
…		…
214	C<ev_embeddable_backends () & ev_supported_backends ()>, likewise for	214	C<ev_embeddable_backends () & ev_supported_backends ()>, likewise for
215	recommended ones.	215	recommended ones.
216		216
217	See the description of C<ev_embed> watchers for more info.	217	See the description of C<ev_embed> watchers for more info.
218		218
219	=item ev_set_allocator (void *(*cb)(void *ptr, long size))	219	=item ev_set_allocator (void *(*cb)(void *ptr, long size)) [NOT REENTRANT]
220		220
221	Sets the allocation function to use (the prototype is similar - the	221	Sets the allocation function to use (the prototype is similar - the
222	semantics are identical to the C<realloc> C89/SuS/POSIX function). It is	222	semantics are identical to the C<realloc> C89/SuS/POSIX function). It is
223	used to allocate and free memory (no surprises here). If it returns zero	223	used to allocate and free memory (no surprises here). If it returns zero
224	when memory needs to be allocated (C<size != 0>), the library might abort	224	when memory needs to be allocated (C<size != 0>), the library might abort
…		…
250	}	250	}
251		251
252	...	252	...
253	ev_set_allocator (persistent_realloc);	253	ev_set_allocator (persistent_realloc);
254		254
255	=item ev_set_syserr_cb (void (*cb)(const char *msg));	255	=item ev_set_syserr_cb (void (*cb)(const char *msg)); [NOT REENTRANT]
256		256
257	Set the callback function to call on a retryable system call error (such	257	Set the callback function to call on a retryable system call error (such
258	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
259	indicating the system call or subsystem causing the problem. If this	259	indicating the system call or subsystem causing the problem. If this
260	callback is set, then libev will expect it to remedy the situation, no	260	callback is set, then libev will expect it to remedy the situation, no
…		…
276		276
277	=back	277	=back
278		278
279	=head1 FUNCTIONS CONTROLLING THE EVENT LOOP	279	=head1 FUNCTIONS CONTROLLING THE EVENT LOOP
280		280
281	An event loop is described by a C<struct ev_loop *>. The library knows two	281	An event loop is described by a C<struct ev_loop *> (the C<struct>
282	types of such loops, the I<default> loop, which supports signals and child	282	is I<not> optional in this case, as there is also an C<ev_loop>
283	events, and dynamically created loops which do not.	283	I<function>).
		284
		285	The library knows two types of such loops, the I<default> loop, which
		286	supports signals and child events, and dynamically created loops which do
		287	not.
284		288
285	=over 4	289	=over 4
286		290
287	=item struct ev_loop *ev_default_loop (unsigned int flags)	291	=item struct ev_loop *ev_default_loop (unsigned int flags)
288		292
…		…
359	writing a server, you should C<accept ()> in a loop to accept as many	363	writing a server, you should C<accept ()> in a loop to accept as many
360	connections as possible during one iteration. You might also want to have	364	connections as possible during one iteration. You might also want to have
361	a look at C<ev_set_io_collect_interval ()> to increase the amount of	365	a look at C<ev_set_io_collect_interval ()> to increase the amount of
362	readiness notifications you get per iteration.	366	readiness notifications you get per iteration.
363		367
		368	This backend maps C<EV_READ> to the C<readfds> set and C<EV_WRITE> to the
		369	C<writefds> set (and to work around Microsoft Windows bugs, also onto the
		370	C<exceptfds> set on that platform).
		371
364	=item C<EVBACKEND_POLL> (value 2, poll backend, available everywhere except on windows)	372	=item C<EVBACKEND_POLL> (value 2, poll backend, available everywhere except on windows)
365		373
366	And this is your standard poll(2) backend. It's more complicated	374	And this is your standard poll(2) backend. It's more complicated
367	than select, but handles sparse fds better and has no artificial	375	than select, but handles sparse fds better and has no artificial
368	limit on the number of fds you can use (except it will slow down	376	limit on the number of fds you can use (except it will slow down
369	considerably with a lot of inactive fds). It scales similarly to select,	377	considerably with a lot of inactive fds). It scales similarly to select,
370	i.e. O(total_fds). See the entry for C<EVBACKEND_SELECT>, above, for	378	i.e. O(total_fds). See the entry for C<EVBACKEND_SELECT>, above, for
371	performance tips.	379	performance tips.
		380
		381	This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and
		382	C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>.
372		383
373	=item C<EVBACKEND_EPOLL> (value 4, Linux)	384	=item C<EVBACKEND_EPOLL> (value 4, Linux)
374		385
375	For few fds, this backend is a bit little slower than poll and select,	386	For few fds, this backend is a bit little slower than poll and select,
376	but it scales phenomenally better. While poll and select usually scale	387	but it scales phenomenally better. While poll and select usually scale
…		…
378	epoll scales either O(1) or O(active_fds). The epoll design has a number	389	epoll scales either O(1) or O(active_fds). The epoll design has a number
379	of shortcomings, such as silently dropping events in some hard-to-detect	390	of shortcomings, such as silently dropping events in some hard-to-detect
380	cases and requiring a system call per fd change, no fork support and bad	391	cases and requiring a system call per fd change, no fork support and bad
381	support for dup.	392	support for dup.
382		393
		394	Epoll is also notoriously buggy - embedding epoll fds should work, but
		395	of course doesn't, and epoll just loves to report events for totally
		396	I<different> file descriptors (even already closed ones) than registered
		397	in the set (especially on SMP systems). Libev tries to counter these
		398	spurious notifications by employing an additional generation counter and
		399	comparing that against the events to filter out spurious ones.
		400
383	While stopping, setting and starting an I/O watcher in the same iteration	401	While stopping, setting and starting an I/O watcher in the same iteration
384	will result in some caching, there is still a system call per such incident	402	will result in some caching, there is still a system call per such incident
385	(because the fd could point to a different file description now), so its	403	(because the fd could point to a different file description now), so its
386	best to avoid that. Also, C<dup ()>'ed file descriptors might not work	404	best to avoid that. Also, C<dup ()>'ed file descriptors might not work
387	very well if you register events for both fds.	405	very well if you register events for both fds.
388		406
389	Please note that epoll sometimes generates spurious notifications, so you
390	need to use non-blocking I/O or other means to avoid blocking when no data
391	(or space) is available.
392
393	Best performance from this backend is achieved by not unregistering all	407	Best performance from this backend is achieved by not unregistering all
394	watchers for a file descriptor until it has been closed, if possible, i.e.	408	watchers for a file descriptor until it has been closed, if possible,
395	keep at least one watcher active per fd at all times.	409	i.e. keep at least one watcher active per fd at all times. Stopping and
		410	starting a watcher (without re-setting it) also usually doesn't cause
		411	extra overhead.
396		412
397	While nominally embeddable in other event loops, this feature is broken in	413	While nominally embeddable in other event loops, this feature is broken in
398	all kernel versions tested so far.	414	all kernel versions tested so far.
399		415
		416	This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
		417	C<EVBACKEND_POLL>.
		418
400	=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)	419	=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)
401		420
402	Kqueue deserves special mention, as at the time of this writing, it	421	Kqueue deserves special mention, as at the time of this writing, it was
403	was broken on all BSDs except NetBSD (usually it doesn't work reliably	422	broken on all BSDs except NetBSD (usually it doesn't work reliably with
404	with anything but sockets and pipes, except on Darwin, where of course	423	anything but sockets and pipes, except on Darwin, where of course it's
405	it's completely useless). For this reason it's not being "auto-detected"	424	completely useless). For this reason it's not being "auto-detected" unless
406	unless you explicitly specify it explicitly in the flags (i.e. using	425	you explicitly specify it in the flags (i.e. using C<EVBACKEND_KQUEUE>) or
407	C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough)	426	libev was compiled on a known-to-be-good (-enough) system like NetBSD.
408	system like NetBSD.
409		427
410	You still can embed kqueue into a normal poll or select backend and use it	428	You still can embed kqueue into a normal poll or select backend and use it
411	only for sockets (after having made sure that sockets work with kqueue on	429	only for sockets (after having made sure that sockets work with kqueue on
412	the target platform). See C<ev_embed> watchers for more info.	430	the target platform). See C<ev_embed> watchers for more info.
413		431
414	It scales in the same way as the epoll backend, but the interface to the	432	It scales in the same way as the epoll backend, but the interface to the
415	kernel is more efficient (which says nothing about its actual speed, of	433	kernel is more efficient (which says nothing about its actual speed, of
416	course). While stopping, setting and starting an I/O watcher does never	434	course). While stopping, setting and starting an I/O watcher does never
417	cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to	435	cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to
418	two event changes per incident, support for C<fork ()> is very bad and it	436	two event changes per incident. Support for C<fork ()> is very bad and it
419	drops fds silently in similarly hard-to-detect cases.	437	drops fds silently in similarly hard-to-detect cases.
420		438
421	This backend usually performs well under most conditions.	439	This backend usually performs well under most conditions.
422		440
423	While nominally embeddable in other event loops, this doesn't work	441	While nominally embeddable in other event loops, this doesn't work
424	everywhere, so you might need to test for this. And since it is broken	442	everywhere, so you might need to test for this. And since it is broken
425	almost everywhere, you should only use it when you have a lot of sockets	443	almost everywhere, you should only use it when you have a lot of sockets
426	(for which it usually works), by embedding it into another event loop	444	(for which it usually works), by embedding it into another event loop
427	(e.g. C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>) and using it only for	445	(e.g. C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>) and, did I mention it,
428	sockets.	446	using it only for sockets.
		447
		448	This backend maps C<EV_READ> into an C<EVFILT_READ> kevent with
		449	C<NOTE_EOF>, and C<EV_WRITE> into an C<EVFILT_WRITE> kevent with
		450	C<NOTE_EOF>.
429		451
430	=item C<EVBACKEND_DEVPOLL> (value 16, Solaris 8)	452	=item C<EVBACKEND_DEVPOLL> (value 16, Solaris 8)
431		453
432	This is not implemented yet (and might never be, unless you send me an	454	This is not implemented yet (and might never be, unless you send me an
433	implementation). According to reports, C</dev/poll> only supports sockets	455	implementation). According to reports, C</dev/poll> only supports sockets
…		…
446	While this backend scales well, it requires one system call per active	468	While this backend scales well, it requires one system call per active
447	file descriptor per loop iteration. For small and medium numbers of file	469	file descriptor per loop iteration. For small and medium numbers of file
448	descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend	470	descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend
449	might perform better.	471	might perform better.
450		472
451	On the positive side, ignoring the spurious readiness notifications, this	473	On the positive side, with the exception of the spurious readiness
452	backend actually performed to specification in all tests and is fully	474	notifications, this backend actually performed fully to specification
453	embeddable, which is a rare feat among the OS-specific backends.	475	in all tests and is fully embeddable, which is a rare feat among the
		476	OS-specific backends.
		477
		478	This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
		479	C<EVBACKEND_POLL>.
454		480
455	=item C<EVBACKEND_ALL>	481	=item C<EVBACKEND_ALL>
456		482
457	Try all backends (even potentially broken ones that wouldn't be tried	483	Try all backends (even potentially broken ones that wouldn't be tried
458	with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as	484	with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as
…		…
464		490
465	If one or more of these are or'ed into the flags value, then only these	491	If one or more of these are or'ed into the flags value, then only these
466	backends will be tried (in the reverse order as listed here). If none are	492	backends will be tried (in the reverse order as listed here). If none are
467	specified, all backends in C<ev_recommended_backends ()> will be tried.	493	specified, all backends in C<ev_recommended_backends ()> will be tried.
468		494
469	The most typical usage is like this:	495	Example: This is the most typical usage.
470		496
471	if (!ev_default_loop (0))	497	if (!ev_default_loop (0))
472	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");	498	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
473		499
474	Restrict libev to the select and poll backends, and do not allow	500	Example: Restrict libev to the select and poll backends, and do not allow
475	environment settings to be taken into account:	501	environment settings to be taken into account:
476		502
477	ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV);	503	ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV);
478		504
479	Use whatever libev has to offer, but make sure that kqueue is used if	505	Example: Use whatever libev has to offer, but make sure that kqueue is
480	available (warning, breaks stuff, best use only with your own private	506	used if available (warning, breaks stuff, best use only with your own
481	event loop and only if you know the OS supports your types of fds):	507	private event loop and only if you know the OS supports your types of
		508	fds):
482		509
483	ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE);	510	ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE);
484		511
485	=item struct ev_loop *ev_loop_new (unsigned int flags)	512	=item struct ev_loop *ev_loop_new (unsigned int flags)
486		513
…		…
507	responsibility to either stop all watchers cleanly yourself I<before>	534	responsibility to either stop all watchers cleanly yourself I<before>
508	calling this function, or cope with the fact afterwards (which is usually	535	calling this function, or cope with the fact afterwards (which is usually
509	the easiest thing, you can just ignore the watchers and/or C<free ()> them	536	the easiest thing, you can just ignore the watchers and/or C<free ()> them
510	for example).	537	for example).
511		538
512	Note that certain global state, such as signal state, will not be freed by	539	Note that certain global state, such as signal state (and installed signal
513	this function, and related watchers (such as signal and child watchers)	540	handlers), will not be freed by this function, and related watchers (such
514	would need to be stopped manually.	541	as signal and child watchers) would need to be stopped manually.
515		542
516	In general it is not advisable to call this function except in the	543	In general it is not advisable to call this function except in the
517	rare occasion where you really need to free e.g. the signal handling	544	rare occasion where you really need to free e.g. the signal handling
518	pipe fds. If you need dynamically allocated loops it is better to use	545	pipe fds. If you need dynamically allocated loops it is better to use
519	C<ev_loop_new> and C<ev_loop_destroy>).	546	C<ev_loop_new> and C<ev_loop_destroy>).
…		…
544		571
545	=item ev_loop_fork (loop)	572	=item ev_loop_fork (loop)
546		573
547	Like C<ev_default_fork>, but acts on an event loop created by	574	Like C<ev_default_fork>, but acts on an event loop created by
548	C<ev_loop_new>. Yes, you have to call this on every allocated event loop	575	C<ev_loop_new>. Yes, you have to call this on every allocated event loop
549	after fork, and how you do this is entirely your own problem.	576	after fork that you want to re-use in the child, and how you do this is
		577	entirely your own problem.
550		578
551	=item int ev_is_default_loop (loop)	579	=item int ev_is_default_loop (loop)
552		580
553	Returns true when the given loop actually is the default loop, false otherwise.	581	Returns true when the given loop is, in fact, the default loop, and false
		582	otherwise.
554		583
555	=item unsigned int ev_loop_count (loop)	584	=item unsigned int ev_loop_count (loop)
556		585
557	Returns the count of loop iterations for the loop, which is identical to	586	Returns the count of loop iterations for the loop, which is identical to
558	the number of times libev did poll for new events. It starts at C<0> and	587	the number of times libev did poll for new events. It starts at C<0> and
…		…
596	If the flags argument is specified as C<0>, it will not return until	625	If the flags argument is specified as C<0>, it will not return until
597	either no event watchers are active anymore or C<ev_unloop> was called.	626	either no event watchers are active anymore or C<ev_unloop> was called.
598		627
599	Please note that an explicit C<ev_unloop> is usually better than	628	Please note that an explicit C<ev_unloop> is usually better than
600	relying on all watchers to be stopped when deciding when a program has	629	relying on all watchers to be stopped when deciding when a program has
601	finished (especially in interactive programs), but having a program that	630	finished (especially in interactive programs), but having a program
602	automatically loops as long as it has to and no longer by virtue of	631	that automatically loops as long as it has to and no longer by virtue
603	relying on its watchers stopping correctly is a thing of beauty.	632	of relying on its watchers stopping correctly, that is truly a thing of
		633	beauty.
604		634
605	A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle	635	A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle
606	those events and any outstanding ones, but will not block your process in	636	those events and any already outstanding ones, but will not block your
607	case there are no events and will return after one iteration of the loop.	637	process in case there are no events and will return after one iteration of
		638	the loop.
608		639
609	A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if	640	A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if
610	necessary) and will handle those and any outstanding ones. It will block	641	necessary) and will handle those and any already outstanding ones. It
611	your process until at least one new event arrives, and will return after	642	will block your process until at least one new event arrives (which could
612	one iteration of the loop. This is useful if you are waiting for some	643	be an event internal to libev itself, so there is no guarentee that a
613	external event in conjunction with something not expressible using other	644	user-registered callback will be called), and will return after one
		645	iteration of the loop.
		646
		647	This is useful if you are waiting for some external event in conjunction
		648	with something not expressible using other libev watchers (i.e. "roll your
614	libev watchers. However, a pair of C<ev_prepare>/C<ev_check> watchers is	649	own C<ev_loop>"). However, a pair of C<ev_prepare>/C<ev_check> watchers is
615	usually a better approach for this kind of thing.	650	usually a better approach for this kind of thing.
616		651
617	Here are the gory details of what C<ev_loop> does:	652	Here are the gory details of what C<ev_loop> does:
618		653
619	- Before the first iteration, call any pending watchers.	654	- Before the first iteration, call any pending watchers.
…		…
629	any active watchers at all will result in not sleeping).	664	any active watchers at all will result in not sleeping).
630	- Sleep if the I/O and timer collect interval say so.	665	- Sleep if the I/O and timer collect interval say so.
631	- Block the process, waiting for any events.	666	- Block the process, waiting for any events.
632	- Queue all outstanding I/O (fd) events.	667	- Queue all outstanding I/O (fd) events.
633	- Update the "event loop time" (ev_now ()), and do time jump adjustments.	668	- Update the "event loop time" (ev_now ()), and do time jump adjustments.
634	- Queue all outstanding timers.	669	- Queue all expired timers.
635	- Queue all outstanding periodics.	670	- Queue all expired periodics.
636	- Unless any events are pending now, queue all idle watchers.	671	- Unless any events are pending now, queue all idle watchers.
637	- Queue all check watchers.	672	- Queue all check watchers.
638	- Call all queued watchers in reverse order (i.e. check watchers first).	673	- Call all queued watchers in reverse order (i.e. check watchers first).
639	Signals and child watchers are implemented as I/O watchers, and will	674	Signals and child watchers are implemented as I/O watchers, and will
640	be handled here by queueing them when their watcher gets executed.	675	be handled here by queueing them when their watcher gets executed.
…		…
657	C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or	692	C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or
658	C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return.	693	C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return.
659		694
660	This "unloop state" will be cleared when entering C<ev_loop> again.	695	This "unloop state" will be cleared when entering C<ev_loop> again.
661		696
		697	It is safe to call C<ev_unloop> from otuside any C<ev_loop> calls.
		698
662	=item ev_ref (loop)	699	=item ev_ref (loop)
663		700
664	=item ev_unref (loop)	701	=item ev_unref (loop)
665		702
666	Ref/unref can be used to add or remove a reference count on the event	703	Ref/unref can be used to add or remove a reference count on the event
667	loop: Every watcher keeps one reference, and as long as the reference	704	loop: Every watcher keeps one reference, and as long as the reference
668	count is nonzero, C<ev_loop> will not return on its own. If you have	705	count is nonzero, C<ev_loop> will not return on its own.
		706
669	a watcher you never unregister that should not keep C<ev_loop> from	707	If you have a watcher you never unregister that should not keep C<ev_loop>
670	returning, ev_unref() after starting, and ev_ref() before stopping it. For	708	from returning, call ev_unref() after starting, and ev_ref() before
		709	stopping it.
		710
671	example, libev itself uses this for its internal signal pipe: It is not	711	As an example, libev itself uses this for its internal signal pipe: It is
672	visible to the libev user and should not keep C<ev_loop> from exiting if	712	not visible to the libev user and should not keep C<ev_loop> from exiting
673	no event watchers registered by it are active. It is also an excellent	713	if no event watchers registered by it are active. It is also an excellent
674	way to do this for generic recurring timers or from within third-party	714	way to do this for generic recurring timers or from within third-party
675	libraries. Just remember to I<unref after start> and I<ref before stop>	715	libraries. Just remember to I<unref after start> and I<ref before stop>
676	(but only if the watcher wasn't active before, or was active before,	716	(but only if the watcher wasn't active before, or was active before,
677	respectively).	717	respectively).
678		718
679	Example: Create a signal watcher, but keep it from keeping C<ev_loop>	719	Example: Create a signal watcher, but keep it from keeping C<ev_loop>
680	running when nothing else is active.	720	running when nothing else is active.
681		721
682	struct ev_signal exitsig;	722	ev_signal exitsig;
683	ev_signal_init (&exitsig, sig_cb, SIGINT);	723	ev_signal_init (&exitsig, sig_cb, SIGINT);
684	ev_signal_start (loop, &exitsig);	724	ev_signal_start (loop, &exitsig);
685	evf_unref (loop);	725	evf_unref (loop);
686		726
687	Example: For some weird reason, unregister the above signal handler again.	727	Example: For some weird reason, unregister the above signal handler again.
…		…
701	Setting these to a higher value (the C<interval> I<must> be >= C<0>)	741	Setting these to a higher value (the C<interval> I<must> be >= C<0>)
702	allows libev to delay invocation of I/O and timer/periodic callbacks	742	allows libev to delay invocation of I/O and timer/periodic callbacks
703	to increase efficiency of loop iterations (or to increase power-saving	743	to increase efficiency of loop iterations (or to increase power-saving
704	opportunities).	744	opportunities).
705		745
706	The background is that sometimes your program runs just fast enough to	746	The idea is that sometimes your program runs just fast enough to handle
707	handle one (or very few) event(s) per loop iteration. While this makes	747	one (or very few) event(s) per loop iteration. While this makes the
708	the program responsive, it also wastes a lot of CPU time to poll for new	748	program responsive, it also wastes a lot of CPU time to poll for new
709	events, especially with backends like C<select ()> which have a high	749	events, especially with backends like C<select ()> which have a high
710	overhead for the actual polling but can deliver many events at once.	750	overhead for the actual polling but can deliver many events at once.
711		751
712	By setting a higher I<io collect interval> you allow libev to spend more	752	By setting a higher I<io collect interval> you allow libev to spend more
713	time collecting I/O events, so you can handle more events per iteration,	753	time collecting I/O events, so you can handle more events per iteration,
…		…
715	C<ev_timer>) will be not affected. Setting this to a non-null value will	755	C<ev_timer>) will be not affected. Setting this to a non-null value will
716	introduce an additional C<ev_sleep ()> call into most loop iterations.	756	introduce an additional C<ev_sleep ()> call into most loop iterations.
717		757
718	Likewise, by setting a higher I<timeout collect interval> you allow libev	758	Likewise, by setting a higher I<timeout collect interval> you allow libev
719	to spend more time collecting timeouts, at the expense of increased	759	to spend more time collecting timeouts, at the expense of increased
720	latency (the watcher callback will be called later). C<ev_io> watchers	760	latency/jitter/inexactness (the watcher callback will be called
721	will not be affected. Setting this to a non-null value will not introduce	761	later). C<ev_io> watchers will not be affected. Setting this to a non-null
722	any overhead in libev.	762	value will not introduce any overhead in libev.
723		763
724	Many (busy) programs can usually benefit by setting the I/O collect	764	Many (busy) programs can usually benefit by setting the I/O collect
725	interval to a value near C<0.1> or so, which is often enough for	765	interval to a value near C<0.1> or so, which is often enough for
726	interactive servers (of course not for games), likewise for timeouts. It	766	interactive servers (of course not for games), likewise for timeouts. It
727	usually doesn't make much sense to set it to a lower value than C<0.01>,	767	usually doesn't make much sense to set it to a lower value than C<0.01>,
…		…
735	they fire on, say, one-second boundaries only.	775	they fire on, say, one-second boundaries only.
736		776
737	=item ev_loop_verify (loop)	777	=item ev_loop_verify (loop)
738		778
739	This function only does something when C<EV_VERIFY> support has been	779	This function only does something when C<EV_VERIFY> support has been
740	compiled in. It tries to go through all internal structures and checks	780	compiled in, which is the default for non-minimal builds. It tries to go
741	them for validity. If anything is found to be inconsistent, it will print	781	through all internal structures and checks them for validity. If anything
742	an error message to standard error and call C<abort ()>.	782	is found to be inconsistent, it will print an error message to standard
		783	error and call C<abort ()>.
743		784
744	This can be used to catch bugs inside libev itself: under normal	785	This can be used to catch bugs inside libev itself: under normal
745	circumstances, this function will never abort as of course libev keeps its	786	circumstances, this function will never abort as of course libev keeps its
746	data structures consistent.	787	data structures consistent.
747		788
748	=back	789	=back
749		790
750		791
751	=head1 ANATOMY OF A WATCHER	792	=head1 ANATOMY OF A WATCHER
752		793
		794	In the following description, uppercase C<TYPE> in names stands for the
		795	watcher type, e.g. C<ev_TYPE_start> can mean C<ev_timer_start> for timer
		796	watchers and C<ev_io_start> for I/O watchers.
		797
753	A watcher is a structure that you create and register to record your	798	A watcher is a structure that you create and register to record your
754	interest in some event. For instance, if you want to wait for STDIN to	799	interest in some event. For instance, if you want to wait for STDIN to
755	become readable, you would create an C<ev_io> watcher for that:	800	become readable, you would create an C<ev_io> watcher for that:
756		801
757	static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents)	802	static void my_cb (struct ev_loop *loop, ev_io *w, int revents)
758	{	803	{
759	ev_io_stop (w);	804	ev_io_stop (w);
760	ev_unloop (loop, EVUNLOOP_ALL);	805	ev_unloop (loop, EVUNLOOP_ALL);
761	}	806	}
762		807
763	struct ev_loop *loop = ev_default_loop (0);	808	struct ev_loop *loop = ev_default_loop (0);
		809
764	struct ev_io stdin_watcher;	810	ev_io stdin_watcher;
		811
765	ev_init (&stdin_watcher, my_cb);	812	ev_init (&stdin_watcher, my_cb);
766	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);	813	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);
767	ev_io_start (loop, &stdin_watcher);	814	ev_io_start (loop, &stdin_watcher);
		815
768	ev_loop (loop, 0);	816	ev_loop (loop, 0);
769		817
770	As you can see, you are responsible for allocating the memory for your	818	As you can see, you are responsible for allocating the memory for your
771	watcher structures (and it is usually a bad idea to do this on the stack,	819	watcher structures (and it is I<usually> a bad idea to do this on the
772	although this can sometimes be quite valid).	820	stack).
		821
		822	Each watcher has an associated watcher structure (called C<struct ev_TYPE>
		823	or simply C<ev_TYPE>, as typedefs are provided for all watcher structs).
773		824
774	Each watcher structure must be initialised by a call to C<ev_init	825	Each watcher structure must be initialised by a call to C<ev_init
775	(watcher *, callback)>, which expects a callback to be provided. This	826	(watcher *, callback)>, which expects a callback to be provided. This
776	callback gets invoked each time the event occurs (or, in the case of I/O	827	callback gets invoked each time the event occurs (or, in the case of I/O
777	watchers, each time the event loop detects that the file descriptor given	828	watchers, each time the event loop detects that the file descriptor given
778	is readable and/or writable).	829	is readable and/or writable).
779		830
780	Each watcher type has its own C<< ev_<type>_set (watcher *, ...) >> macro	831	Each watcher type further has its own C<< ev_TYPE_set (watcher *, ...) >>
781	with arguments specific to this watcher type. There is also a macro	832	macro to configure it, with arguments specific to the watcher type. There
782	to combine initialisation and setting in one call: C<< ev_<type>_init	833	is also a macro to combine initialisation and setting in one call: C<<
783	(watcher *, callback, ...) >>.	834	ev_TYPE_init (watcher *, callback, ...) >>.
784		835
785	To make the watcher actually watch out for events, you have to start it	836	To make the watcher actually watch out for events, you have to start it
786	with a watcher-specific start function (C<< ev_<type>_start (loop, watcher	837	with a watcher-specific start function (C<< ev_TYPE_start (loop, watcher
787	*) >>), and you can stop watching for events at any time by calling the	838	*) >>), and you can stop watching for events at any time by calling the
788	corresponding stop function (C<< ev_<type>_stop (loop, watcher *) >>.	839	corresponding stop function (C<< ev_TYPE_stop (loop, watcher *) >>.
789		840
790	As long as your watcher is active (has been started but not stopped) you	841	As long as your watcher is active (has been started but not stopped) you
791	must not touch the values stored in it. Most specifically you must never	842	must not touch the values stored in it. Most specifically you must never
792	reinitialise it or call its C<set> macro.	843	reinitialise it or call its C<ev_TYPE_set> macro.
793		844
794	Each and every callback receives the event loop pointer as first, the	845	Each and every callback receives the event loop pointer as first, the
795	registered watcher structure as second, and a bitset of received events as	846	registered watcher structure as second, and a bitset of received events as
796	third argument.	847	third argument.
797		848
…		…
860	=item C<EV_ERROR>	911	=item C<EV_ERROR>
861		912
862	An unspecified error has occurred, the watcher has been stopped. This might	913	An unspecified error has occurred, the watcher has been stopped. This might
863	happen because the watcher could not be properly started because libev	914	happen because the watcher could not be properly started because libev
864	ran out of memory, a file descriptor was found to be closed or any other	915	ran out of memory, a file descriptor was found to be closed or any other
		916	problem. Libev considers these application bugs.
		917
865	problem. You best act on it by reporting the problem and somehow coping	918	You best act on it by reporting the problem and somehow coping with the
866	with the watcher being stopped.	919	watcher being stopped. Note that well-written programs should not receive
		920	an error ever, so when your watcher receives it, this usually indicates a
		921	bug in your program.
867		922
868	Libev will usually signal a few "dummy" events together with an error,	923	Libev will usually signal a few "dummy" events together with an error, for
869	for example it might indicate that a fd is readable or writable, and if	924	example it might indicate that a fd is readable or writable, and if your
870	your callbacks is well-written it can just attempt the operation and cope	925	callbacks is well-written it can just attempt the operation and cope with
871	with the error from read() or write(). This will not work in multi-threaded	926	the error from read() or write(). This will not work in multi-threaded
872	programs, though, so beware.	927	programs, though, as the fd could already be closed and reused for another
		928	thing, so beware.
873		929
874	=back	930	=back
875		931
876	=head2 GENERIC WATCHER FUNCTIONS	932	=head2 GENERIC WATCHER FUNCTIONS
877
878	In the following description, C<TYPE> stands for the watcher type,
879	e.g. C<timer> for C<ev_timer> watchers and C<io> for C<ev_io> watchers.
880		933
881	=over 4	934	=over 4
882		935
883	=item C<ev_init> (ev_TYPE *watcher, callback)	936	=item C<ev_init> (ev_TYPE *watcher, callback)
884		937
…		…
890	which rolls both calls into one.	943	which rolls both calls into one.
891		944
892	You can reinitialise a watcher at any time as long as it has been stopped	945	You can reinitialise a watcher at any time as long as it has been stopped
893	(or never started) and there are no pending events outstanding.	946	(or never started) and there are no pending events outstanding.
894		947
895	The callback is always of type C<void (*)(ev_loop *loop, ev_TYPE *watcher,	948	The callback is always of type C<void (*)(struct ev_loop *loop, ev_TYPE *watcher,
896	int revents)>.	949	int revents)>.
		950
		951	Example: Initialise an C<ev_io> watcher in two steps.
		952
		953	ev_io w;
		954	ev_init (&w, my_cb);
		955	ev_io_set (&w, STDIN_FILENO, EV_READ);
897		956
898	=item C<ev_TYPE_set> (ev_TYPE *, [args])	957	=item C<ev_TYPE_set> (ev_TYPE *, [args])
899		958
900	This macro initialises the type-specific parts of a watcher. You need to	959	This macro initialises the type-specific parts of a watcher. You need to
901	call C<ev_init> at least once before you call this macro, but you can	960	call C<ev_init> at least once before you call this macro, but you can
…		…
904	difference to the C<ev_init> macro).	963	difference to the C<ev_init> macro).
905		964
906	Although some watcher types do not have type-specific arguments	965	Although some watcher types do not have type-specific arguments
907	(e.g. C<ev_prepare>) you still need to call its C<set> macro.	966	(e.g. C<ev_prepare>) you still need to call its C<set> macro.
908		967
		968	See C<ev_init>, above, for an example.
		969
909	=item C<ev_TYPE_init> (ev_TYPE *watcher, callback, [args])	970	=item C<ev_TYPE_init> (ev_TYPE *watcher, callback, [args])
910		971
911	This convenience macro rolls both C<ev_init> and C<ev_TYPE_set> macro	972	This convenience macro rolls both C<ev_init> and C<ev_TYPE_set> macro
912	calls into a single call. This is the most convenient method to initialise	973	calls into a single call. This is the most convenient method to initialise
913	a watcher. The same limitations apply, of course.	974	a watcher. The same limitations apply, of course.
914		975
		976	Example: Initialise and set an C<ev_io> watcher in one step.
		977
		978	ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ);
		979
915	=item C<ev_TYPE_start> (loop *, ev_TYPE *watcher)	980	=item C<ev_TYPE_start> (loop *, ev_TYPE *watcher)
916		981
917	Starts (activates) the given watcher. Only active watchers will receive	982	Starts (activates) the given watcher. Only active watchers will receive
918	events. If the watcher is already active nothing will happen.	983	events. If the watcher is already active nothing will happen.
919		984
		985	Example: Start the C<ev_io> watcher that is being abused as example in this
		986	whole section.
		987
		988	ev_io_start (EV_DEFAULT_UC, &w);
		989
920	=item C<ev_TYPE_stop> (loop *, ev_TYPE *watcher)	990	=item C<ev_TYPE_stop> (loop *, ev_TYPE *watcher)
921		991
922	Stops the given watcher again (if active) and clears the pending	992	Stops the given watcher if active, and clears the pending status (whether
		993	the watcher was active or not).
		994
923	status. It is possible that stopped watchers are pending (for example,	995	It is possible that stopped watchers are pending - for example,
924	non-repeating timers are being stopped when they become pending), but	996	non-repeating timers are being stopped when they become pending - but
925	C<ev_TYPE_stop> ensures that the watcher is neither active nor pending. If	997	calling C<ev_TYPE_stop> ensures that the watcher is neither active nor
926	you want to free or reuse the memory used by the watcher it is therefore a	998	pending. If you want to free or reuse the memory used by the watcher it is
927	good idea to always call its C<ev_TYPE_stop> function.	999	therefore a good idea to always call its C<ev_TYPE_stop> function.
928		1000
929	=item bool ev_is_active (ev_TYPE *watcher)	1001	=item bool ev_is_active (ev_TYPE *watcher)
930		1002
931	Returns a true value iff the watcher is active (i.e. it has been started	1003	Returns a true value iff the watcher is active (i.e. it has been started
932	and not yet been stopped). As long as a watcher is active you must not modify	1004	and not yet been stopped). As long as a watcher is active you must not modify
…		…
974	The default priority used by watchers when no priority has been set is	1046	The default priority used by watchers when no priority has been set is
975	always C<0>, which is supposed to not be too high and not be too low :).	1047	always C<0>, which is supposed to not be too high and not be too low :).
976		1048
977	Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is	1049	Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is
978	fine, as long as you do not mind that the priority value you query might	1050	fine, as long as you do not mind that the priority value you query might
979	or might not have been adjusted to be within valid range.	1051	or might not have been clamped to the valid range.
980		1052
981	=item ev_invoke (loop, ev_TYPE *watcher, int revents)	1053	=item ev_invoke (loop, ev_TYPE *watcher, int revents)
982		1054
983	Invoke the C<watcher> with the given C<loop> and C<revents>. Neither	1055	Invoke the C<watcher> with the given C<loop> and C<revents>. Neither
984	C<loop> nor C<revents> need to be valid as long as the watcher callback	1056	C<loop> nor C<revents> need to be valid as long as the watcher callback
985	can deal with that fact.	1057	can deal with that fact, as both are simply passed through to the
		1058	callback.
986		1059
987	=item int ev_clear_pending (loop, ev_TYPE *watcher)	1060	=item int ev_clear_pending (loop, ev_TYPE *watcher)
988		1061
989	If the watcher is pending, this function returns clears its pending status	1062	If the watcher is pending, this function clears its pending status and
990	and returns its C<revents> bitset (as if its callback was invoked). If the	1063	returns its C<revents> bitset (as if its callback was invoked). If the
991	watcher isn't pending it does nothing and returns C<0>.	1064	watcher isn't pending it does nothing and returns C<0>.
992		1065
		1066	Sometimes it can be useful to "poll" a watcher instead of waiting for its
		1067	callback to be invoked, which can be accomplished with this function.
		1068
993	=back	1069	=back
994		1070
995		1071
996	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER	1072	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
997		1073
998	Each watcher has, by default, a member C<void *data> that you can change	1074	Each watcher has, by default, a member C<void *data> that you can change
999	and read at any time, libev will completely ignore it. This can be used	1075	and read at any time: libev will completely ignore it. This can be used
1000	to associate arbitrary data with your watcher. If you need more data and	1076	to associate arbitrary data with your watcher. If you need more data and
1001	don't want to allocate memory and store a pointer to it in that data	1077	don't want to allocate memory and store a pointer to it in that data
1002	member, you can also "subclass" the watcher type and provide your own	1078	member, you can also "subclass" the watcher type and provide your own
1003	data:	1079	data:
1004		1080
1005	struct my_io	1081	struct my_io
1006	{	1082	{
1007	struct ev_io io;	1083	ev_io io;
1008	int otherfd;	1084	int otherfd;
1009	void *somedata;	1085	void *somedata;
1010	struct whatever *mostinteresting;	1086	struct whatever *mostinteresting;
1011	};	1087	};
1012		1088
…		…
1015	ev_io_init (&w.io, my_cb, fd, EV_READ);	1091	ev_io_init (&w.io, my_cb, fd, EV_READ);
1016		1092
1017	And since your callback will be called with a pointer to the watcher, you	1093	And since your callback will be called with a pointer to the watcher, you
1018	can cast it back to your own type:	1094	can cast it back to your own type:
1019		1095
1020	static void my_cb (struct ev_loop *loop, struct ev_io *w_, int revents)	1096	static void my_cb (struct ev_loop *loop, ev_io *w_, int revents)
1021	{	1097	{
1022	struct my_io *w = (struct my_io *)w_;	1098	struct my_io *w = (struct my_io *)w_;
1023	...	1099	...
1024	}	1100	}
1025		1101
…		…
1036	ev_timer t2;	1112	ev_timer t2;
1037	}	1113	}
1038		1114
1039	In this case getting the pointer to C<my_biggy> is a bit more	1115	In this case getting the pointer to C<my_biggy> is a bit more
1040	complicated: Either you store the address of your C<my_biggy> struct	1116	complicated: Either you store the address of your C<my_biggy> struct
1041	in the C<data> member of the watcher, or you need to use some pointer	1117	in the C<data> member of the watcher (for woozies), or you need to use
1042	arithmetic using C<offsetof> inside your watchers:	1118	some pointer arithmetic using C<offsetof> inside your watchers (for real
		1119	programmers):
1043		1120
1044	#include <stddef.h>	1121	#include <stddef.h>
1045		1122
1046	static void	1123	static void
1047	t1_cb (EV_P_ struct ev_timer *w, int revents)	1124	t1_cb (EV_P_ ev_timer *w, int revents)
1048	{	1125	{
1049	struct my_biggy big = (struct my_biggy *	1126	struct my_biggy big = (struct my_biggy *
1050	(((char *)w) - offsetof (struct my_biggy, t1));	1127	(((char *)w) - offsetof (struct my_biggy, t1));
1051	}	1128	}
1052		1129
1053	static void	1130	static void
1054	t2_cb (EV_P_ struct ev_timer *w, int revents)	1131	t2_cb (EV_P_ ev_timer *w, int revents)
1055	{	1132	{
1056	struct my_biggy big = (struct my_biggy *	1133	struct my_biggy big = (struct my_biggy *
1057	(((char *)w) - offsetof (struct my_biggy, t2));	1134	(((char *)w) - offsetof (struct my_biggy, t2));
1058	}	1135	}
1059		1136
…		…
1087	In general you can register as many read and/or write event watchers per	1164	In general you can register as many read and/or write event watchers per
1088	fd as you want (as long as you don't confuse yourself). Setting all file	1165	fd as you want (as long as you don't confuse yourself). Setting all file
1089	descriptors to non-blocking mode is also usually a good idea (but not	1166	descriptors to non-blocking mode is also usually a good idea (but not
1090	required if you know what you are doing).	1167	required if you know what you are doing).
1091		1168
1092	If you must do this, then force the use of a known-to-be-good backend	1169	If you cannot use non-blocking mode, then force the use of a
1093	(at the time of this writing, this includes only C<EVBACKEND_SELECT> and	1170	known-to-be-good backend (at the time of this writing, this includes only
1094	C<EVBACKEND_POLL>).	1171	C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>).
1095		1172
1096	Another thing you have to watch out for is that it is quite easy to	1173	Another thing you have to watch out for is that it is quite easy to
1097	receive "spurious" readiness notifications, that is your callback might	1174	receive "spurious" readiness notifications, that is your callback might
1098	be called with C<EV_READ> but a subsequent C<read>(2) will actually block	1175	be called with C<EV_READ> but a subsequent C<read>(2) will actually block
1099	because there is no data. Not only are some backends known to create a	1176	because there is no data. Not only are some backends known to create a
1100	lot of those (for example Solaris ports), it is very easy to get into	1177	lot of those (for example Solaris ports), it is very easy to get into
1101	this situation even with a relatively standard program structure. Thus	1178	this situation even with a relatively standard program structure. Thus
1102	it is best to always use non-blocking I/O: An extra C<read>(2) returning	1179	it is best to always use non-blocking I/O: An extra C<read>(2) returning
1103	C<EAGAIN> is far preferable to a program hanging until some data arrives.	1180	C<EAGAIN> is far preferable to a program hanging until some data arrives.
1104		1181
1105	If you cannot run the fd in non-blocking mode (for example you should not	1182	If you cannot run the fd in non-blocking mode (for example you should
1106	play around with an Xlib connection), then you have to separately re-test	1183	not play around with an Xlib connection), then you have to separately
1107	whether a file descriptor is really ready with a known-to-be good interface	1184	re-test whether a file descriptor is really ready with a known-to-be good
1108	such as poll (fortunately in our Xlib example, Xlib already does this on	1185	interface such as poll (fortunately in our Xlib example, Xlib already
1109	its own, so its quite safe to use).	1186	does this on its own, so its quite safe to use). Some people additionally
		1187	use C<SIGALRM> and an interval timer, just to be sure you won't block
		1188	indefinitely.
		1189
		1190	But really, best use non-blocking mode.
1110		1191
1111	=head3 The special problem of disappearing file descriptors	1192	=head3 The special problem of disappearing file descriptors
1112		1193
1113	Some backends (e.g. kqueue, epoll) need to be told about closing a file	1194	Some backends (e.g. kqueue, epoll) need to be told about closing a file
1114	descriptor (either by calling C<close> explicitly or by any other means,	1195	descriptor (either due to calling C<close> explicitly or any other means,
1115	such as C<dup>). The reason is that you register interest in some file	1196	such as C<dup2>). The reason is that you register interest in some file
1116	descriptor, but when it goes away, the operating system will silently drop	1197	descriptor, but when it goes away, the operating system will silently drop
1117	this interest. If another file descriptor with the same number then is	1198	this interest. If another file descriptor with the same number then is
1118	registered with libev, there is no efficient way to see that this is, in	1199	registered with libev, there is no efficient way to see that this is, in
1119	fact, a different file descriptor.	1200	fact, a different file descriptor.
1120		1201
…		…
1151	enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or	1232	enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or
1152	C<EVBACKEND_POLL>.	1233	C<EVBACKEND_POLL>.
1153		1234
1154	=head3 The special problem of SIGPIPE	1235	=head3 The special problem of SIGPIPE
1155		1236
1156	While not really specific to libev, it is easy to forget about SIGPIPE:	1237	While not really specific to libev, it is easy to forget about C<SIGPIPE>:
1157	when writing to a pipe whose other end has been closed, your program gets	1238	when writing to a pipe whose other end has been closed, your program gets
1158	send a SIGPIPE, which, by default, aborts your program. For most programs	1239	sent a SIGPIPE, which, by default, aborts your program. For most programs
1159	this is sensible behaviour, for daemons, this is usually undesirable.	1240	this is sensible behaviour, for daemons, this is usually undesirable.
1160		1241
1161	So when you encounter spurious, unexplained daemon exits, make sure you	1242	So when you encounter spurious, unexplained daemon exits, make sure you
1162	ignore SIGPIPE (and maybe make sure you log the exit status of your daemon	1243	ignore SIGPIPE (and maybe make sure you log the exit status of your daemon
1163	somewhere, as that would have given you a big clue).	1244	somewhere, as that would have given you a big clue).
…		…
1170	=item ev_io_init (ev_io *, callback, int fd, int events)	1251	=item ev_io_init (ev_io *, callback, int fd, int events)
1171		1252
1172	=item ev_io_set (ev_io *, int fd, int events)	1253	=item ev_io_set (ev_io *, int fd, int events)
1173		1254
1174	Configures an C<ev_io> watcher. The C<fd> is the file descriptor to	1255	Configures an C<ev_io> watcher. The C<fd> is the file descriptor to
1175	receive events for and events is either C<EV_READ>, C<EV_WRITE> or	1256	receive events for and C<events> is either C<EV_READ>, C<EV_WRITE> or
1176	C<EV_READ | EV_WRITE> to receive the given events.	1257	C<EV_READ | EV_WRITE>, to express the desire to receive the given events.
1177		1258
1178	=item int fd [read-only]	1259	=item int fd [read-only]
1179		1260
1180	The file descriptor being watched.	1261	The file descriptor being watched.
1181		1262
…		…
1190	Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well	1271	Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well
1191	readable, but only once. Since it is likely line-buffered, you could	1272	readable, but only once. Since it is likely line-buffered, you could
1192	attempt to read a whole line in the callback.	1273	attempt to read a whole line in the callback.
1193		1274
1194	static void	1275	static void
1195	stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents)	1276	stdin_readable_cb (struct ev_loop *loop, ev_io *w, int revents)
1196	{	1277	{
1197	ev_io_stop (loop, w);	1278	ev_io_stop (loop, w);
1198	.. read from stdin here (or from w->fd) and haqndle any I/O errors	1279	.. read from stdin here (or from w->fd) and handle any I/O errors
1199	}	1280	}
1200		1281
1201	...	1282	...
1202	struct ev_loop *loop = ev_default_init (0);	1283	struct ev_loop *loop = ev_default_init (0);
1203	struct ev_io stdin_readable;	1284	ev_io stdin_readable;
1204	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);	1285	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);
1205	ev_io_start (loop, &stdin_readable);	1286	ev_io_start (loop, &stdin_readable);
1206	ev_loop (loop, 0);	1287	ev_loop (loop, 0);
1207		1288
1208		1289
…		…
1211	Timer watchers are simple relative timers that generate an event after a	1292	Timer watchers are simple relative timers that generate an event after a
1212	given time, and optionally repeating in regular intervals after that.	1293	given time, and optionally repeating in regular intervals after that.
1213		1294
1214	The timers are based on real time, that is, if you register an event that	1295	The timers are based on real time, that is, if you register an event that
1215	times out after an hour and you reset your system clock to January last	1296	times out after an hour and you reset your system clock to January last
1216	year, it will still time out after (roughly) and hour. "Roughly" because	1297	year, it will still time out after (roughly) one hour. "Roughly" because
1217	detecting time jumps is hard, and some inaccuracies are unavoidable (the	1298	detecting time jumps is hard, and some inaccuracies are unavoidable (the
1218	monotonic clock option helps a lot here).	1299	monotonic clock option helps a lot here).
1219		1300
1220	The callback is guaranteed to be invoked only after its timeout has passed,	1301	The callback is guaranteed to be invoked only I<after> its timeout has
1221	but if multiple timers become ready during the same loop iteration then	1302	passed, but if multiple timers become ready during the same loop iteration
1222	order of execution is undefined.	1303	then order of execution is undefined.
		1304
		1305	=head3 Be smart about timeouts
		1306
		1307	Many real-world problems involve some kind of timeout, usually for error
		1308	recovery. A typical example is an HTTP request - if the other side hangs,
		1309	you want to raise some error after a while.
		1310
		1311	What follows are some ways to handle this problem, from obvious and
		1312	inefficient to smart and efficient.
		1313
		1314	In the following, a 60 second activity timeout is assumed - a timeout that
		1315	gets reset to 60 seconds each time there is activity (e.g. each time some
		1316	data or other life sign was received).
		1317
		1318	=over 4
		1319
		1320	=item 1. Use a timer and stop, reinitialise and start it on activity.
		1321
		1322	This is the most obvious, but not the most simple way: In the beginning,
		1323	start the watcher:
		1324
		1325	ev_timer_init (timer, callback, 60., 0.);
		1326	ev_timer_start (loop, timer);
		1327
		1328	Then, each time there is some activity, C<ev_timer_stop> it, initialise it
		1329	and start it again:
		1330
		1331	ev_timer_stop (loop, timer);
		1332	ev_timer_set (timer, 60., 0.);
		1333	ev_timer_start (loop, timer);
		1334
		1335	This is relatively simple to implement, but means that each time there is
		1336	some activity, libev will first have to remove the timer from its internal
		1337	data structure and then add it again. Libev tries to be fast, but it's
		1338	still not a constant-time operation.
		1339
		1340	=item 2. Use a timer and re-start it with C<ev_timer_again> inactivity.
		1341
		1342	This is the easiest way, and involves using C<ev_timer_again> instead of
		1343	C<ev_timer_start>.
		1344
		1345	To implement this, configure an C<ev_timer> with a C<repeat> value
		1346	of C<60> and then call C<ev_timer_again> at start and each time you
		1347	successfully read or write some data. If you go into an idle state where
		1348	you do not expect data to travel on the socket, you can C<ev_timer_stop>
		1349	the timer, and C<ev_timer_again> will automatically restart it if need be.
		1350
		1351	That means you can ignore both the C<ev_timer_start> function and the
		1352	C<after> argument to C<ev_timer_set>, and only ever use the C<repeat>
		1353	member and C<ev_timer_again>.
		1354
		1355	At start:
		1356
		1357	ev_timer_init (timer, callback);
		1358	timer->repeat = 60.;
		1359	ev_timer_again (loop, timer);
		1360
		1361	Each time there is some activity:
		1362
		1363	ev_timer_again (loop, timer);
		1364
		1365	It is even possible to change the time-out on the fly, regardless of
		1366	whether the watcher is active or not:
		1367
		1368	timer->repeat = 30.;
		1369	ev_timer_again (loop, timer);
		1370
		1371	This is slightly more efficient then stopping/starting the timer each time
		1372	you want to modify its timeout value, as libev does not have to completely
		1373	remove and re-insert the timer from/into its internal data structure.
		1374
		1375	It is, however, even simpler than the "obvious" way to do it.
		1376
		1377	=item 3. Let the timer time out, but then re-arm it as required.
		1378
		1379	This method is more tricky, but usually most efficient: Most timeouts are
		1380	relatively long compared to the intervals between other activity - in
		1381	our example, within 60 seconds, there are usually many I/O events with
		1382	associated activity resets.
		1383
		1384	In this case, it would be more efficient to leave the C<ev_timer> alone,
		1385	but remember the time of last activity, and check for a real timeout only
		1386	within the callback:
		1387
		1388	ev_tstamp last_activity; // time of last activity
		1389
		1390	static void
		1391	callback (EV_P_ ev_timer *w, int revents)
		1392	{
		1393	ev_tstamp now = ev_now (EV_A);
		1394	ev_tstamp timeout = last_activity + 60.;
		1395
		1396	// if last_activity + 60. is older than now, we did time out
		1397	if (timeout < now)
		1398	{
		1399	// timeout occured, take action
		1400	}
		1401	else
		1402	{
		1403	// callback was invoked, but there was some activity, re-arm
		1404	// the watcher to fire in last_activity + 60, which is
		1405	// guaranteed to be in the future, so "again" is positive:
		1406	w->again = timeout - now;
		1407	ev_timer_again (EV_A_ w);
		1408	}
		1409	}
		1410
		1411	To summarise the callback: first calculate the real timeout (defined
		1412	as "60 seconds after the last activity"), then check if that time has
		1413	been reached, which means something I<did>, in fact, time out. Otherwise
		1414	the callback was invoked too early (C<timeout> is in the future), so
		1415	re-schedule the timer to fire at that future time, to see if maybe we have
		1416	a timeout then.
		1417
		1418	Note how C<ev_timer_again> is used, taking advantage of the
		1419	C<ev_timer_again> optimisation when the timer is already running.
		1420
		1421	This scheme causes more callback invocations (about one every 60 seconds
		1422	minus half the average time between activity), but virtually no calls to
		1423	libev to change the timeout.
		1424
		1425	To start the timer, simply initialise the watcher and set C<last_activity>
		1426	to the current time (meaning we just have some activity :), then call the
		1427	callback, which will "do the right thing" and start the timer:
		1428
		1429	ev_timer_init (timer, callback);
		1430	last_activity = ev_now (loop);
		1431	callback (loop, timer, EV_TIMEOUT);
		1432
		1433	And when there is some activity, simply store the current time in
		1434	C<last_activity>, no libev calls at all:
		1435
		1436	last_actiivty = ev_now (loop);
		1437
		1438	This technique is slightly more complex, but in most cases where the
		1439	time-out is unlikely to be triggered, much more efficient.
		1440
		1441	Changing the timeout is trivial as well (if it isn't hard-coded in the
		1442	callback :) - just change the timeout and invoke the callback, which will
		1443	fix things for you.
		1444
		1445	=item 4. Wee, just use a double-linked list for your timeouts.
		1446
		1447	If there is not one request, but many thousands (millions...), all
		1448	employing some kind of timeout with the same timeout value, then one can
		1449	do even better:
		1450
		1451	When starting the timeout, calculate the timeout value and put the timeout
		1452	at the I<end> of the list.
		1453
		1454	Then use an C<ev_timer> to fire when the timeout at the I<beginning> of
		1455	the list is expected to fire (for example, using the technique #3).
		1456
		1457	When there is some activity, remove the timer from the list, recalculate
		1458	the timeout, append it to the end of the list again, and make sure to
		1459	update the C<ev_timer> if it was taken from the beginning of the list.
		1460
		1461	This way, one can manage an unlimited number of timeouts in O(1) time for
		1462	starting, stopping and updating the timers, at the expense of a major
		1463	complication, and having to use a constant timeout. The constant timeout
		1464	ensures that the list stays sorted.
		1465
		1466	=back
		1467
		1468	So which method the best?
		1469
		1470	Method #2 is a simple no-brain-required solution that is adequate in most
		1471	situations. Method #3 requires a bit more thinking, but handles many cases
		1472	better, and isn't very complicated either. In most case, choosing either
		1473	one is fine, with #3 being better in typical situations.
		1474
		1475	Method #1 is almost always a bad idea, and buys you nothing. Method #4 is
		1476	rather complicated, but extremely efficient, something that really pays
		1477	off after the first million or so of active timers, i.e. it's usually
		1478	overkill :)
1223		1479
1224	=head3 The special problem of time updates	1480	=head3 The special problem of time updates
1225		1481
1226	Establishing the current time is a costly operation (it usually takes at	1482	Establishing the current time is a costly operation (it usually takes at
1227	least two system calls): EV therefore updates its idea of the current	1483	least two system calls): EV therefore updates its idea of the current
1228	time only before and after C<ev_loop> polls for new events, which causes	1484	time only before and after C<ev_loop> collects new events, which causes a
1229	a growing difference between C<ev_now ()> and C<ev_time ()> when handling	1485	growing difference between C<ev_now ()> and C<ev_time ()> when handling
1230	lots of events.	1486	lots of events in one iteration.
1231		1487
1232	The relative timeouts are calculated relative to the C<ev_now ()>	1488	The relative timeouts are calculated relative to the C<ev_now ()>
1233	time. This is usually the right thing as this timestamp refers to the time	1489	time. This is usually the right thing as this timestamp refers to the time
1234	of the event triggering whatever timeout you are modifying/starting. If	1490	of the event triggering whatever timeout you are modifying/starting. If
1235	you suspect event processing to be delayed and you I<need> to base the	1491	you suspect event processing to be delayed and you I<need> to base the
…		…
1271	If the timer is started but non-repeating, stop it (as if it timed out).	1527	If the timer is started but non-repeating, stop it (as if it timed out).
1272		1528
1273	If the timer is repeating, either start it if necessary (with the	1529	If the timer is repeating, either start it if necessary (with the
1274	C<repeat> value), or reset the running timer to the C<repeat> value.	1530	C<repeat> value), or reset the running timer to the C<repeat> value.
1275		1531
1276	This sounds a bit complicated, but here is a useful and typical	1532	This sounds a bit complicated, see "Be smart about timeouts", above, for a
1277	example: Imagine you have a TCP connection and you want a so-called idle	1533	usage example.
1278	timeout, that is, you want to be called when there have been, say, 60
1279	seconds of inactivity on the socket. The easiest way to do this is to
1280	configure an C<ev_timer> with a C<repeat> value of C<60> and then call
1281	C<ev_timer_again> each time you successfully read or write some data. If
1282	you go into an idle state where you do not expect data to travel on the
1283	socket, you can C<ev_timer_stop> the timer, and C<ev_timer_again> will
1284	automatically restart it if need be.
1285
1286	That means you can ignore the C<after> value and C<ev_timer_start>
1287	altogether and only ever use the C<repeat> value and C<ev_timer_again>:
1288
1289	ev_timer_init (timer, callback, 0., 5.);
1290	ev_timer_again (loop, timer);
1291	...
1292	timer->again = 17.;
1293	ev_timer_again (loop, timer);
1294	...
1295	timer->again = 10.;
1296	ev_timer_again (loop, timer);
1297
1298	This is more slightly efficient then stopping/starting the timer each time
1299	you want to modify its timeout value.
1300		1534
1301	=item ev_tstamp repeat [read-write]	1535	=item ev_tstamp repeat [read-write]
1302		1536
1303	The current C<repeat> value. Will be used each time the watcher times out	1537	The current C<repeat> value. Will be used each time the watcher times out
1304	or C<ev_timer_again> is called and determines the next timeout (if any),	1538	or C<ev_timer_again> is called, and determines the next timeout (if any),
1305	which is also when any modifications are taken into account.	1539	which is also when any modifications are taken into account.
1306		1540
1307	=back	1541	=back
1308		1542
1309	=head3 Examples	1543	=head3 Examples
1310		1544
1311	Example: Create a timer that fires after 60 seconds.	1545	Example: Create a timer that fires after 60 seconds.
1312		1546
1313	static void	1547	static void
1314	one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents)	1548	one_minute_cb (struct ev_loop *loop, ev_timer *w, int revents)
1315	{	1549	{
1316	.. one minute over, w is actually stopped right here	1550	.. one minute over, w is actually stopped right here
1317	}	1551	}
1318		1552
1319	struct ev_timer mytimer;	1553	ev_timer mytimer;
1320	ev_timer_init (&mytimer, one_minute_cb, 60., 0.);	1554	ev_timer_init (&mytimer, one_minute_cb, 60., 0.);
1321	ev_timer_start (loop, &mytimer);	1555	ev_timer_start (loop, &mytimer);
1322		1556
1323	Example: Create a timeout timer that times out after 10 seconds of	1557	Example: Create a timeout timer that times out after 10 seconds of
1324	inactivity.	1558	inactivity.
1325		1559
1326	static void	1560	static void
1327	timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents)	1561	timeout_cb (struct ev_loop *loop, ev_timer *w, int revents)
1328	{	1562	{
1329	.. ten seconds without any activity	1563	.. ten seconds without any activity
1330	}	1564	}
1331		1565
1332	struct ev_timer mytimer;	1566	ev_timer mytimer;
1333	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */	1567	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */
1334	ev_timer_again (&mytimer); /* start timer */	1568	ev_timer_again (&mytimer); /* start timer */
1335	ev_loop (loop, 0);	1569	ev_loop (loop, 0);
1336		1570
1337	// and in some piece of code that gets executed on any "activity":	1571	// and in some piece of code that gets executed on any "activity":
…		…
1353	to trigger the event (unlike an C<ev_timer>, which would still trigger	1587	to trigger the event (unlike an C<ev_timer>, which would still trigger
1354	roughly 10 seconds later as it uses a relative timeout).	1588	roughly 10 seconds later as it uses a relative timeout).
1355		1589
1356	C<ev_periodic>s can also be used to implement vastly more complex timers,	1590	C<ev_periodic>s can also be used to implement vastly more complex timers,
1357	such as triggering an event on each "midnight, local time", or other	1591	such as triggering an event on each "midnight, local time", or other
1358	complicated, rules.	1592	complicated rules.
1359		1593
1360	As with timers, the callback is guaranteed to be invoked only when the	1594	As with timers, the callback is guaranteed to be invoked only when the
1361	time (C<at>) has passed, but if multiple periodic timers become ready	1595	time (C<at>) has passed, but if multiple periodic timers become ready
1362	during the same loop iteration then order of execution is undefined.	1596	during the same loop iteration, then order of execution is undefined.
1363		1597
1364	=head3 Watcher-Specific Functions and Data Members	1598	=head3 Watcher-Specific Functions and Data Members
1365		1599
1366	=over 4	1600	=over 4
1367		1601
1368	=item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)	1602	=item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)
1369		1603
1370	=item ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)	1604	=item ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)
1371		1605
1372	Lots of arguments, lets sort it out... There are basically three modes of	1606	Lots of arguments, lets sort it out... There are basically three modes of
1373	operation, and we will explain them from simplest to complex:	1607	operation, and we will explain them from simplest to most complex:
1374		1608
1375	=over 4	1609	=over 4
1376		1610
1377	=item * absolute timer (at = time, interval = reschedule_cb = 0)	1611	=item * absolute timer (at = time, interval = reschedule_cb = 0)
1378		1612
1379	In this configuration the watcher triggers an event after the wall clock	1613	In this configuration the watcher triggers an event after the wall clock
1380	time C<at> has passed and doesn't repeat. It will not adjust when a time	1614	time C<at> has passed. It will not repeat and will not adjust when a time
1381	jump occurs, that is, if it is to be run at January 1st 2011 then it will	1615	jump occurs, that is, if it is to be run at January 1st 2011 then it will
1382	run when the system time reaches or surpasses this time.	1616	only run when the system clock reaches or surpasses this time.
1383		1617
1384	=item * repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)	1618	=item * repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)
1385		1619
1386	In this mode the watcher will always be scheduled to time out at the next	1620	In this mode the watcher will always be scheduled to time out at the next
1387	C<at + N * interval> time (for some integer N, which can also be negative)	1621	C<at + N * interval> time (for some integer N, which can also be negative)
1388	and then repeat, regardless of any time jumps.	1622	and then repeat, regardless of any time jumps.
1389		1623
1390	This can be used to create timers that do not drift with respect to system	1624	This can be used to create timers that do not drift with respect to the
1391	time, for example, here is a C<ev_periodic> that triggers each hour, on	1625	system clock, for example, here is a C<ev_periodic> that triggers each
1392	the hour:	1626	hour, on the hour:
1393		1627
1394	ev_periodic_set (&periodic, 0., 3600., 0);	1628	ev_periodic_set (&periodic, 0., 3600., 0);
1395		1629
1396	This doesn't mean there will always be 3600 seconds in between triggers,	1630	This doesn't mean there will always be 3600 seconds in between triggers,
1397	but only that the callback will be called when the system time shows a	1631	but only that the callback will be called when the system time shows a
…		…
1423		1657
1424	If you need to stop it, return C<now + 1e30> (or so, fudge fudge) and stop	1658	If you need to stop it, return C<now + 1e30> (or so, fudge fudge) and stop
1425	it afterwards (e.g. by starting an C<ev_prepare> watcher, which is the	1659	it afterwards (e.g. by starting an C<ev_prepare> watcher, which is the
1426	only event loop modification you are allowed to do).	1660	only event loop modification you are allowed to do).
1427		1661
1428	The callback prototype is C<ev_tstamp (*reschedule_cb)(struct ev_periodic	1662	The callback prototype is C<ev_tstamp (*reschedule_cb)(ev_periodic
1429	*w, ev_tstamp now)>, e.g.:	1663	*w, ev_tstamp now)>, e.g.:
1430		1664
		1665	static ev_tstamp
1431	static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)	1666	my_rescheduler (ev_periodic *w, ev_tstamp now)
1432	{	1667	{
1433	return now + 60.;	1668	return now + 60.;
1434	}	1669	}
1435		1670
1436	It must return the next time to trigger, based on the passed time value	1671	It must return the next time to trigger, based on the passed time value
…		…
1473		1708
1474	The current interval value. Can be modified any time, but changes only	1709	The current interval value. Can be modified any time, but changes only
1475	take effect when the periodic timer fires or C<ev_periodic_again> is being	1710	take effect when the periodic timer fires or C<ev_periodic_again> is being
1476	called.	1711	called.
1477		1712
1478	=item ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read-write]	1713	=item ev_tstamp (*reschedule_cb)(ev_periodic *w, ev_tstamp now) [read-write]
1479		1714
1480	The current reschedule callback, or C<0>, if this functionality is	1715	The current reschedule callback, or C<0>, if this functionality is
1481	switched off. Can be changed any time, but changes only take effect when	1716	switched off. Can be changed any time, but changes only take effect when
1482	the periodic timer fires or C<ev_periodic_again> is being called.	1717	the periodic timer fires or C<ev_periodic_again> is being called.
1483		1718
1484	=back	1719	=back
1485		1720
1486	=head3 Examples	1721	=head3 Examples
1487		1722
1488	Example: Call a callback every hour, or, more precisely, whenever the	1723	Example: Call a callback every hour, or, more precisely, whenever the
1489	system clock is divisible by 3600. The callback invocation times have	1724	system time is divisible by 3600. The callback invocation times have
1490	potentially a lot of jitter, but good long-term stability.	1725	potentially a lot of jitter, but good long-term stability.
1491		1726
1492	static void	1727	static void
1493	clock_cb (struct ev_loop *loop, struct ev_io *w, int revents)	1728	clock_cb (struct ev_loop *loop, ev_io *w, int revents)
1494	{	1729	{
1495	... its now a full hour (UTC, or TAI or whatever your clock follows)	1730	... its now a full hour (UTC, or TAI or whatever your clock follows)
1496	}	1731	}
1497		1732
1498	struct ev_periodic hourly_tick;	1733	ev_periodic hourly_tick;
1499	ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);	1734	ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);
1500	ev_periodic_start (loop, &hourly_tick);	1735	ev_periodic_start (loop, &hourly_tick);
1501		1736
1502	Example: The same as above, but use a reschedule callback to do it:	1737	Example: The same as above, but use a reschedule callback to do it:
1503		1738
1504	#include <math.h>	1739	#include <math.h>
1505		1740
1506	static ev_tstamp	1741	static ev_tstamp
1507	my_scheduler_cb (struct ev_periodic *w, ev_tstamp now)	1742	my_scheduler_cb (ev_periodic *w, ev_tstamp now)
1508	{	1743	{
1509	return fmod (now, 3600.) + 3600.;	1744	return now + (3600. - fmod (now, 3600.));
1510	}	1745	}
1511		1746
1512	ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);	1747	ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);
1513		1748
1514	Example: Call a callback every hour, starting now:	1749	Example: Call a callback every hour, starting now:
1515		1750
1516	struct ev_periodic hourly_tick;	1751	ev_periodic hourly_tick;
1517	ev_periodic_init (&hourly_tick, clock_cb,	1752	ev_periodic_init (&hourly_tick, clock_cb,
1518	fmod (ev_now (loop), 3600.), 3600., 0);	1753	fmod (ev_now (loop), 3600.), 3600., 0);
1519	ev_periodic_start (loop, &hourly_tick);	1754	ev_periodic_start (loop, &hourly_tick);
1520		1755
1521		1756
…		…
1524	Signal watchers will trigger an event when the process receives a specific	1759	Signal watchers will trigger an event when the process receives a specific
1525	signal one or more times. Even though signals are very asynchronous, libev	1760	signal one or more times. Even though signals are very asynchronous, libev
1526	will try it's best to deliver signals synchronously, i.e. as part of the	1761	will try it's best to deliver signals synchronously, i.e. as part of the
1527	normal event processing, like any other event.	1762	normal event processing, like any other event.
1528		1763
		1764	If you want signals asynchronously, just use C<sigaction> as you would
		1765	do without libev and forget about sharing the signal. You can even use
		1766	C<ev_async> from a signal handler to synchronously wake up an event loop.
		1767
1529	You can configure as many watchers as you like per signal. Only when the	1768	You can configure as many watchers as you like per signal. Only when the
1530	first watcher gets started will libev actually register a signal watcher	1769	first watcher gets started will libev actually register a signal handler
1531	with the kernel (thus it coexists with your own signal handlers as long	1770	with the kernel (thus it coexists with your own signal handlers as long as
1532	as you don't register any with libev). Similarly, when the last signal	1771	you don't register any with libev for the same signal). Similarly, when
1533	watcher for a signal is stopped libev will reset the signal handler to	1772	the last signal watcher for a signal is stopped, libev will reset the
1534	SIG_DFL (regardless of what it was set to before).	1773	signal handler to SIG_DFL (regardless of what it was set to before).
1535		1774
1536	If possible and supported, libev will install its handlers with	1775	If possible and supported, libev will install its handlers with
1537	C<SA_RESTART> behaviour enabled, so system calls should not be unduly	1776	C<SA_RESTART> behaviour enabled, so system calls should not be unduly
1538	interrupted. If you have a problem with system calls getting interrupted by	1777	interrupted. If you have a problem with system calls getting interrupted by
1539	signals you can block all signals in an C<ev_check> watcher and unblock	1778	signals you can block all signals in an C<ev_check> watcher and unblock
…		…
1556		1795
1557	=back	1796	=back
1558		1797
1559	=head3 Examples	1798	=head3 Examples
1560		1799
1561	Example: Try to exit cleanly on SIGINT and SIGTERM.	1800	Example: Try to exit cleanly on SIGINT.
1562		1801
1563	static void	1802	static void
1564	sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)	1803	sigint_cb (struct ev_loop *loop, ev_signal *w, int revents)
1565	{	1804	{
1566	ev_unloop (loop, EVUNLOOP_ALL);	1805	ev_unloop (loop, EVUNLOOP_ALL);
1567	}	1806	}
1568		1807
1569	struct ev_signal signal_watcher;	1808	ev_signal signal_watcher;
1570	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);	1809	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
1571	ev_signal_start (loop, &sigint_cb);	1810	ev_signal_start (loop, &signal_watcher);
1572		1811
1573		1812
1574	=head2 C<ev_child> - watch out for process status changes	1813	=head2 C<ev_child> - watch out for process status changes
1575		1814
1576	Child watchers trigger when your process receives a SIGCHLD in response to	1815	Child watchers trigger when your process receives a SIGCHLD in response to
1577	some child status changes (most typically when a child of yours dies). It	1816	some child status changes (most typically when a child of yours dies or
1578	is permissible to install a child watcher I<after> the child has been	1817	exits). It is permissible to install a child watcher I<after> the child
1579	forked (which implies it might have already exited), as long as the event	1818	has been forked (which implies it might have already exited), as long
1580	loop isn't entered (or is continued from a watcher).	1819	as the event loop isn't entered (or is continued from a watcher), i.e.,
		1820	forking and then immediately registering a watcher for the child is fine,
		1821	but forking and registering a watcher a few event loop iterations later is
		1822	not.
1581		1823
1582	Only the default event loop is capable of handling signals, and therefore	1824	Only the default event loop is capable of handling signals, and therefore
1583	you can only register child watchers in the default event loop.	1825	you can only register child watchers in the default event loop.
1584		1826
1585	=head3 Process Interaction	1827	=head3 Process Interaction
…		…
1646	its completion.	1888	its completion.
1647		1889
1648	ev_child cw;	1890	ev_child cw;
1649		1891
1650	static void	1892	static void
1651	child_cb (EV_P_ struct ev_child *w, int revents)	1893	child_cb (EV_P_ ev_child *w, int revents)
1652	{	1894	{
1653	ev_child_stop (EV_A_ w);	1895	ev_child_stop (EV_A_ w);
1654	printf ("process %d exited with status %x\n", w->rpid, w->rstatus);	1896	printf ("process %d exited with status %x\n", w->rpid, w->rstatus);
1655	}	1897	}
1656		1898
…		…
1683	the stat buffer having unspecified contents.	1925	the stat buffer having unspecified contents.
1684		1926
1685	The path I<should> be absolute and I<must not> end in a slash. If it is	1927	The path I<should> be absolute and I<must not> end in a slash. If it is
1686	relative and your working directory changes, the behaviour is undefined.	1928	relative and your working directory changes, the behaviour is undefined.
1687		1929
1688	Since there is no standard to do this, the portable implementation simply	1930	Since there is no standard kernel interface to do this, the portable
1689	calls C<stat (2)> regularly on the path to see if it changed somehow. You	1931	implementation simply calls C<stat (2)> regularly on the path to see if
1690	can specify a recommended polling interval for this case. If you specify	1932	it changed somehow. You can specify a recommended polling interval for
1691	a polling interval of C<0> (highly recommended!) then a I<suitable,	1933	this case. If you specify a polling interval of C<0> (highly recommended!)
1692	unspecified default> value will be used (which you can expect to be around	1934	then a I<suitable, unspecified default> value will be used (which
1693	five seconds, although this might change dynamically). Libev will also	1935	you can expect to be around five seconds, although this might change
1694	impose a minimum interval which is currently around C<0.1>, but thats	1936	dynamically). Libev will also impose a minimum interval which is currently
1695	usually overkill.	1937	around C<0.1>, but thats usually overkill.
1696		1938
1697	This watcher type is not meant for massive numbers of stat watchers,	1939	This watcher type is not meant for massive numbers of stat watchers,
1698	as even with OS-supported change notifications, this can be	1940	as even with OS-supported change notifications, this can be
1699	resource-intensive.	1941	resource-intensive.
1700		1942
1701	At the time of this writing, only the Linux inotify interface is	1943	At the time of this writing, the only OS-specific interface implemented
1702	implemented (implementing kqueue support is left as an exercise for the	1944	is the Linux inotify interface (implementing kqueue support is left as
1703	reader, note, however, that the author sees no way of implementing ev_stat	1945	an exercise for the reader. Note, however, that the author sees no way
1704	semantics with kqueue). Inotify will be used to give hints only and should	1946	of implementing C<ev_stat> semantics with kqueue).
1705	not change the semantics of C<ev_stat> watchers, which means that libev
1706	sometimes needs to fall back to regular polling again even with inotify,
1707	but changes are usually detected immediately, and if the file exists there
1708	will be no polling.
1709		1947
1710	=head3 ABI Issues (Largefile Support)	1948	=head3 ABI Issues (Largefile Support)
1711		1949
1712	Libev by default (unless the user overrides this) uses the default	1950	Libev by default (unless the user overrides this) uses the default
1713	compilation environment, which means that on systems with large file	1951	compilation environment, which means that on systems with large file
…		…
1722	file interfaces available by default (as e.g. FreeBSD does) and not	1960	file interfaces available by default (as e.g. FreeBSD does) and not
1723	optional. Libev cannot simply switch on large file support because it has	1961	optional. Libev cannot simply switch on large file support because it has
1724	to exchange stat structures with application programs compiled using the	1962	to exchange stat structures with application programs compiled using the
1725	default compilation environment.	1963	default compilation environment.
1726		1964
1727	=head3 Inotify	1965	=head3 Inotify and Kqueue
1728		1966
1729	When C<inotify (7)> support has been compiled into libev (generally only	1967	When C<inotify (7)> support has been compiled into libev (generally
		1968	only available with Linux 2.6.25 or above due to bugs in earlier
1730	available on Linux) and present at runtime, it will be used to speed up	1969	implementations) and present at runtime, it will be used to speed up
1731	change detection where possible. The inotify descriptor will be created lazily	1970	change detection where possible. The inotify descriptor will be created
1732	when the first C<ev_stat> watcher is being started.	1971	lazily when the first C<ev_stat> watcher is being started.
1733		1972
1734	Inotify presence does not change the semantics of C<ev_stat> watchers	1973	Inotify presence does not change the semantics of C<ev_stat> watchers
1735	except that changes might be detected earlier, and in some cases, to avoid	1974	except that changes might be detected earlier, and in some cases, to avoid
1736	making regular C<stat> calls. Even in the presence of inotify support	1975	making regular C<stat> calls. Even in the presence of inotify support
1737	there are many cases where libev has to resort to regular C<stat> polling.	1976	there are many cases where libev has to resort to regular C<stat> polling,
		1977	but as long as the path exists, libev usually gets away without polling.
1738		1978
1739	(There is no support for kqueue, as apparently it cannot be used to	1979	There is no support for kqueue, as apparently it cannot be used to
1740	implement this functionality, due to the requirement of having a file	1980	implement this functionality, due to the requirement of having a file
1741	descriptor open on the object at all times).	1981	descriptor open on the object at all times, and detecting renames, unlinks
		1982	etc. is difficult.
1742		1983
1743	=head3 The special problem of stat time resolution	1984	=head3 The special problem of stat time resolution
1744		1985
1745	The C<stat ()> system call only supports full-second resolution portably, and	1986	The C<stat ()> system call only supports full-second resolution portably, and
1746	even on systems where the resolution is higher, many file systems still	1987	even on systems where the resolution is higher, most file systems still
1747	only support whole seconds.	1988	only support whole seconds.
1748		1989
1749	That means that, if the time is the only thing that changes, you can	1990	That means that, if the time is the only thing that changes, you can
1750	easily miss updates: on the first update, C<ev_stat> detects a change and	1991	easily miss updates: on the first update, C<ev_stat> detects a change and
1751	calls your callback, which does something. When there is another update	1992	calls your callback, which does something. When there is another update
1752	within the same second, C<ev_stat> will be unable to detect it as the stat	1993	within the same second, C<ev_stat> will be unable to detect unless the
1753	data does not change.	1994	stat data does change in other ways (e.g. file size).
1754		1995
1755	The solution to this is to delay acting on a change for slightly more	1996	The solution to this is to delay acting on a change for slightly more
1756	than a second (or till slightly after the next full second boundary), using	1997	than a second (or till slightly after the next full second boundary), using
1757	a roughly one-second-delay C<ev_timer> (e.g. C<ev_timer_set (w, 0., 1.02);	1998	a roughly one-second-delay C<ev_timer> (e.g. C<ev_timer_set (w, 0., 1.02);
1758	ev_timer_again (loop, w)>).	1999	ev_timer_again (loop, w)>).
…		…
1778	C<path>. The C<interval> is a hint on how quickly a change is expected to	2019	C<path>. The C<interval> is a hint on how quickly a change is expected to
1779	be detected and should normally be specified as C<0> to let libev choose	2020	be detected and should normally be specified as C<0> to let libev choose
1780	a suitable value. The memory pointed to by C<path> must point to the same	2021	a suitable value. The memory pointed to by C<path> must point to the same
1781	path for as long as the watcher is active.	2022	path for as long as the watcher is active.
1782		2023
1783	The callback will receive C<EV_STAT> when a change was detected, relative	2024	The callback will receive an C<EV_STAT> event when a change was detected,
1784	to the attributes at the time the watcher was started (or the last change	2025	relative to the attributes at the time the watcher was started (or the
1785	was detected).	2026	last change was detected).
1786		2027
1787	=item ev_stat_stat (loop, ev_stat *)	2028	=item ev_stat_stat (loop, ev_stat *)
1788		2029
1789	Updates the stat buffer immediately with new values. If you change the	2030	Updates the stat buffer immediately with new values. If you change the
1790	watched path in your callback, you could call this function to avoid	2031	watched path in your callback, you could call this function to avoid
…		…
1873		2114
1874		2115
1875	=head2 C<ev_idle> - when you've got nothing better to do...	2116	=head2 C<ev_idle> - when you've got nothing better to do...
1876		2117
1877	Idle watchers trigger events when no other events of the same or higher	2118	Idle watchers trigger events when no other events of the same or higher
1878	priority are pending (prepare, check and other idle watchers do not	2119	priority are pending (prepare, check and other idle watchers do not count
1879	count).	2120	as receiving "events").
1880		2121
1881	That is, as long as your process is busy handling sockets or timeouts	2122	That is, as long as your process is busy handling sockets or timeouts
1882	(or even signals, imagine) of the same or higher priority it will not be	2123	(or even signals, imagine) of the same or higher priority it will not be
1883	triggered. But when your process is idle (or only lower-priority watchers	2124	triggered. But when your process is idle (or only lower-priority watchers
1884	are pending), the idle watchers are being called once per event loop	2125	are pending), the idle watchers are being called once per event loop
…		…
1909		2150
1910	Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the	2151	Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the
1911	callback, free it. Also, use no error checking, as usual.	2152	callback, free it. Also, use no error checking, as usual.
1912		2153
1913	static void	2154	static void
1914	idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents)	2155	idle_cb (struct ev_loop *loop, ev_idle *w, int revents)
1915	{	2156	{
1916	free (w);	2157	free (w);
1917	// now do something you wanted to do when the program has	2158	// now do something you wanted to do when the program has
1918	// no longer anything immediate to do.	2159	// no longer anything immediate to do.
1919	}	2160	}
1920		2161
1921	struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle));	2162	ev_idle *idle_watcher = malloc (sizeof (ev_idle));
1922	ev_idle_init (idle_watcher, idle_cb);	2163	ev_idle_init (idle_watcher, idle_cb);
1923	ev_idle_start (loop, idle_cb);	2164	ev_idle_start (loop, idle_cb);
1924		2165
1925		2166
1926	=head2 C<ev_prepare> and C<ev_check> - customise your event loop!	2167	=head2 C<ev_prepare> and C<ev_check> - customise your event loop!
1927		2168
1928	Prepare and check watchers are usually (but not always) used in tandem:	2169	Prepare and check watchers are usually (but not always) used in pairs:
1929	prepare watchers get invoked before the process blocks and check watchers	2170	prepare watchers get invoked before the process blocks and check watchers
1930	afterwards.	2171	afterwards.
1931		2172
1932	You I<must not> call C<ev_loop> or similar functions that enter	2173	You I<must not> call C<ev_loop> or similar functions that enter
1933	the current event loop from either C<ev_prepare> or C<ev_check>	2174	the current event loop from either C<ev_prepare> or C<ev_check>
…		…
1936	those watchers, i.e. the sequence will always be C<ev_prepare>, blocking,	2177	those watchers, i.e. the sequence will always be C<ev_prepare>, blocking,
1937	C<ev_check> so if you have one watcher of each kind they will always be	2178	C<ev_check> so if you have one watcher of each kind they will always be
1938	called in pairs bracketing the blocking call.	2179	called in pairs bracketing the blocking call.
1939		2180
1940	Their main purpose is to integrate other event mechanisms into libev and	2181	Their main purpose is to integrate other event mechanisms into libev and
1941	their use is somewhat advanced. This could be used, for example, to track	2182	their use is somewhat advanced. They could be used, for example, to track
1942	variable changes, implement your own watchers, integrate net-snmp or a	2183	variable changes, implement your own watchers, integrate net-snmp or a
1943	coroutine library and lots more. They are also occasionally useful if	2184	coroutine library and lots more. They are also occasionally useful if
1944	you cache some data and want to flush it before blocking (for example,	2185	you cache some data and want to flush it before blocking (for example,
1945	in X programs you might want to do an C<XFlush ()> in an C<ev_prepare>	2186	in X programs you might want to do an C<XFlush ()> in an C<ev_prepare>
1946	watcher).	2187	watcher).
1947		2188
1948	This is done by examining in each prepare call which file descriptors need	2189	This is done by examining in each prepare call which file descriptors
1949	to be watched by the other library, registering C<ev_io> watchers for	2190	need to be watched by the other library, registering C<ev_io> watchers
1950	them and starting an C<ev_timer> watcher for any timeouts (many libraries	2191	for them and starting an C<ev_timer> watcher for any timeouts (many
1951	provide just this functionality). Then, in the check watcher you check for	2192	libraries provide exactly this functionality). Then, in the check watcher,
1952	any events that occurred (by checking the pending status of all watchers	2193	you check for any events that occurred (by checking the pending status
1953	and stopping them) and call back into the library. The I/O and timer	2194	of all watchers and stopping them) and call back into the library. The
1954	callbacks will never actually be called (but must be valid nevertheless,	2195	I/O and timer callbacks will never actually be called (but must be valid
1955	because you never know, you know?).	2196	nevertheless, because you never know, you know?).
1956		2197
1957	As another example, the Perl Coro module uses these hooks to integrate	2198	As another example, the Perl Coro module uses these hooks to integrate
1958	coroutines into libev programs, by yielding to other active coroutines	2199	coroutines into libev programs, by yielding to other active coroutines
1959	during each prepare and only letting the process block if no coroutines	2200	during each prepare and only letting the process block if no coroutines
1960	are ready to run (it's actually more complicated: it only runs coroutines	2201	are ready to run (it's actually more complicated: it only runs coroutines
…		…
1963	loop from blocking if lower-priority coroutines are active, thus mapping	2204	loop from blocking if lower-priority coroutines are active, thus mapping
1964	low-priority coroutines to idle/background tasks).	2205	low-priority coroutines to idle/background tasks).
1965		2206
1966	It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>)	2207	It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>)
1967	priority, to ensure that they are being run before any other watchers	2208	priority, to ensure that they are being run before any other watchers
		2209	after the poll (this doesn't matter for C<ev_prepare> watchers).
		2210
1968	after the poll. Also, C<ev_check> watchers (and C<ev_prepare> watchers,	2211	Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not
1969	too) should not activate ("feed") events into libev. While libev fully	2212	activate ("feed") events into libev. While libev fully supports this, they
1970	supports this, they might get executed before other C<ev_check> watchers	2213	might get executed before other C<ev_check> watchers did their job. As
1971	did their job. As C<ev_check> watchers are often used to embed other	2214	C<ev_check> watchers are often used to embed other (non-libev) event
1972	(non-libev) event loops those other event loops might be in an unusable	2215	loops those other event loops might be in an unusable state until their
1973	state until their C<ev_check> watcher ran (always remind yourself to	2216	C<ev_check> watcher ran (always remind yourself to coexist peacefully with
1974	coexist peacefully with others).	2217	others).
1975		2218
1976	=head3 Watcher-Specific Functions and Data Members	2219	=head3 Watcher-Specific Functions and Data Members
1977		2220
1978	=over 4	2221	=over 4
1979		2222
…		…
1981		2224
1982	=item ev_check_init (ev_check *, callback)	2225	=item ev_check_init (ev_check *, callback)
1983		2226
1984	Initialises and configures the prepare or check watcher - they have no	2227	Initialises and configures the prepare or check watcher - they have no
1985	parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>	2228	parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>
1986	macros, but using them is utterly, utterly and completely pointless.	2229	macros, but using them is utterly, utterly, utterly and completely
		2230	pointless.
1987		2231
1988	=back	2232	=back
1989		2233
1990	=head3 Examples	2234	=head3 Examples
1991		2235
…		…
2004		2248
2005	static ev_io iow [nfd];	2249	static ev_io iow [nfd];
2006	static ev_timer tw;	2250	static ev_timer tw;
2007		2251
2008	static void	2252	static void
2009	io_cb (ev_loop *loop, ev_io *w, int revents)	2253	io_cb (struct ev_loop *loop, ev_io *w, int revents)
2010	{	2254	{
2011	}	2255	}
2012		2256
2013	// create io watchers for each fd and a timer before blocking	2257	// create io watchers for each fd and a timer before blocking
2014	static void	2258	static void
2015	adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents)	2259	adns_prepare_cb (struct ev_loop *loop, ev_prepare *w, int revents)
2016	{	2260	{
2017	int timeout = 3600000;	2261	int timeout = 3600000;
2018	struct pollfd fds [nfd];	2262	struct pollfd fds [nfd];
2019	// actual code will need to loop here and realloc etc.	2263	// actual code will need to loop here and realloc etc.
2020	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));	2264	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
…		…
2035	}	2279	}
2036	}	2280	}
2037		2281
2038	// stop all watchers after blocking	2282	// stop all watchers after blocking
2039	static void	2283	static void
2040	adns_check_cb (ev_loop *loop, ev_check *w, int revents)	2284	adns_check_cb (struct ev_loop *loop, ev_check *w, int revents)
2041	{	2285	{
2042	ev_timer_stop (loop, &tw);	2286	ev_timer_stop (loop, &tw);
2043		2287
2044	for (int i = 0; i < nfd; ++i)	2288	for (int i = 0; i < nfd; ++i)
2045	{	2289	{
…		…
2084	}	2328	}
2085		2329
2086	// do not ever call adns_afterpoll	2330	// do not ever call adns_afterpoll
2087		2331
2088	Method 4: Do not use a prepare or check watcher because the module you	2332	Method 4: Do not use a prepare or check watcher because the module you
2089	want to embed is too inflexible to support it. Instead, you can override	2333	want to embed is not flexible enough to support it. Instead, you can
2090	their poll function. The drawback with this solution is that the main	2334	override their poll function. The drawback with this solution is that the
2091	loop is now no longer controllable by EV. The C<Glib::EV> module does	2335	main loop is now no longer controllable by EV. The C<Glib::EV> module uses
2092	this.	2336	this approach, effectively embedding EV as a client into the horrible
		2337	libglib event loop.
2093		2338
2094	static gint	2339	static gint
2095	event_poll_func (GPollFD *fds, guint nfds, gint timeout)	2340	event_poll_func (GPollFD *fds, guint nfds, gint timeout)
2096	{	2341	{
2097	int got_events = 0;	2342	int got_events = 0;
…		…
2128	prioritise I/O.	2373	prioritise I/O.
2129		2374
2130	As an example for a bug workaround, the kqueue backend might only support	2375	As an example for a bug workaround, the kqueue backend might only support
2131	sockets on some platform, so it is unusable as generic backend, but you	2376	sockets on some platform, so it is unusable as generic backend, but you
2132	still want to make use of it because you have many sockets and it scales	2377	still want to make use of it because you have many sockets and it scales
2133	so nicely. In this case, you would create a kqueue-based loop and embed it	2378	so nicely. In this case, you would create a kqueue-based loop and embed
2134	into your default loop (which might use e.g. poll). Overall operation will	2379	it into your default loop (which might use e.g. poll). Overall operation
2135	be a bit slower because first libev has to poll and then call kevent, but	2380	will be a bit slower because first libev has to call C<poll> and then
2136	at least you can use both at what they are best.	2381	C<kevent>, but at least you can use both mechanisms for what they are
		2382	best: C<kqueue> for scalable sockets and C<poll> if you want it to work :)
2137		2383
2138	As for prioritising I/O: rarely you have the case where some fds have	2384	As for prioritising I/O: under rare circumstances you have the case where
2139	to be watched and handled very quickly (with low latency), and even	2385	some fds have to be watched and handled very quickly (with low latency),
2140	priorities and idle watchers might have too much overhead. In this case	2386	and even priorities and idle watchers might have too much overhead. In
2141	you would put all the high priority stuff in one loop and all the rest in	2387	this case you would put all the high priority stuff in one loop and all
2142	a second one, and embed the second one in the first.	2388	the rest in a second one, and embed the second one in the first.
2143		2389
2144	As long as the watcher is active, the callback will be invoked every time	2390	As long as the watcher is active, the callback will be invoked every time
2145	there might be events pending in the embedded loop. The callback must then	2391	there might be events pending in the embedded loop. The callback must then
2146	call C<ev_embed_sweep (mainloop, watcher)> to make a single sweep and invoke	2392	call C<ev_embed_sweep (mainloop, watcher)> to make a single sweep and invoke
2147	their callbacks (you could also start an idle watcher to give the embedded	2393	their callbacks (you could also start an idle watcher to give the embedded
…		…
2155	interested in that.	2401	interested in that.
2156		2402
2157	Also, there have not currently been made special provisions for forking:	2403	Also, there have not currently been made special provisions for forking:
2158	when you fork, you not only have to call C<ev_loop_fork> on both loops,	2404	when you fork, you not only have to call C<ev_loop_fork> on both loops,
2159	but you will also have to stop and restart any C<ev_embed> watchers	2405	but you will also have to stop and restart any C<ev_embed> watchers
2160	yourself.	2406	yourself - but you can use a fork watcher to handle this automatically,
		2407	and future versions of libev might do just that.
2161		2408
2162	Unfortunately, not all backends are embeddable, only the ones returned by	2409	Unfortunately, not all backends are embeddable: only the ones returned by
2163	C<ev_embeddable_backends> are, which, unfortunately, does not include any	2410	C<ev_embeddable_backends> are, which, unfortunately, does not include any
2164	portable one.	2411	portable one.
2165		2412
2166	So when you want to use this feature you will always have to be prepared	2413	So when you want to use this feature you will always have to be prepared
2167	that you cannot get an embeddable loop. The recommended way to get around	2414	that you cannot get an embeddable loop. The recommended way to get around
2168	this is to have a separate variables for your embeddable loop, try to	2415	this is to have a separate variables for your embeddable loop, try to
2169	create it, and if that fails, use the normal loop for everything.	2416	create it, and if that fails, use the normal loop for everything.
		2417
		2418	=head3 C<ev_embed> and fork
		2419
		2420	While the C<ev_embed> watcher is running, forks in the embedding loop will
		2421	automatically be applied to the embedded loop as well, so no special
		2422	fork handling is required in that case. When the watcher is not running,
		2423	however, it is still the task of the libev user to call C<ev_loop_fork ()>
		2424	as applicable.
2170		2425
2171	=head3 Watcher-Specific Functions and Data Members	2426	=head3 Watcher-Specific Functions and Data Members
2172		2427
2173	=over 4	2428	=over 4
2174		2429
…		…
2202	C<loop_lo> (which is C<loop_hi> in the case no embeddable loop can be	2457	C<loop_lo> (which is C<loop_hi> in the case no embeddable loop can be
2203	used).	2458	used).
2204		2459
2205	struct ev_loop *loop_hi = ev_default_init (0);	2460	struct ev_loop *loop_hi = ev_default_init (0);
2206	struct ev_loop *loop_lo = 0;	2461	struct ev_loop *loop_lo = 0;
2207	struct ev_embed embed;	2462	ev_embed embed;
2208		2463
2209	// see if there is a chance of getting one that works	2464	// see if there is a chance of getting one that works
2210	// (remember that a flags value of 0 means autodetection)	2465	// (remember that a flags value of 0 means autodetection)
2211	loop_lo = ev_embeddable_backends () & ev_recommended_backends ()	2466	loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
2212	? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())	2467	? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
…		…
2226	kqueue implementation). Store the kqueue/socket-only event loop in	2481	kqueue implementation). Store the kqueue/socket-only event loop in
2227	C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).	2482	C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).
2228		2483
2229	struct ev_loop *loop = ev_default_init (0);	2484	struct ev_loop *loop = ev_default_init (0);
2230	struct ev_loop *loop_socket = 0;	2485	struct ev_loop *loop_socket = 0;
2231	struct ev_embed embed;	2486	ev_embed embed;
2232		2487
2233	if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)	2488	if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
2234	if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))	2489	if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
2235	{	2490	{
2236	ev_embed_init (&embed, 0, loop_socket);	2491	ev_embed_init (&embed, 0, loop_socket);
…		…
2292	is that the author does not know of a simple (or any) algorithm for a	2547	is that the author does not know of a simple (or any) algorithm for a
2293	multiple-writer-single-reader queue that works in all cases and doesn't	2548	multiple-writer-single-reader queue that works in all cases and doesn't
2294	need elaborate support such as pthreads.	2549	need elaborate support such as pthreads.
2295		2550
2296	That means that if you want to queue data, you have to provide your own	2551	That means that if you want to queue data, you have to provide your own
2297	queue. But at least I can tell you would implement locking around your	2552	queue. But at least I can tell you how to implement locking around your
2298	queue:	2553	queue:
2299		2554
2300	=over 4	2555	=over 4
2301		2556
2302	=item queueing from a signal handler context	2557	=item queueing from a signal handler context
2303		2558
2304	To implement race-free queueing, you simply add to the queue in the signal	2559	To implement race-free queueing, you simply add to the queue in the signal
2305	handler but you block the signal handler in the watcher callback. Here is an example that does that for	2560	handler but you block the signal handler in the watcher callback. Here is
2306	some fictitious SIGUSR1 handler:	2561	an example that does that for some fictitious SIGUSR1 handler:
2307		2562
2308	static ev_async mysig;	2563	static ev_async mysig;
2309		2564
2310	static void	2565	static void
2311	sigusr1_handler (void)	2566	sigusr1_handler (void)
…		…
2378		2633
2379	=item ev_async_init (ev_async *, callback)	2634	=item ev_async_init (ev_async *, callback)
2380		2635
2381	Initialises and configures the async watcher - it has no parameters of any	2636	Initialises and configures the async watcher - it has no parameters of any
2382	kind. There is a C<ev_asynd_set> macro, but using it is utterly pointless,	2637	kind. There is a C<ev_asynd_set> macro, but using it is utterly pointless,
2383	believe me.	2638	trust me.
2384		2639
2385	=item ev_async_send (loop, ev_async *)	2640	=item ev_async_send (loop, ev_async *)
2386		2641
2387	Sends/signals/activates the given C<ev_async> watcher, that is, feeds	2642	Sends/signals/activates the given C<ev_async> watcher, that is, feeds
2388	an C<EV_ASYNC> event on the watcher into the event loop. Unlike	2643	an C<EV_ASYNC> event on the watcher into the event loop. Unlike
2389	C<ev_feed_event>, this call is safe to do in other threads, signal or	2644	C<ev_feed_event>, this call is safe to do from other threads, signal or
2390	similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding	2645	similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding
2391	section below on what exactly this means).	2646	section below on what exactly this means).
2392		2647
2393	This call incurs the overhead of a system call only once per loop iteration,	2648	This call incurs the overhead of a system call only once per loop iteration,
2394	so while the overhead might be noticeable, it doesn't apply to repeated	2649	so while the overhead might be noticeable, it doesn't apply to repeated
…		…
2418	=over 4	2673	=over 4
2419		2674
2420	=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback)	2675	=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback)
2421		2676
2422	This function combines a simple timer and an I/O watcher, calls your	2677	This function combines a simple timer and an I/O watcher, calls your
2423	callback on whichever event happens first and automatically stop both	2678	callback on whichever event happens first and automatically stops both
2424	watchers. This is useful if you want to wait for a single event on an fd	2679	watchers. This is useful if you want to wait for a single event on an fd
2425	or timeout without having to allocate/configure/start/stop/free one or	2680	or timeout without having to allocate/configure/start/stop/free one or
2426	more watchers yourself.	2681	more watchers yourself.
2427		2682
2428	If C<fd> is less than 0, then no I/O watcher will be started and events	2683	If C<fd> is less than 0, then no I/O watcher will be started and the
2429	is being ignored. Otherwise, an C<ev_io> watcher for the given C<fd> and	2684	C<events> argument is being ignored. Otherwise, an C<ev_io> watcher for
2430	C<events> set will be created and started.	2685	the given C<fd> and C<events> set will be created and started.
2431		2686
2432	If C<timeout> is less than 0, then no timeout watcher will be	2687	If C<timeout> is less than 0, then no timeout watcher will be
2433	started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and	2688	started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and
2434	repeat = 0) will be started. While C<0> is a valid timeout, it is of	2689	repeat = 0) will be started. C<0> is a valid timeout.
2435	dubious value.
2436		2690
2437	The callback has the type C<void (*cb)(int revents, void *arg)> and gets	2691	The callback has the type C<void (*cb)(int revents, void *arg)> and gets
2438	passed an C<revents> set like normal event callbacks (a combination of	2692	passed an C<revents> set like normal event callbacks (a combination of
2439	C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg>	2693	C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg>
2440	value passed to C<ev_once>:	2694	value passed to C<ev_once>. Note that it is possible to receive I<both>
		2695	a timeout and an io event at the same time - you probably should give io
		2696	events precedence.
		2697
		2698	Example: wait up to ten seconds for data to appear on STDIN_FILENO.
2441		2699
2442	static void stdin_ready (int revents, void *arg)	2700	static void stdin_ready (int revents, void *arg)
2443	{	2701	{
		2702	if (revents & EV_READ)
		2703	/* stdin might have data for us, joy! */;
2444	if (revents & EV_TIMEOUT)	2704	else if (revents & EV_TIMEOUT)
2445	/* doh, nothing entered */;	2705	/* doh, nothing entered */;
2446	else if (revents & EV_READ)
2447	/* stdin might have data for us, joy! */;
2448	}	2706	}
2449		2707
2450	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);	2708	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
2451		2709
2452	=item ev_feed_event (ev_loop *, watcher *, int revents)	2710	=item ev_feed_event (struct ev_loop *, watcher *, int revents)
2453		2711
2454	Feeds the given event set into the event loop, as if the specified event	2712	Feeds the given event set into the event loop, as if the specified event
2455	had happened for the specified watcher (which must be a pointer to an	2713	had happened for the specified watcher (which must be a pointer to an
2456	initialised but not necessarily started event watcher).	2714	initialised but not necessarily started event watcher).
2457		2715
2458	=item ev_feed_fd_event (ev_loop *, int fd, int revents)	2716	=item ev_feed_fd_event (struct ev_loop *, int fd, int revents)
2459		2717
2460	Feed an event on the given fd, as if a file descriptor backend detected	2718	Feed an event on the given fd, as if a file descriptor backend detected
2461	the given events it.	2719	the given events it.
2462		2720
2463	=item ev_feed_signal_event (ev_loop *loop, int signum)	2721	=item ev_feed_signal_event (struct ev_loop *loop, int signum)
2464		2722
2465	Feed an event as if the given signal occurred (C<loop> must be the default	2723	Feed an event as if the given signal occurred (C<loop> must be the default
2466	loop!).	2724	loop!).
2467		2725
2468	=back	2726	=back
…		…
2600		2858
2601	The prototype of the C<function> must be C<void (*)(ev::TYPE &w, int)>.	2859	The prototype of the C<function> must be C<void (*)(ev::TYPE &w, int)>.
2602		2860
2603	See the method-C<set> above for more details.	2861	See the method-C<set> above for more details.
2604		2862
2605	Example:	2863	Example: Use a plain function as callback.
2606		2864
2607	static void io_cb (ev::io &w, int revents) { }	2865	static void io_cb (ev::io &w, int revents) { }
2608	iow.set <io_cb> ();	2866	iow.set <io_cb> ();
2609		2867
2610	=item w->set (struct ev_loop *)	2868	=item w->set (struct ev_loop *)
…		…
2648	Example: Define a class with an IO and idle watcher, start one of them in	2906	Example: Define a class with an IO and idle watcher, start one of them in
2649	the constructor.	2907	the constructor.
2650		2908
2651	class myclass	2909	class myclass
2652	{	2910	{
2653	ev::io io; void io_cb (ev::io &w, int revents);	2911	ev::io io ; void io_cb (ev::io &w, int revents);
2654	ev:idle idle void idle_cb (ev::idle &w, int revents);	2912	ev::idle idle; void idle_cb (ev::idle &w, int revents);
2655		2913
2656	myclass (int fd)	2914	myclass (int fd)
2657	{	2915	{
2658	io .set <myclass, &myclass::io_cb > (this);	2916	io .set <myclass, &myclass::io_cb > (this);
2659	idle.set <myclass, &myclass::idle_cb> (this);	2917	idle.set <myclass, &myclass::idle_cb> (this);
…		…
2675	=item Perl	2933	=item Perl
2676		2934
2677	The EV module implements the full libev API and is actually used to test	2935	The EV module implements the full libev API and is actually used to test
2678	libev. EV is developed together with libev. Apart from the EV core module,	2936	libev. EV is developed together with libev. Apart from the EV core module,
2679	there are additional modules that implement libev-compatible interfaces	2937	there are additional modules that implement libev-compatible interfaces
2680	to C<libadns> (C<EV::ADNS>), C<Net::SNMP> (C<Net::SNMP::EV>) and the	2938	to C<libadns> (C<EV::ADNS>, but C<AnyEvent::DNS> is preferred nowadays),
2681	C<libglib> event core (C<Glib::EV> and C<EV::Glib>).	2939	C<Net::SNMP> (C<Net::SNMP::EV>) and the C<libglib> event core (C<Glib::EV>
		2940	and C<EV::Glib>).
2682		2941
2683	It can be found and installed via CPAN, its homepage is at	2942	It can be found and installed via CPAN, its homepage is at
2684	L<http://software.schmorp.de/pkg/EV>.	2943	L<http://software.schmorp.de/pkg/EV>.
2685		2944
2686	=item Python	2945	=item Python
…		…
2702	=item D	2961	=item D
2703		2962
2704	Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to	2963	Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to
2705	be found at L<http://proj.llucax.com.ar/wiki/evd>.	2964	be found at L<http://proj.llucax.com.ar/wiki/evd>.
2706		2965
		2966	=item Ocaml
		2967
		2968	Erkki Seppala has written Ocaml bindings for libev, to be found at
		2969	L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.
		2970
2707	=back	2971	=back
2708		2972
2709		2973
2710	=head1 MACRO MAGIC	2974	=head1 MACRO MAGIC
2711		2975
…		…
2865		3129
2866	=head2 PREPROCESSOR SYMBOLS/MACROS	3130	=head2 PREPROCESSOR SYMBOLS/MACROS
2867		3131
2868	Libev can be configured via a variety of preprocessor symbols you have to	3132	Libev can be configured via a variety of preprocessor symbols you have to
2869	define before including any of its files. The default in the absence of	3133	define before including any of its files. The default in the absence of
2870	autoconf is noted for every option.	3134	autoconf is documented for every option.
2871		3135
2872	=over 4	3136	=over 4
2873		3137
2874	=item EV_STANDALONE	3138	=item EV_STANDALONE
2875		3139
…		…
3045	When doing priority-based operations, libev usually has to linearly search	3309	When doing priority-based operations, libev usually has to linearly search
3046	all the priorities, so having many of them (hundreds) uses a lot of space	3310	all the priorities, so having many of them (hundreds) uses a lot of space
3047	and time, so using the defaults of five priorities (-2 .. +2) is usually	3311	and time, so using the defaults of five priorities (-2 .. +2) is usually
3048	fine.	3312	fine.
3049		3313
3050	If your embedding application does not need any priorities, defining these both to	3314	If your embedding application does not need any priorities, defining these
3051	C<0> will save some memory and CPU.	3315	both to C<0> will save some memory and CPU.
3052		3316
3053	=item EV_PERIODIC_ENABLE	3317	=item EV_PERIODIC_ENABLE
3054		3318
3055	If undefined or defined to be C<1>, then periodic timers are supported. If	3319	If undefined or defined to be C<1>, then periodic timers are supported. If
3056	defined to be C<0>, then they are not. Disabling them saves a few kB of	3320	defined to be C<0>, then they are not. Disabling them saves a few kB of
…		…
3063	code.	3327	code.
3064		3328
3065	=item EV_EMBED_ENABLE	3329	=item EV_EMBED_ENABLE
3066		3330
3067	If undefined or defined to be C<1>, then embed watchers are supported. If	3331	If undefined or defined to be C<1>, then embed watchers are supported. If
3068	defined to be C<0>, then they are not.	3332	defined to be C<0>, then they are not. Embed watchers rely on most other
		3333	watcher types, which therefore must not be disabled.
3069		3334
3070	=item EV_STAT_ENABLE	3335	=item EV_STAT_ENABLE
3071		3336
3072	If undefined or defined to be C<1>, then stat watchers are supported. If	3337	If undefined or defined to be C<1>, then stat watchers are supported. If
3073	defined to be C<0>, then they are not.	3338	defined to be C<0>, then they are not.
…		…
3105	two).	3370	two).
3106		3371
3107	=item EV_USE_4HEAP	3372	=item EV_USE_4HEAP
3108		3373
3109	Heaps are not very cache-efficient. To improve the cache-efficiency of the	3374	Heaps are not very cache-efficient. To improve the cache-efficiency of the
3110	timer and periodics heap, libev uses a 4-heap when this symbol is defined	3375	timer and periodics heaps, libev uses a 4-heap when this symbol is defined
3111	to C<1>. The 4-heap uses more complicated (longer) code but has	3376	to C<1>. The 4-heap uses more complicated (longer) code but has noticeably
3112	noticeably faster performance with many (thousands) of watchers.	3377	faster performance with many (thousands) of watchers.
3113		3378
3114	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>	3379	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>
3115	(disabled).	3380	(disabled).
3116		3381
3117	=item EV_HEAP_CACHE_AT	3382	=item EV_HEAP_CACHE_AT
3118		3383
3119	Heaps are not very cache-efficient. To improve the cache-efficiency of the	3384	Heaps are not very cache-efficient. To improve the cache-efficiency of the
3120	timer and periodics heap, libev can cache the timestamp (I<at>) within	3385	timer and periodics heaps, libev can cache the timestamp (I<at>) within
3121	the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>),	3386	the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>),
3122	which uses 8-12 bytes more per watcher and a few hundred bytes more code,	3387	which uses 8-12 bytes more per watcher and a few hundred bytes more code,
3123	but avoids random read accesses on heap changes. This improves performance	3388	but avoids random read accesses on heap changes. This improves performance
3124	noticeably with with many (hundreds) of watchers.	3389	noticeably with many (hundreds) of watchers.
3125		3390
3126	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>	3391	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>
3127	(disabled).	3392	(disabled).
3128		3393
3129	=item EV_VERIFY	3394	=item EV_VERIFY
…		…
3135	called once per loop, which can slow down libev. If set to C<3>, then the	3400	called once per loop, which can slow down libev. If set to C<3>, then the
3136	verification code will be called very frequently, which will slow down	3401	verification code will be called very frequently, which will slow down
3137	libev considerably.	3402	libev considerably.
3138		3403
3139	The default is C<1>, unless C<EV_MINIMAL> is set, in which case it will be	3404	The default is C<1>, unless C<EV_MINIMAL> is set, in which case it will be
3140	C<0.>	3405	C<0>.
3141		3406
3142	=item EV_COMMON	3407	=item EV_COMMON
3143		3408
3144	By default, all watchers have a C<void *data> member. By redefining	3409	By default, all watchers have a C<void *data> member. By redefining
3145	this macro to a something else you can include more and other types of	3410	this macro to a something else you can include more and other types of
…		…
3162	and the way callbacks are invoked and set. Must expand to a struct member	3427	and the way callbacks are invoked and set. Must expand to a struct member
3163	definition and a statement, respectively. See the F<ev.h> header file for	3428	definition and a statement, respectively. See the F<ev.h> header file for
3164	their default definitions. One possible use for overriding these is to	3429	their default definitions. One possible use for overriding these is to
3165	avoid the C<struct ev_loop *> as first argument in all cases, or to use	3430	avoid the C<struct ev_loop *> as first argument in all cases, or to use
3166	method calls instead of plain function calls in C++.	3431	method calls instead of plain function calls in C++.
		3432
		3433	=back
3167		3434
3168	=head2 EXPORTED API SYMBOLS	3435	=head2 EXPORTED API SYMBOLS
3169		3436
3170	If you need to re-export the API (e.g. via a DLL) and you need a list of	3437	If you need to re-export the API (e.g. via a DLL) and you need a list of
3171	exported symbols, you can use the provided F<Symbol.*> files which list	3438	exported symbols, you can use the provided F<Symbol.*> files which list
…		…
3218	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:	3485	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
3219		3486
3220	#include "ev_cpp.h"	3487	#include "ev_cpp.h"
3221	#include "ev.c"	3488	#include "ev.c"
3222		3489
		3490	=head1 INTERACTION WITH OTHER PROGRAMS OR LIBRARIES
3223		3491
3224	=head1 THREADS AND COROUTINES	3492	=head2 THREADS AND COROUTINES
3225		3493
3226	=head2 THREADS	3494	=head3 THREADS
3227		3495
3228	Libev itself is completely thread-safe, but it uses no locking. This	3496	All libev functions are reentrant and thread-safe unless explicitly
		3497	documented otherwise, but libev implements no locking itself. This means
3229	means that you can use as many loops as you want in parallel, as long as	3498	that you can use as many loops as you want in parallel, as long as there
3230	only one thread ever calls into one libev function with the same loop	3499	are no concurrent calls into any libev function with the same loop
3231	parameter.	3500	parameter (C<ev_default_*> calls have an implicit default loop parameter,
		3501	of course): libev guarantees that different event loops share no data
		3502	structures that need any locking.
3232		3503
3233	Or put differently: calls with different loop parameters can be done in	3504	Or to put it differently: calls with different loop parameters can be done
3234	parallel from multiple threads, calls with the same loop parameter must be	3505	concurrently from multiple threads, calls with the same loop parameter
3235	done serially (but can be done from different threads, as long as only one	3506	must be done serially (but can be done from different threads, as long as
3236	thread ever is inside a call at any point in time, e.g. by using a mutex	3507	only one thread ever is inside a call at any point in time, e.g. by using
3237	per loop).	3508	a mutex per loop).
		3509
		3510	Specifically to support threads (and signal handlers), libev implements
		3511	so-called C<ev_async> watchers, which allow some limited form of
		3512	concurrency on the same event loop, namely waking it up "from the
		3513	outside".
3238		3514
3239	If you want to know which design (one loop, locking, or multiple loops	3515	If you want to know which design (one loop, locking, or multiple loops
3240	without or something else still) is best for your problem, then I cannot	3516	without or something else still) is best for your problem, then I cannot
3241	help you. I can give some generic advice however:	3517	help you, but here is some generic advice:
3242		3518
3243	=over 4	3519	=over 4
3244		3520
3245	=item * most applications have a main thread: use the default libev loop	3521	=item * most applications have a main thread: use the default libev loop
3246	in that thread, or create a separate thread running only the default loop.	3522	in that thread, or create a separate thread running only the default loop.
…		…
3258		3534
3259	Choosing a model is hard - look around, learn, know that usually you can do	3535	Choosing a model is hard - look around, learn, know that usually you can do
3260	better than you currently do :-)	3536	better than you currently do :-)
3261		3537
3262	=item * often you need to talk to some other thread which blocks in the	3538	=item * often you need to talk to some other thread which blocks in the
		3539	event loop.
		3540
3263	event loop - C<ev_async> watchers can be used to wake them up from other	3541	C<ev_async> watchers can be used to wake them up from other threads safely
3264	threads safely (or from signal contexts...).	3542	(or from signal contexts...).
		3543
		3544	An example use would be to communicate signals or other events that only
		3545	work in the default loop by registering the signal watcher with the
		3546	default loop and triggering an C<ev_async> watcher from the default loop
		3547	watcher callback into the event loop interested in the signal.
3265		3548
3266	=back	3549	=back
3267		3550
3268	=head2 COROUTINES	3551	=head3 COROUTINES
3269		3552
3270	Libev is much more accommodating to coroutines ("cooperative threads"):	3553	Libev is very accommodating to coroutines ("cooperative threads"):
3271	libev fully supports nesting calls to it's functions from different	3554	libev fully supports nesting calls to its functions from different
3272	coroutines (e.g. you can call C<ev_loop> on the same loop from two	3555	coroutines (e.g. you can call C<ev_loop> on the same loop from two
3273	different coroutines and switch freely between both coroutines running the	3556	different coroutines, and switch freely between both coroutines running the
3274	loop, as long as you don't confuse yourself). The only exception is that	3557	loop, as long as you don't confuse yourself). The only exception is that
3275	you must not do this from C<ev_periodic> reschedule callbacks.	3558	you must not do this from C<ev_periodic> reschedule callbacks.
3276		3559
3277	Care has been invested into making sure that libev does not keep local	3560	Care has been taken to ensure that libev does not keep local state inside
3278	state inside C<ev_loop>, and other calls do not usually allow coroutine	3561	C<ev_loop>, and other calls do not usually allow for coroutine switches as
3279	switches.	3562	they do not clal any callbacks.
3280		3563
		3564	=head2 COMPILER WARNINGS
3281		3565
3282	=head1 COMPLEXITIES	3566	Depending on your compiler and compiler settings, you might get no or a
		3567	lot of warnings when compiling libev code. Some people are apparently
		3568	scared by this.
3283		3569
3284	In this section the complexities of (many of) the algorithms used inside	3570	However, these are unavoidable for many reasons. For one, each compiler
3285	libev will be explained. For complexity discussions about backends see the	3571	has different warnings, and each user has different tastes regarding
3286	documentation for C<ev_default_init>.	3572	warning options. "Warn-free" code therefore cannot be a goal except when
		3573	targeting a specific compiler and compiler-version.
3287		3574
3288	All of the following are about amortised time: If an array needs to be	3575	Another reason is that some compiler warnings require elaborate
3289	extended, libev needs to realloc and move the whole array, but this	3576	workarounds, or other changes to the code that make it less clear and less
3290	happens asymptotically never with higher number of elements, so O(1) might	3577	maintainable.
3291	mean it might do a lengthy realloc operation in rare cases, but on average
3292	it is much faster and asymptotically approaches constant time.
3293		3578
3294	=over 4	3579	And of course, some compiler warnings are just plain stupid, or simply
		3580	wrong (because they don't actually warn about the condition their message
		3581	seems to warn about). For example, certain older gcc versions had some
		3582	warnings that resulted an extreme number of false positives. These have
		3583	been fixed, but some people still insist on making code warn-free with
		3584	such buggy versions.
3295		3585
3296	=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers)	3586	While libev is written to generate as few warnings as possible,
		3587	"warn-free" code is not a goal, and it is recommended not to build libev
		3588	with any compiler warnings enabled unless you are prepared to cope with
		3589	them (e.g. by ignoring them). Remember that warnings are just that:
		3590	warnings, not errors, or proof of bugs.
3297		3591
3298	This means that, when you have a watcher that triggers in one hour and
3299	there are 100 watchers that would trigger before that then inserting will
3300	have to skip roughly seven (C<ld 100>) of these watchers.
3301		3592
3302	=item Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)	3593	=head2 VALGRIND
3303		3594
3304	That means that changing a timer costs less than removing/adding them	3595	Valgrind has a special section here because it is a popular tool that is
3305	as only the relative motion in the event queue has to be paid for.	3596	highly useful. Unfortunately, valgrind reports are very hard to interpret.
3306		3597
3307	=item Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1)	3598	If you think you found a bug (memory leak, uninitialised data access etc.)
		3599	in libev, then check twice: If valgrind reports something like:
3308		3600
3309	These just add the watcher into an array or at the head of a list.	3601	==2274== definitely lost: 0 bytes in 0 blocks.
		3602	==2274== possibly lost: 0 bytes in 0 blocks.
		3603	==2274== still reachable: 256 bytes in 1 blocks.
3310		3604
3311	=item Stopping check/prepare/idle/fork/async watchers: O(1)	3605	Then there is no memory leak, just as memory accounted to global variables
		3606	is not a memleak - the memory is still being refernced, and didn't leak.
3312		3607
3313	=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))	3608	Similarly, under some circumstances, valgrind might report kernel bugs
		3609	as if it were a bug in libev (e.g. in realloc or in the poll backend,
		3610	although an acceptable workaround has been found here), or it might be
		3611	confused.
3314		3612
3315	These watchers are stored in lists then need to be walked to find the	3613	Keep in mind that valgrind is a very good tool, but only a tool. Don't
3316	correct watcher to remove. The lists are usually short (you don't usually	3614	make it into some kind of religion.
3317	have many watchers waiting for the same fd or signal).
3318		3615
3319	=item Finding the next timer in each loop iteration: O(1)	3616	If you are unsure about something, feel free to contact the mailing list
		3617	with the full valgrind report and an explanation on why you think this
		3618	is a bug in libev (best check the archives, too :). However, don't be
		3619	annoyed when you get a brisk "this is no bug" answer and take the chance
		3620	of learning how to interpret valgrind properly.
3320		3621
3321	By virtue of using a binary or 4-heap, the next timer is always found at a	3622	If you need, for some reason, empty reports from valgrind for your project
3322	fixed position in the storage array.	3623	I suggest using suppression lists.
3323		3624
3324	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)
3325		3625
3326	A change means an I/O watcher gets started or stopped, which requires	3626	=head1 PORTABILITY NOTES
3327	libev to recalculate its status (and possibly tell the kernel, depending
3328	on backend and whether C<ev_io_set> was used).
3329		3627
3330	=item Activating one watcher (putting it into the pending state): O(1)
3331
3332	=item Priority handling: O(number_of_priorities)
3333
3334	Priorities are implemented by allocating some space for each
3335	priority. When doing priority-based operations, libev usually has to
3336	linearly search all the priorities, but starting/stopping and activating
3337	watchers becomes O(1) w.r.t. priority handling.
3338
3339	=item Sending an ev_async: O(1)
3340
3341	=item Processing ev_async_send: O(number_of_async_watchers)
3342
3343	=item Processing signals: O(max_signal_number)
3344
3345	Sending involves a system call I<iff> there were no other C<ev_async_send>
3346	calls in the current loop iteration. Checking for async and signal events
3347	involves iterating over all running async watchers or all signal numbers.
3348
3349	=back
3350
3351
3352	=head1 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS	3628	=head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS
3353		3629
3354	Win32 doesn't support any of the standards (e.g. POSIX) that libev	3630	Win32 doesn't support any of the standards (e.g. POSIX) that libev
3355	requires, and its I/O model is fundamentally incompatible with the POSIX	3631	requires, and its I/O model is fundamentally incompatible with the POSIX
3356	model. Libev still offers limited functionality on this platform in	3632	model. Libev still offers limited functionality on this platform in
3357	the form of the C<EVBACKEND_SELECT> backend, and only supports socket	3633	the form of the C<EVBACKEND_SELECT> backend, and only supports socket
…		…
3368		3644
3369	Not a libev limitation but worth mentioning: windows apparently doesn't	3645	Not a libev limitation but worth mentioning: windows apparently doesn't
3370	accept large writes: instead of resulting in a partial write, windows will	3646	accept large writes: instead of resulting in a partial write, windows will
3371	either accept everything or return C<ENOBUFS> if the buffer is too large,	3647	either accept everything or return C<ENOBUFS> if the buffer is too large,
3372	so make sure you only write small amounts into your sockets (less than a	3648	so make sure you only write small amounts into your sockets (less than a
3373	megabyte seems safe, but thsi apparently depends on the amount of memory	3649	megabyte seems safe, but this apparently depends on the amount of memory
3374	available).	3650	available).
3375		3651
3376	Due to the many, low, and arbitrary limits on the win32 platform and	3652	Due to the many, low, and arbitrary limits on the win32 platform and
3377	the abysmal performance of winsockets, using a large number of sockets	3653	the abysmal performance of winsockets, using a large number of sockets
3378	is not recommended (and not reasonable). If your program needs to use	3654	is not recommended (and not reasonable). If your program needs to use
…		…
3389	#define EV_SELECT_IS_WINSOCKET 1 /* configure libev for windows select */	3665	#define EV_SELECT_IS_WINSOCKET 1 /* configure libev for windows select */
3390		3666
3391	#include "ev.h"	3667	#include "ev.h"
3392		3668
3393	And compile the following F<evwrap.c> file into your project (make sure	3669	And compile the following F<evwrap.c> file into your project (make sure
3394	you do I<not> compile the F<ev.c> or any other embedded soruce files!):	3670	you do I<not> compile the F<ev.c> or any other embedded source files!):
3395		3671
3396	#include "evwrap.h"	3672	#include "evwrap.h"
3397	#include "ev.c"	3673	#include "ev.c"
3398		3674
3399	=over 4	3675	=over 4
…		…
3444	wrap all I/O functions and provide your own fd management, but the cost of	3720	wrap all I/O functions and provide your own fd management, but the cost of
3445	calling select (O(n²)) will likely make this unworkable.	3721	calling select (O(n²)) will likely make this unworkable.
3446		3722
3447	=back	3723	=back
3448		3724
3449
3450	=head1 PORTABILITY REQUIREMENTS	3725	=head2 PORTABILITY REQUIREMENTS
3451		3726
3452	In addition to a working ISO-C implementation, libev relies on a few	3727	In addition to a working ISO-C implementation and of course the
3453	additional extensions:	3728	backend-specific APIs, libev relies on a few additional extensions:
3454		3729
3455	=over 4	3730	=over 4
3456		3731
3457	=item C<void (*)(ev_watcher_type *, int revents)> must have compatible	3732	=item C<void (*)(ev_watcher_type *, int revents)> must have compatible
3458	calling conventions regardless of C<ev_watcher_type *>.	3733	calling conventions regardless of C<ev_watcher_type *>.
…		…
3464	calls them using an C<ev_watcher *> internally.	3739	calls them using an C<ev_watcher *> internally.
3465		3740
3466	=item C<sig_atomic_t volatile> must be thread-atomic as well	3741	=item C<sig_atomic_t volatile> must be thread-atomic as well
3467		3742
3468	The type C<sig_atomic_t volatile> (or whatever is defined as	3743	The type C<sig_atomic_t volatile> (or whatever is defined as
3469	C<EV_ATOMIC_T>) must be atomic w.r.t. accesses from different	3744	C<EV_ATOMIC_T>) must be atomic with respect to accesses from different
3470	threads. This is not part of the specification for C<sig_atomic_t>, but is	3745	threads. This is not part of the specification for C<sig_atomic_t>, but is
3471	believed to be sufficiently portable.	3746	believed to be sufficiently portable.
3472		3747
3473	=item C<sigprocmask> must work in a threaded environment	3748	=item C<sigprocmask> must work in a threaded environment
3474		3749
…		…
3483	except the initial one, and run the default loop in the initial thread as	3758	except the initial one, and run the default loop in the initial thread as
3484	well.	3759	well.
3485		3760
3486	=item C<long> must be large enough for common memory allocation sizes	3761	=item C<long> must be large enough for common memory allocation sizes
3487		3762
3488	To improve portability and simplify using libev, libev uses C<long>	3763	To improve portability and simplify its API, libev uses C<long> internally
3489	internally instead of C<size_t> when allocating its data structures. On	3764	instead of C<size_t> when allocating its data structures. On non-POSIX
3490	non-POSIX systems (Microsoft...) this might be unexpectedly low, but	3765	systems (Microsoft...) this might be unexpectedly low, but is still at
3491	is still at least 31 bits everywhere, which is enough for hundreds of	3766	least 31 bits everywhere, which is enough for hundreds of millions of
3492	millions of watchers.	3767	watchers.
3493		3768
3494	=item C<double> must hold a time value in seconds with enough accuracy	3769	=item C<double> must hold a time value in seconds with enough accuracy
3495		3770
3496	The type C<double> is used to represent timestamps. It is required to	3771	The type C<double> is used to represent timestamps. It is required to
3497	have at least 51 bits of mantissa (and 9 bits of exponent), which is good	3772	have at least 51 bits of mantissa (and 9 bits of exponent), which is good
…		…
3501	=back	3776	=back
3502		3777
3503	If you know of other additional requirements drop me a note.	3778	If you know of other additional requirements drop me a note.
3504		3779
3505		3780
3506	=head1 COMPILER WARNINGS	3781	=head1 ALGORITHMIC COMPLEXITIES
3507		3782
3508	Depending on your compiler and compiler settings, you might get no or a	3783	In this section the complexities of (many of) the algorithms used inside
3509	lot of warnings when compiling libev code. Some people are apparently	3784	libev will be documented. For complexity discussions about backends see
3510	scared by this.	3785	the documentation for C<ev_default_init>.
3511		3786
3512	However, these are unavoidable for many reasons. For one, each compiler	3787	All of the following are about amortised time: If an array needs to be
3513	has different warnings, and each user has different tastes regarding	3788	extended, libev needs to realloc and move the whole array, but this
3514	warning options. "Warn-free" code therefore cannot be a goal except when	3789	happens asymptotically rarer with higher number of elements, so O(1) might
3515	targeting a specific compiler and compiler-version.	3790	mean that libev does a lengthy realloc operation in rare cases, but on
		3791	average it is much faster and asymptotically approaches constant time.
3516		3792
3517	Another reason is that some compiler warnings require elaborate	3793	=over 4
3518	workarounds, or other changes to the code that make it less clear and less
3519	maintainable.
3520		3794
3521	And of course, some compiler warnings are just plain stupid, or simply	3795	=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers)
3522	wrong (because they don't actually warn about the condition their message
3523	seems to warn about).
3524		3796
3525	While libev is written to generate as few warnings as possible,	3797	This means that, when you have a watcher that triggers in one hour and
3526	"warn-free" code is not a goal, and it is recommended not to build libev	3798	there are 100 watchers that would trigger before that, then inserting will
3527	with any compiler warnings enabled unless you are prepared to cope with	3799	have to skip roughly seven (C<ld 100>) of these watchers.
3528	them (e.g. by ignoring them). Remember that warnings are just that:
3529	warnings, not errors, or proof of bugs.
3530		3800
		3801	=item Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)
3531		3802
3532	=head1 VALGRIND	3803	That means that changing a timer costs less than removing/adding them,
		3804	as only the relative motion in the event queue has to be paid for.
3533		3805
3534	Valgrind has a special section here because it is a popular tool that is	3806	=item Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1)
3535	highly useful, but valgrind reports are very hard to interpret.
3536		3807
3537	If you think you found a bug (memory leak, uninitialised data access etc.)	3808	These just add the watcher into an array or at the head of a list.
3538	in libev, then check twice: If valgrind reports something like:
3539		3809
3540	==2274== definitely lost: 0 bytes in 0 blocks.	3810	=item Stopping check/prepare/idle/fork/async watchers: O(1)
3541	==2274== possibly lost: 0 bytes in 0 blocks.
3542	==2274== still reachable: 256 bytes in 1 blocks.
3543		3811
3544	Then there is no memory leak. Similarly, under some circumstances,	3812	=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))
3545	valgrind might report kernel bugs as if it were a bug in libev, or it
3546	might be confused (it is a very good tool, but only a tool).
3547		3813
3548	If you are unsure about something, feel free to contact the mailing list	3814	These watchers are stored in lists, so they need to be walked to find the
3549	with the full valgrind report and an explanation on why you think this is	3815	correct watcher to remove. The lists are usually short (you don't usually
3550	a bug in libev. However, don't be annoyed when you get a brisk "this is	3816	have many watchers waiting for the same fd or signal: one is typical, two
3551	no bug" answer and take the chance of learning how to interpret valgrind	3817	is rare).
3552	properly.
3553		3818
3554	If you need, for some reason, empty reports from valgrind for your project	3819	=item Finding the next timer in each loop iteration: O(1)
3555	I suggest using suppression lists.	3820
		3821	By virtue of using a binary or 4-heap, the next timer is always found at a
		3822	fixed position in the storage array.
		3823
		3824	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)
		3825
		3826	A change means an I/O watcher gets started or stopped, which requires
		3827	libev to recalculate its status (and possibly tell the kernel, depending
		3828	on backend and whether C<ev_io_set> was used).
		3829
		3830	=item Activating one watcher (putting it into the pending state): O(1)
		3831
		3832	=item Priority handling: O(number_of_priorities)
		3833
		3834	Priorities are implemented by allocating some space for each
		3835	priority. When doing priority-based operations, libev usually has to
		3836	linearly search all the priorities, but starting/stopping and activating
		3837	watchers becomes O(1) with respect to priority handling.
		3838
		3839	=item Sending an ev_async: O(1)
		3840
		3841	=item Processing ev_async_send: O(number_of_async_watchers)
		3842
		3843	=item Processing signals: O(max_signal_number)
		3844
		3845	Sending involves a system call I<iff> there were no other C<ev_async_send>
		3846	calls in the current loop iteration. Checking for async and signal events
		3847	involves iterating over all running async watchers or all signal numbers.
		3848
		3849	=back
3556		3850
3557		3851
3558	=head1 AUTHOR	3852	=head1 AUTHOR
3559		3853
3560	Marc Lehmann <libev@schmorp.de>.	3854	Marc Lehmann <libev@schmorp.de>.

Diff Legend

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