ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

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

Diff Legend

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