ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.36 by root, Sat Nov 24 07:14:26 2007 UTC vs.
Revision 1.59 by root, Wed Nov 28 17:32:24 2007 UTC

…		…
3	libev - a high performance full-featured event loop written in C	3	libev - a high performance full-featured event loop written in C
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	#include <ev.h>	7	#include <ev.h>
		8
		9	=head1 EXAMPLE PROGRAM
		10
		11	#include <ev.h>
		12
		13	ev_io stdin_watcher;
		14	ev_timer timeout_watcher;
		15
		16	/* called when data readable on stdin */
		17	static void
		18	stdin_cb (EV_P_ struct ev_io *w, int revents)
		19	{
		20	/* puts ("stdin ready"); */
		21	ev_io_stop (EV_A_ w); /* just a syntax example */
		22	ev_unloop (EV_A_ EVUNLOOP_ALL); /* leave all loop calls */
		23	}
		24
		25	static void
		26	timeout_cb (EV_P_ struct ev_timer *w, int revents)
		27	{
		28	/* puts ("timeout"); */
		29	ev_unloop (EV_A_ EVUNLOOP_ONE); /* leave one loop call */
		30	}
		31
		32	int
		33	main (void)
		34	{
		35	struct ev_loop *loop = ev_default_loop (0);
		36
		37	/* initialise an io watcher, then start it */
		38	ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);
		39	ev_io_start (loop, &stdin_watcher);
		40
		41	/* simple non-repeating 5.5 second timeout */
		42	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
		43	ev_timer_start (loop, &timeout_watcher);
		44
		45	/* loop till timeout or data ready */
		46	ev_loop (loop, 0);
		47
		48	return 0;
		49	}
8		50
9	=head1 DESCRIPTION	51	=head1 DESCRIPTION
10		52
11	Libev is an event loop: you register interest in certain events (such as a	53	Libev is an event loop: you register interest in certain events (such as a
12	file descriptor being readable or a timeout occuring), and it will manage	54	file descriptor being readable or a timeout occuring), and it will manage
…		…
21	details of the event, and then hand it over to libev by I<starting> the	63	details of the event, and then hand it over to libev by I<starting> the
22	watcher.	64	watcher.
23		65
24	=head1 FEATURES	66	=head1 FEATURES
25		67
26	Libev supports select, poll, the linux-specific epoll and the bsd-specific	68	Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the
27	kqueue mechanisms for file descriptor events, relative timers, absolute	69	BSD-specific C<kqueue> and the Solaris-specific event port mechanisms
28	timers with customised rescheduling, signal events, process status change	70	for file descriptor events (C<ev_io>), the Linux C<inotify> interface
29	events (related to SIGCHLD), and event watchers dealing with the event	71	(for C<ev_stat>), relative timers (C<ev_timer>), absolute timers
30	loop mechanism itself (idle, prepare and check watchers). It also is quite	72	with customised rescheduling (C<ev_periodic>), synchronous signals
		73	(C<ev_signal>), process status change events (C<ev_child>), and event
		74	watchers dealing with the event loop mechanism itself (C<ev_idle>,
		75	C<ev_embed>, C<ev_prepare> and C<ev_check> watchers) as well as
		76	file watchers (C<ev_stat>) and even limited support for fork events
		77	(C<ev_fork>).
		78
		79	It also is quite fast (see this
31	fast (see this L<benchmark|http://libev.schmorp.de/bench.html> comparing	80	L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent
32	it to libevent for example).	81	for example).
33		82
34	=head1 CONVENTIONS	83	=head1 CONVENTIONS
35		84
36	Libev is very configurable. In this manual the default configuration	85	Libev is very configurable. In this manual the default configuration will
37	will be described, which supports multiple event loops. For more info	86	be described, which supports multiple event loops. For more info about
38	about various configuration options please have a look at the file	87	various configuration options please have a look at B<EMBED> section in
39	F<README.embed> in the libev distribution. If libev was configured without	88	this manual. If libev was configured without support for multiple event
40	support for multiple event loops, then all functions taking an initial	89	loops, then all functions taking an initial argument of name C<loop>
41	argument of name C<loop> (which is always of type C<struct ev_loop *>)	90	(which is always of type C<struct ev_loop *>) will not have this argument.
42	will not have this argument.
43		91
44	=head1 TIME REPRESENTATION	92	=head1 TIME REPRESENTATION
45		93
46	Libev represents time as a single floating point number, representing the	94	Libev represents time as a single floating point number, representing the
47	(fractional) number of seconds since the (POSIX) epoch (somewhere near	95	(fractional) number of seconds since the (POSIX) epoch (somewhere near
48	the beginning of 1970, details are complicated, don't ask). This type is	96	the beginning of 1970, details are complicated, don't ask). This type is
49	called C<ev_tstamp>, which is what you should use too. It usually aliases	97	called C<ev_tstamp>, which is what you should use too. It usually aliases
50	to the C<double> type in C, and when you need to do any calculations on	98	to the C<double> type in C, and when you need to do any calculations on
51	it, you should treat it as such.	99	it, you should treat it as such.
52		100
53
54	=head1 GLOBAL FUNCTIONS	101	=head1 GLOBAL FUNCTIONS
55		102
56	These functions can be called anytime, even before initialising the	103	These functions can be called anytime, even before initialising the
57	library in any way.	104	library in any way.
58		105
…		…
77	Usually, it's a good idea to terminate if the major versions mismatch,	124	Usually, it's a good idea to terminate if the major versions mismatch,
78	as this indicates an incompatible change. Minor versions are usually	125	as this indicates an incompatible change. Minor versions are usually
79	compatible to older versions, so a larger minor version alone is usually	126	compatible to older versions, so a larger minor version alone is usually
80	not a problem.	127	not a problem.
81		128
82	Example: make sure we haven't accidentally been linked against the wrong	129	Example: Make sure we haven't accidentally been linked against the wrong
83	version:	130	version.
84		131
85	assert (("libev version mismatch",	132	assert (("libev version mismatch",
86	ev_version_major () == EV_VERSION_MAJOR	133	ev_version_major () == EV_VERSION_MAJOR
87	&& ev_version_minor () >= EV_VERSION_MINOR));	134	&& ev_version_minor () >= EV_VERSION_MINOR));
88		135
…		…
118		165
119	See the description of C<ev_embed> watchers for more info.	166	See the description of C<ev_embed> watchers for more info.
120		167
121	=item ev_set_allocator (void *(*cb)(void *ptr, long size))	168	=item ev_set_allocator (void *(*cb)(void *ptr, long size))
122		169
123	Sets the allocation function to use (the prototype is similar to the	170	Sets the allocation function to use (the prototype is similar - the
124	realloc C function, the semantics are identical). It is used to allocate	171	semantics is identical - to the realloc C function). It is used to
125	and free memory (no surprises here). If it returns zero when memory	172	allocate and free memory (no surprises here). If it returns zero when
126	needs to be allocated, the library might abort or take some potentially	173	memory needs to be allocated, the library might abort or take some
127	destructive action. The default is your system realloc function.	174	potentially destructive action. The default is your system realloc
		175	function.
128		176
129	You could override this function in high-availability programs to, say,	177	You could override this function in high-availability programs to, say,
130	free some memory if it cannot allocate memory, to use a special allocator,	178	free some memory if it cannot allocate memory, to use a special allocator,
131	or even to sleep a while and retry until some memory is available.	179	or even to sleep a while and retry until some memory is available.
132		180
133	Example: replace the libev allocator with one that waits a bit and then	181	Example: Replace the libev allocator with one that waits a bit and then
134	retries: better than mine).	182	retries).
135		183
136	static void *	184	static void *
137	persistent_realloc (void *ptr, long size)	185	persistent_realloc (void *ptr, size_t size)
138	{	186	{
139	for (;;)	187	for (;;)
140	{	188	{
141	void *newptr = realloc (ptr, size);	189	void *newptr = realloc (ptr, size);
142		190
…		…
158	callback is set, then libev will expect it to remedy the sitution, no	206	callback is set, then libev will expect it to remedy the sitution, no
159	matter what, when it returns. That is, libev will generally retry the	207	matter what, when it returns. That is, libev will generally retry the
160	requested operation, or, if the condition doesn't go away, do bad stuff	208	requested operation, or, if the condition doesn't go away, do bad stuff
161	(such as abort).	209	(such as abort).
162		210
163	Example: do the same thing as libev does internally:	211	Example: This is basically the same thing that libev does internally, too.
164		212
165	static void	213	static void
166	fatal_error (const char *msg)	214	fatal_error (const char *msg)
167	{	215	{
168	perror (msg);	216	perror (msg);
…		…
314	Similar to C<ev_default_loop>, but always creates a new event loop that is	362	Similar to C<ev_default_loop>, but always creates a new event loop that is
315	always distinct from the default loop. Unlike the default loop, it cannot	363	always distinct from the default loop. Unlike the default loop, it cannot
316	handle signal and child watchers, and attempts to do so will be greeted by	364	handle signal and child watchers, and attempts to do so will be greeted by
317	undefined behaviour (or a failed assertion if assertions are enabled).	365	undefined behaviour (or a failed assertion if assertions are enabled).
318		366
319	Example: try to create a event loop that uses epoll and nothing else.	367	Example: Try to create a event loop that uses epoll and nothing else.
320		368
321	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);	369	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
322	if (!epoller)	370	if (!epoller)
323	fatal ("no epoll found here, maybe it hides under your chair");	371	fatal ("no epoll found here, maybe it hides under your chair");
324		372
325	=item ev_default_destroy ()	373	=item ev_default_destroy ()
326		374
327	Destroys the default loop again (frees all memory and kernel state	375	Destroys the default loop again (frees all memory and kernel state
328	etc.). This stops all registered event watchers (by not touching them in	376	etc.). None of the active event watchers will be stopped in the normal
329	any way whatsoever, although you cannot rely on this :).	377	sense, so e.g. C<ev_is_active> might still return true. It is your
		378	responsibility to either stop all watchers cleanly yoursef I<before>
		379	calling this function, or cope with the fact afterwards (which is usually
		380	the easiest thing, youc na just ignore the watchers and/or C<free ()> them
		381	for example).
330		382
331	=item ev_loop_destroy (loop)	383	=item ev_loop_destroy (loop)
332		384
333	Like C<ev_default_destroy>, but destroys an event loop created by an	385	Like C<ev_default_destroy>, but destroys an event loop created by an
334	earlier call to C<ev_loop_new>.	386	earlier call to C<ev_loop_new>.
…		…
419	Signals and child watchers are implemented as I/O watchers, and will	471	Signals and child watchers are implemented as I/O watchers, and will
420	be handled here by queueing them when their watcher gets executed.	472	be handled here by queueing them when their watcher gets executed.
421	- If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK	473	- If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK
422	were used, return, otherwise continue with step *.	474	were used, return, otherwise continue with step *.
423		475
424	Example: queue some jobs and then loop until no events are outsanding	476	Example: Queue some jobs and then loop until no events are outsanding
425	anymore.	477	anymore.
426		478
427	... queue jobs here, make sure they register event watchers as long	479	... queue jobs here, make sure they register event watchers as long
428	... as they still have work to do (even an idle watcher will do..)	480	... as they still have work to do (even an idle watcher will do..)
429	ev_loop (my_loop, 0);	481	ev_loop (my_loop, 0);
…		…
449	visible to the libev user and should not keep C<ev_loop> from exiting if	501	visible to the libev user and should not keep C<ev_loop> from exiting if
450	no event watchers registered by it are active. It is also an excellent	502	no event watchers registered by it are active. It is also an excellent
451	way to do this for generic recurring timers or from within third-party	503	way to do this for generic recurring timers or from within third-party
452	libraries. Just remember to I<unref after start> and I<ref before stop>.	504	libraries. Just remember to I<unref after start> and I<ref before stop>.
453		505
454	Example: create a signal watcher, but keep it from keeping C<ev_loop>	506	Example: Create a signal watcher, but keep it from keeping C<ev_loop>
455	running when nothing else is active.	507	running when nothing else is active.
456		508
457	struct dv_signal exitsig;	509	struct ev_signal exitsig;
458	ev_signal_init (&exitsig, sig_cb, SIGINT);	510	ev_signal_init (&exitsig, sig_cb, SIGINT);
459	ev_signal_start (myloop, &exitsig);	511	ev_signal_start (loop, &exitsig);
460	evf_unref (myloop);	512	evf_unref (loop);
461		513
462	Example: for some weird reason, unregister the above signal handler again.	514	Example: For some weird reason, unregister the above signal handler again.
463		515
464	ev_ref (myloop);	516	ev_ref (loop);
465	ev_signal_stop (myloop, &exitsig);	517	ev_signal_stop (loop, &exitsig);
466		518
467	=back	519	=back
		520
468		521
469	=head1 ANATOMY OF A WATCHER	522	=head1 ANATOMY OF A WATCHER
470		523
471	A watcher is a structure that you create and register to record your	524	A watcher is a structure that you create and register to record your
472	interest in some event. For instance, if you want to wait for STDIN to	525	interest in some event. For instance, if you want to wait for STDIN to
…		…
539	The signal specified in the C<ev_signal> watcher has been received by a thread.	592	The signal specified in the C<ev_signal> watcher has been received by a thread.
540		593
541	=item C<EV_CHILD>	594	=item C<EV_CHILD>
542		595
543	The pid specified in the C<ev_child> watcher has received a status change.	596	The pid specified in the C<ev_child> watcher has received a status change.
		597
		598	=item C<EV_STAT>
		599
		600	The path specified in the C<ev_stat> watcher changed its attributes somehow.
544		601
545	=item C<EV_IDLE>	602	=item C<EV_IDLE>
546		603
547	The C<ev_idle> watcher has determined that you have nothing better to do.	604	The C<ev_idle> watcher has determined that you have nothing better to do.
548		605
…		…
556	received events. Callbacks of both watcher types can start and stop as	613	received events. Callbacks of both watcher types can start and stop as
557	many watchers as they want, and all of them will be taken into account	614	many watchers as they want, and all of them will be taken into account
558	(for example, a C<ev_prepare> watcher might start an idle watcher to keep	615	(for example, a C<ev_prepare> watcher might start an idle watcher to keep
559	C<ev_loop> from blocking).	616	C<ev_loop> from blocking).
560		617
		618	=item C<EV_EMBED>
		619
		620	The embedded event loop specified in the C<ev_embed> watcher needs attention.
		621
		622	=item C<EV_FORK>
		623
		624	The event loop has been resumed in the child process after fork (see
		625	C<ev_fork>).
		626
561	=item C<EV_ERROR>	627	=item C<EV_ERROR>
562		628
563	An unspecified error has occured, the watcher has been stopped. This might	629	An unspecified error has occured, the watcher has been stopped. This might
564	happen because the watcher could not be properly started because libev	630	happen because the watcher could not be properly started because libev
565	ran out of memory, a file descriptor was found to be closed or any other	631	ran out of memory, a file descriptor was found to be closed or any other
…		…
572	with the error from read() or write(). This will not work in multithreaded	638	with the error from read() or write(). This will not work in multithreaded
573	programs, though, so beware.	639	programs, though, so beware.
574		640
575	=back	641	=back
576		642
577	=head2 SUMMARY OF GENERIC WATCHER FUNCTIONS	643	=head2 GENERIC WATCHER FUNCTIONS
578		644
579	In the following description, C<TYPE> stands for the watcher type,	645	In the following description, C<TYPE> stands for the watcher type,
580	e.g. C<timer> for C<ev_timer> watchers and C<io> for C<ev_io> watchers.	646	e.g. C<timer> for C<ev_timer> watchers and C<io> for C<ev_io> watchers.
581		647
582	=over 4	648	=over 4
…		…
591	which rolls both calls into one.	657	which rolls both calls into one.
592		658
593	You can reinitialise a watcher at any time as long as it has been stopped	659	You can reinitialise a watcher at any time as long as it has been stopped
594	(or never started) and there are no pending events outstanding.	660	(or never started) and there are no pending events outstanding.
595		661
596	The callbakc is always of type C<void (*)(ev_loop *loop, ev_TYPE *watcher,	662	The callback is always of type C<void (*)(ev_loop *loop, ev_TYPE *watcher,
597	int revents)>.	663	int revents)>.
598		664
599	=item C<ev_TYPE_set> (ev_TYPE *, [args])	665	=item C<ev_TYPE_set> (ev_TYPE *, [args])
600		666
601	This macro initialises the type-specific parts of a watcher. You need to	667	This macro initialises the type-specific parts of a watcher. You need to
…		…
639	events but its callback has not yet been invoked). As long as a watcher	705	events but its callback has not yet been invoked). As long as a watcher
640	is pending (but not active) you must not call an init function on it (but	706	is pending (but not active) you must not call an init function on it (but
641	C<ev_TYPE_set> is safe) and you must make sure the watcher is available to	707	C<ev_TYPE_set> is safe) and you must make sure the watcher is available to
642	libev (e.g. you cnanot C<free ()> it).	708	libev (e.g. you cnanot C<free ()> it).
643		709
644	=item callback = ev_cb (ev_TYPE *watcher)	710	=item callback ev_cb (ev_TYPE *watcher)
645		711
646	Returns the callback currently set on the watcher.	712	Returns the callback currently set on the watcher.
647		713
648	=item ev_cb_set (ev_TYPE *watcher, callback)	714	=item ev_cb_set (ev_TYPE *watcher, callback)
649		715
…		…
677	{	743	{
678	struct my_io *w = (struct my_io *)w_;	744	struct my_io *w = (struct my_io *)w_;
679	...	745	...
680	}	746	}
681		747
682	More interesting and less C-conformant ways of catsing your callback type	748	More interesting and less C-conformant ways of casting your callback type
683	have been omitted....	749	instead have been omitted.
		750
		751	Another common scenario is having some data structure with multiple
		752	watchers:
		753
		754	struct my_biggy
		755	{
		756	int some_data;
		757	ev_timer t1;
		758	ev_timer t2;
		759	}
		760
		761	In this case getting the pointer to C<my_biggy> is a bit more complicated,
		762	you need to use C<offsetof>:
		763
		764	#include <stddef.h>
		765
		766	static void
		767	t1_cb (EV_P_ struct ev_timer *w, int revents)
		768	{
		769	struct my_biggy big = (struct my_biggy *
		770	(((char *)w) - offsetof (struct my_biggy, t1));
		771	}
		772
		773	static void
		774	t2_cb (EV_P_ struct ev_timer *w, int revents)
		775	{
		776	struct my_biggy big = (struct my_biggy *
		777	(((char *)w) - offsetof (struct my_biggy, t2));
		778	}
684		779
685		780
686	=head1 WATCHER TYPES	781	=head1 WATCHER TYPES
687		782
688	This section describes each watcher in detail, but will not repeat	783	This section describes each watcher in detail, but will not repeat
689	information given in the last section.	784	information given in the last section. Any initialisation/set macros,
		785	functions and members specific to the watcher type are explained.
690		786
		787	Members are additionally marked with either I<[read-only]>, meaning that,
		788	while the watcher is active, you can look at the member and expect some
		789	sensible content, but you must not modify it (you can modify it while the
		790	watcher is stopped to your hearts content), or I<[read-write]>, which
		791	means you can expect it to have some sensible content while the watcher
		792	is active, but you can also modify it. Modifying it may not do something
		793	sensible or take immediate effect (or do anything at all), but libev will
		794	not crash or malfunction in any way.
691		795
		796
692	=head2 C<ev_io> - is this file descriptor readable or writable	797	=head2 C<ev_io> - is this file descriptor readable or writable?
693		798
694	I/O watchers check whether a file descriptor is readable or writable	799	I/O watchers check whether a file descriptor is readable or writable
695	in each iteration of the event loop (This behaviour is called	800	in each iteration of the event loop, or, more precisely, when reading
696	level-triggering because you keep receiving events as long as the	801	would not block the process and writing would at least be able to write
697	condition persists. Remember you can stop the watcher if you don't want to	802	some data. This behaviour is called level-triggering because you keep
698	act on the event and neither want to receive future events).	803	receiving events as long as the condition persists. Remember you can stop
		804	the watcher if you don't want to act on the event and neither want to
		805	receive future events.
699		806
700	In general you can register as many read and/or write event watchers per	807	In general you can register as many read and/or write event watchers per
701	fd as you want (as long as you don't confuse yourself). Setting all file	808	fd as you want (as long as you don't confuse yourself). Setting all file
702	descriptors to non-blocking mode is also usually a good idea (but not	809	descriptors to non-blocking mode is also usually a good idea (but not
703	required if you know what you are doing).	810	required if you know what you are doing).
704		811
705	You have to be careful with dup'ed file descriptors, though. Some backends	812	You have to be careful with dup'ed file descriptors, though. Some backends
706	(the linux epoll backend is a notable example) cannot handle dup'ed file	813	(the linux epoll backend is a notable example) cannot handle dup'ed file
707	descriptors correctly if you register interest in two or more fds pointing	814	descriptors correctly if you register interest in two or more fds pointing
708	to the same underlying file/socket etc. description (that is, they share	815	to the same underlying file/socket/etc. description (that is, they share
709	the same underlying "file open").	816	the same underlying "file open").
710		817
711	If you must do this, then force the use of a known-to-be-good backend	818	If you must do this, then force the use of a known-to-be-good backend
712	(at the time of this writing, this includes only C<EVBACKEND_SELECT> and	819	(at the time of this writing, this includes only C<EVBACKEND_SELECT> and
713	C<EVBACKEND_POLL>).	820	C<EVBACKEND_POLL>).
714		821
		822	Another thing you have to watch out for is that it is quite easy to
		823	receive "spurious" readyness notifications, that is your callback might
		824	be called with C<EV_READ> but a subsequent C<read>(2) will actually block
		825	because there is no data. Not only are some backends known to create a
		826	lot of those (for example solaris ports), it is very easy to get into
		827	this situation even with a relatively standard program structure. Thus
		828	it is best to always use non-blocking I/O: An extra C<read>(2) returning
		829	C<EAGAIN> is far preferable to a program hanging until some data arrives.
		830
		831	If you cannot run the fd in non-blocking mode (for example you should not
		832	play around with an Xlib connection), then you have to seperately re-test
		833	wether a file descriptor is really ready with a known-to-be good interface
		834	such as poll (fortunately in our Xlib example, Xlib already does this on
		835	its own, so its quite safe to use).
		836
715	=over 4	837	=over 4
716		838
717	=item ev_io_init (ev_io *, callback, int fd, int events)	839	=item ev_io_init (ev_io *, callback, int fd, int events)
718		840
719	=item ev_io_set (ev_io *, int fd, int events)	841	=item ev_io_set (ev_io *, int fd, int events)
720		842
721	Configures an C<ev_io> watcher. The fd is the file descriptor to rceeive	843	Configures an C<ev_io> watcher. The C<fd> is the file descriptor to
722	events for and events is either C<EV_READ>, C<EV_WRITE> or C<EV_READ |	844	rceeive events for and events is either C<EV_READ>, C<EV_WRITE> or
723	EV_WRITE> to receive the given events.	845	C<EV_READ | EV_WRITE> to receive the given events.
724		846
725	Please note that most of the more scalable backend mechanisms (for example	847	=item int fd [read-only]
726	epoll and solaris ports) can result in spurious readyness notifications	848
727	for file descriptors, so you practically need to use non-blocking I/O (and	849	The file descriptor being watched.
728	treat callback invocation as hint only), or retest separately with a safe	850
729	interface before doing I/O (XLib can do this), or force the use of either	851	=item int events [read-only]
730	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>, which don't suffer from this	852
731	problem. Also note that it is quite easy to have your callback invoked	853	The events being watched.
732	when the readyness condition is no longer valid even when employing
733	typical ways of handling events, so its a good idea to use non-blocking
734	I/O unconditionally.
735		854
736	=back	855	=back
737		856
738	Example: call C<stdin_readable_cb> when STDIN_FILENO has become, well	857	Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well
739	readable, but only once. Since it is likely line-buffered, you could	858	readable, but only once. Since it is likely line-buffered, you could
740	attempt to read a whole line in the callback:	859	attempt to read a whole line in the callback.
741		860
742	static void	861	static void
743	stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents)	862	stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents)
744	{	863	{
745	ev_io_stop (loop, w);	864	ev_io_stop (loop, w);
…		…
752	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);	871	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);
753	ev_io_start (loop, &stdin_readable);	872	ev_io_start (loop, &stdin_readable);
754	ev_loop (loop, 0);	873	ev_loop (loop, 0);
755		874
756		875
757	=head2 C<ev_timer> - relative and optionally recurring timeouts	876	=head2 C<ev_timer> - relative and optionally repeating timeouts
758		877
759	Timer watchers are simple relative timers that generate an event after a	878	Timer watchers are simple relative timers that generate an event after a
760	given time, and optionally repeating in regular intervals after that.	879	given time, and optionally repeating in regular intervals after that.
761		880
762	The timers are based on real time, that is, if you register an event that	881	The timers are based on real time, that is, if you register an event that
…		…
803		922
804	If the timer is repeating, either start it if necessary (with the repeat	923	If the timer is repeating, either start it if necessary (with the repeat
805	value), or reset the running timer to the repeat value.	924	value), or reset the running timer to the repeat value.
806		925
807	This sounds a bit complicated, but here is a useful and typical	926	This sounds a bit complicated, but here is a useful and typical
808	example: Imagine you have a tcp connection and you want a so-called idle	927	example: Imagine you have a tcp connection and you want a so-called
809	timeout, that is, you want to be called when there have been, say, 60	928	idle timeout, that is, you want to be called when there have been,
810	seconds of inactivity on the socket. The easiest way to do this is to	929	say, 60 seconds of inactivity on the socket. The easiest way to do
811	configure an C<ev_timer> with after=repeat=60 and calling ev_timer_again each	930	this is to configure an C<ev_timer> with C<after>=C<repeat>=C<60> and calling
812	time you successfully read or write some data. If you go into an idle	931	C<ev_timer_again> each time you successfully read or write some data. If
813	state where you do not expect data to travel on the socket, you can stop	932	you go into an idle state where you do not expect data to travel on the
814	the timer, and again will automatically restart it if need be.	933	socket, you can stop the timer, and again will automatically restart it if
		934	need be.
		935
		936	You can also ignore the C<after> value and C<ev_timer_start> altogether
		937	and only ever use the C<repeat> value:
		938
		939	ev_timer_init (timer, callback, 0., 5.);
		940	ev_timer_again (loop, timer);
		941	...
		942	timer->again = 17.;
		943	ev_timer_again (loop, timer);
		944	...
		945	timer->again = 10.;
		946	ev_timer_again (loop, timer);
		947
		948	This is more efficient then stopping/starting the timer eahc time you want
		949	to modify its timeout value.
		950
		951	=item ev_tstamp repeat [read-write]
		952
		953	The current C<repeat> value. Will be used each time the watcher times out
		954	or C<ev_timer_again> is called and determines the next timeout (if any),
		955	which is also when any modifications are taken into account.
815		956
816	=back	957	=back
817		958
818	Example: create a timer that fires after 60 seconds.	959	Example: Create a timer that fires after 60 seconds.
819		960
820	static void	961	static void
821	one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents)	962	one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents)
822	{	963	{
823	.. one minute over, w is actually stopped right here	964	.. one minute over, w is actually stopped right here
…		…
825		966
826	struct ev_timer mytimer;	967	struct ev_timer mytimer;
827	ev_timer_init (&mytimer, one_minute_cb, 60., 0.);	968	ev_timer_init (&mytimer, one_minute_cb, 60., 0.);
828	ev_timer_start (loop, &mytimer);	969	ev_timer_start (loop, &mytimer);
829		970
830	Example: create a timeout timer that times out after 10 seconds of	971	Example: Create a timeout timer that times out after 10 seconds of
831	inactivity.	972	inactivity.
832		973
833	static void	974	static void
834	timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents)	975	timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents)
835	{	976	{
…		…
844	// and in some piece of code that gets executed on any "activity":	985	// and in some piece of code that gets executed on any "activity":
845	// reset the timeout to start ticking again at 10 seconds	986	// reset the timeout to start ticking again at 10 seconds
846	ev_timer_again (&mytimer);	987	ev_timer_again (&mytimer);
847		988
848		989
849	=head2 C<ev_periodic> - to cron or not to cron	990	=head2 C<ev_periodic> - to cron or not to cron?
850		991
851	Periodic watchers are also timers of a kind, but they are very versatile	992	Periodic watchers are also timers of a kind, but they are very versatile
852	(and unfortunately a bit complex).	993	(and unfortunately a bit complex).
853		994
854	Unlike C<ev_timer>'s, they are not based on real time (or relative time)	995	Unlike C<ev_timer>'s, they are not based on real time (or relative time)
855	but on wallclock time (absolute time). You can tell a periodic watcher	996	but on wallclock time (absolute time). You can tell a periodic watcher
856	to trigger "at" some specific point in time. For example, if you tell a	997	to trigger "at" some specific point in time. For example, if you tell a
857	periodic watcher to trigger in 10 seconds (by specifiying e.g. c<ev_now ()	998	periodic watcher to trigger in 10 seconds (by specifiying e.g. C<ev_now ()
858	+ 10.>) and then reset your system clock to the last year, then it will	999	+ 10.>) and then reset your system clock to the last year, then it will
859	take a year to trigger the event (unlike an C<ev_timer>, which would trigger	1000	take a year to trigger the event (unlike an C<ev_timer>, which would trigger
860	roughly 10 seconds later and of course not if you reset your system time	1001	roughly 10 seconds later and of course not if you reset your system time
861	again).	1002	again).
862		1003
…		…
946	Simply stops and restarts the periodic watcher again. This is only useful	1087	Simply stops and restarts the periodic watcher again. This is only useful
947	when you changed some parameters or the reschedule callback would return	1088	when you changed some parameters or the reschedule callback would return
948	a different time than the last time it was called (e.g. in a crond like	1089	a different time than the last time it was called (e.g. in a crond like
949	program when the crontabs have changed).	1090	program when the crontabs have changed).
950		1091
		1092	=item ev_tstamp interval [read-write]
		1093
		1094	The current interval value. Can be modified any time, but changes only
		1095	take effect when the periodic timer fires or C<ev_periodic_again> is being
		1096	called.
		1097
		1098	=item ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read-write]
		1099
		1100	The current reschedule callback, or C<0>, if this functionality is
		1101	switched off. Can be changed any time, but changes only take effect when
		1102	the periodic timer fires or C<ev_periodic_again> is being called.
		1103
951	=back	1104	=back
952		1105
953	Example: call a callback every hour, or, more precisely, whenever the	1106	Example: Call a callback every hour, or, more precisely, whenever the
954	system clock is divisible by 3600. The callback invocation times have	1107	system clock is divisible by 3600. The callback invocation times have
955	potentially a lot of jittering, but good long-term stability.	1108	potentially a lot of jittering, but good long-term stability.
956		1109
957	static void	1110	static void
958	clock_cb (struct ev_loop *loop, struct ev_io *w, int revents)	1111	clock_cb (struct ev_loop *loop, struct ev_io *w, int revents)
…		…
962		1115
963	struct ev_periodic hourly_tick;	1116	struct ev_periodic hourly_tick;
964	ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);	1117	ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);
965	ev_periodic_start (loop, &hourly_tick);	1118	ev_periodic_start (loop, &hourly_tick);
966		1119
967	Example: the same as above, but use a reschedule callback to do it:	1120	Example: The same as above, but use a reschedule callback to do it:
968		1121
969	#include <math.h>	1122	#include <math.h>
970		1123
971	static ev_tstamp	1124	static ev_tstamp
972	my_scheduler_cb (struct ev_periodic *w, ev_tstamp now)	1125	my_scheduler_cb (struct ev_periodic *w, ev_tstamp now)
…		…
974	return fmod (now, 3600.) + 3600.;	1127	return fmod (now, 3600.) + 3600.;
975	}	1128	}
976		1129
977	ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);	1130	ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);
978		1131
979	Example: call a callback every hour, starting now:	1132	Example: Call a callback every hour, starting now:
980		1133
981	struct ev_periodic hourly_tick;	1134	struct ev_periodic hourly_tick;
982	ev_periodic_init (&hourly_tick, clock_cb,	1135	ev_periodic_init (&hourly_tick, clock_cb,
983	fmod (ev_now (loop), 3600.), 3600., 0);	1136	fmod (ev_now (loop), 3600.), 3600., 0);
984	ev_periodic_start (loop, &hourly_tick);	1137	ev_periodic_start (loop, &hourly_tick);
985		1138
986		1139
987	=head2 C<ev_signal> - signal me when a signal gets signalled	1140	=head2 C<ev_signal> - signal me when a signal gets signalled!
988		1141
989	Signal watchers will trigger an event when the process receives a specific	1142	Signal watchers will trigger an event when the process receives a specific
990	signal one or more times. Even though signals are very asynchronous, libev	1143	signal one or more times. Even though signals are very asynchronous, libev
991	will try it's best to deliver signals synchronously, i.e. as part of the	1144	will try it's best to deliver signals synchronously, i.e. as part of the
992	normal event processing, like any other event.	1145	normal event processing, like any other event.
…		…
1005	=item ev_signal_set (ev_signal *, int signum)	1158	=item ev_signal_set (ev_signal *, int signum)
1006		1159
1007	Configures the watcher to trigger on the given signal number (usually one	1160	Configures the watcher to trigger on the given signal number (usually one
1008	of the C<SIGxxx> constants).	1161	of the C<SIGxxx> constants).
1009		1162
		1163	=item int signum [read-only]
		1164
		1165	The signal the watcher watches out for.
		1166
1010	=back	1167	=back
1011		1168
1012		1169
1013	=head2 C<ev_child> - wait for pid status changes	1170	=head2 C<ev_child> - watch out for process status changes
1014		1171
1015	Child watchers trigger when your process receives a SIGCHLD in response to	1172	Child watchers trigger when your process receives a SIGCHLD in response to
1016	some child status changes (most typically when a child of yours dies).	1173	some child status changes (most typically when a child of yours dies).
1017		1174
1018	=over 4	1175	=over 4
…		…
1026	at the C<rstatus> member of the C<ev_child> watcher structure to see	1183	at the C<rstatus> member of the C<ev_child> watcher structure to see
1027	the status word (use the macros from C<sys/wait.h> and see your systems	1184	the status word (use the macros from C<sys/wait.h> and see your systems
1028	C<waitpid> documentation). The C<rpid> member contains the pid of the	1185	C<waitpid> documentation). The C<rpid> member contains the pid of the
1029	process causing the status change.	1186	process causing the status change.
1030		1187
		1188	=item int pid [read-only]
		1189
		1190	The process id this watcher watches out for, or C<0>, meaning any process id.
		1191
		1192	=item int rpid [read-write]
		1193
		1194	The process id that detected a status change.
		1195
		1196	=item int rstatus [read-write]
		1197
		1198	The process exit/trace status caused by C<rpid> (see your systems
		1199	C<waitpid> and C<sys/wait.h> documentation for details).
		1200
1031	=back	1201	=back
1032		1202
1033	Example: try to exit cleanly on SIGINT and SIGTERM.	1203	Example: Try to exit cleanly on SIGINT and SIGTERM.
1034		1204
1035	static void	1205	static void
1036	sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)	1206	sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)
1037	{	1207	{
1038	ev_unloop (loop, EVUNLOOP_ALL);	1208	ev_unloop (loop, EVUNLOOP_ALL);
…		…
1041	struct ev_signal signal_watcher;	1211	struct ev_signal signal_watcher;
1042	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);	1212	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
1043	ev_signal_start (loop, &sigint_cb);	1213	ev_signal_start (loop, &sigint_cb);
1044		1214
1045		1215
		1216	=head2 C<ev_stat> - did the file attributes just change?
		1217
		1218	This watches a filesystem path for attribute changes. That is, it calls
		1219	C<stat> regularly (or when the OS says it changed) and sees if it changed
		1220	compared to the last time, invoking the callback if it did.
		1221
		1222	The path does not need to exist: changing from "path exists" to "path does
		1223	not exist" is a status change like any other. The condition "path does
		1224	not exist" is signified by the C<st_nlink> field being zero (which is
		1225	otherwise always forced to be at least one) and all the other fields of
		1226	the stat buffer having unspecified contents.
		1227
		1228	Since there is no standard to do this, the portable implementation simply
		1229	calls C<stat (2)> regularly on the path to see if it changed somehow. You
		1230	can specify a recommended polling interval for this case. If you specify
		1231	a polling interval of C<0> (highly recommended!) then a I<suitable,
		1232	unspecified default> value will be used (which you can expect to be around
		1233	five seconds, although this might change dynamically). Libev will also
		1234	impose a minimum interval which is currently around C<0.1>, but thats
		1235	usually overkill.
		1236
		1237	This watcher type is not meant for massive numbers of stat watchers,
		1238	as even with OS-supported change notifications, this can be
		1239	resource-intensive.
		1240
		1241	At the time of this writing, only the Linux inotify interface is
		1242	implemented (implementing kqueue support is left as an exercise for the
		1243	reader). Inotify will be used to give hints only and should not change the
		1244	semantics of C<ev_stat> watchers, which means that libev sometimes needs
		1245	to fall back to regular polling again even with inotify, but changes are
		1246	usually detected immediately, and if the file exists there will be no
		1247	polling.
		1248
		1249	=over 4
		1250
		1251	=item ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)
		1252
		1253	=item ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)
		1254
		1255	Configures the watcher to wait for status changes of the given
		1256	C<path>. The C<interval> is a hint on how quickly a change is expected to
		1257	be detected and should normally be specified as C<0> to let libev choose
		1258	a suitable value. The memory pointed to by C<path> must point to the same
		1259	path for as long as the watcher is active.
		1260
		1261	The callback will be receive C<EV_STAT> when a change was detected,
		1262	relative to the attributes at the time the watcher was started (or the
		1263	last change was detected).
		1264
		1265	=item ev_stat_stat (ev_stat *)
		1266
		1267	Updates the stat buffer immediately with new values. If you change the
		1268	watched path in your callback, you could call this fucntion to avoid
		1269	detecting this change (while introducing a race condition). Can also be
		1270	useful simply to find out the new values.
		1271
		1272	=item ev_statdata attr [read-only]
		1273
		1274	The most-recently detected attributes of the file. Although the type is of
		1275	C<ev_statdata>, this is usually the (or one of the) C<struct stat> types
		1276	suitable for your system. If the C<st_nlink> member is C<0>, then there
		1277	was some error while C<stat>ing the file.
		1278
		1279	=item ev_statdata prev [read-only]
		1280
		1281	The previous attributes of the file. The callback gets invoked whenever
		1282	C<prev> != C<attr>.
		1283
		1284	=item ev_tstamp interval [read-only]
		1285
		1286	The specified interval.
		1287
		1288	=item const char *path [read-only]
		1289
		1290	The filesystem path that is being watched.
		1291
		1292	=back
		1293
		1294	Example: Watch C</etc/passwd> for attribute changes.
		1295
		1296	static void
		1297	passwd_cb (struct ev_loop *loop, ev_stat *w, int revents)
		1298	{
		1299	/* /etc/passwd changed in some way */
		1300	if (w->attr.st_nlink)
		1301	{
		1302	printf ("passwd current size %ld\n", (long)w->attr.st_size);
		1303	printf ("passwd current atime %ld\n", (long)w->attr.st_mtime);
		1304	printf ("passwd current mtime %ld\n", (long)w->attr.st_mtime);
		1305	}
		1306	else
		1307	/* you shalt not abuse printf for puts */
		1308	puts ("wow, /etc/passwd is not there, expect problems. "
		1309	"if this is windows, they already arrived\n");
		1310	}
		1311
		1312	...
		1313	ev_stat passwd;
		1314
		1315	ev_stat_init (&passwd, passwd_cb, "/etc/passwd");
		1316	ev_stat_start (loop, &passwd);
		1317
		1318
1046	=head2 C<ev_idle> - when you've got nothing better to do	1319	=head2 C<ev_idle> - when you've got nothing better to do...
1047		1320
1048	Idle watchers trigger events when there are no other events are pending	1321	Idle watchers trigger events when there are no other events are pending
1049	(prepare, check and other idle watchers do not count). That is, as long	1322	(prepare, check and other idle watchers do not count). That is, as long
1050	as your process is busy handling sockets or timeouts (or even signals,	1323	as your process is busy handling sockets or timeouts (or even signals,
1051	imagine) it will not be triggered. But when your process is idle all idle	1324	imagine) it will not be triggered. But when your process is idle all idle
…		…
1069	kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,	1342	kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,
1070	believe me.	1343	believe me.
1071		1344
1072	=back	1345	=back
1073		1346
1074	Example: dynamically allocate an C<ev_idle>, start it, and in the	1347	Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the
1075	callback, free it. Alos, use no error checking, as usual.	1348	callback, free it. Also, use no error checking, as usual.
1076		1349
1077	static void	1350	static void
1078	idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents)	1351	idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents)
1079	{	1352	{
1080	free (w);	1353	free (w);
…		…
1085	struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle));	1358	struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle));
1086	ev_idle_init (idle_watcher, idle_cb);	1359	ev_idle_init (idle_watcher, idle_cb);
1087	ev_idle_start (loop, idle_cb);	1360	ev_idle_start (loop, idle_cb);
1088		1361
1089		1362
1090	=head2 C<ev_prepare> and C<ev_check> - customise your event loop	1363	=head2 C<ev_prepare> and C<ev_check> - customise your event loop!
1091		1364
1092	Prepare and check watchers are usually (but not always) used in tandem:	1365	Prepare and check watchers are usually (but not always) used in tandem:
1093	prepare watchers get invoked before the process blocks and check watchers	1366	prepare watchers get invoked before the process blocks and check watchers
1094	afterwards.	1367	afterwards.
1095		1368
		1369	You I<must not> call C<ev_loop> or similar functions that enter
		1370	the current event loop from either C<ev_prepare> or C<ev_check>
		1371	watchers. Other loops than the current one are fine, however. The
		1372	rationale behind this is that you do not need to check for recursion in
		1373	those watchers, i.e. the sequence will always be C<ev_prepare>, blocking,
		1374	C<ev_check> so if you have one watcher of each kind they will always be
		1375	called in pairs bracketing the blocking call.
		1376
1096	Their main purpose is to integrate other event mechanisms into libev and	1377	Their main purpose is to integrate other event mechanisms into libev and
1097	their use is somewhat advanced. This could be used, for example, to track	1378	their use is somewhat advanced. This could be used, for example, to track
1098	variable changes, implement your own watchers, integrate net-snmp or a	1379	variable changes, implement your own watchers, integrate net-snmp or a
1099	coroutine library and lots more.	1380	coroutine library and lots more. They are also occasionally useful if
		1381	you cache some data and want to flush it before blocking (for example,
		1382	in X programs you might want to do an C<XFlush ()> in an C<ev_prepare>
		1383	watcher).
1100		1384
1101	This is done by examining in each prepare call which file descriptors need	1385	This is done by examining in each prepare call which file descriptors need
1102	to be watched by the other library, registering C<ev_io> watchers for	1386	to be watched by the other library, registering C<ev_io> watchers for
1103	them and starting an C<ev_timer> watcher for any timeouts (many libraries	1387	them and starting an C<ev_timer> watcher for any timeouts (many libraries
1104	provide just this functionality). Then, in the check watcher you check for	1388	provide just this functionality). Then, in the check watcher you check for
…		…
1126	parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>	1410	parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>
1127	macros, but using them is utterly, utterly and completely pointless.	1411	macros, but using them is utterly, utterly and completely pointless.
1128		1412
1129	=back	1413	=back
1130		1414
1131	Example: *TODO*.	1415	Example: To include a library such as adns, you would add IO watchers
		1416	and a timeout watcher in a prepare handler, as required by libadns, and
		1417	in a check watcher, destroy them and call into libadns. What follows is
		1418	pseudo-code only of course:
1132		1419
		1420	static ev_io iow [nfd];
		1421	static ev_timer tw;
1133		1422
		1423	static void
		1424	io_cb (ev_loop *loop, ev_io *w, int revents)
		1425	{
		1426	// set the relevant poll flags
		1427	// could also call adns_processreadable etc. here
		1428	struct pollfd *fd = (struct pollfd *)w->data;
		1429	if (revents & EV_READ ) fd->revents |= fd->events & POLLIN;
		1430	if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT;
		1431	}
		1432
		1433	// create io watchers for each fd and a timer before blocking
		1434	static void
		1435	adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents)
		1436	{
		1437	int timeout = 3600000;truct pollfd fds [nfd];
		1438	// actual code will need to loop here and realloc etc.
		1439	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
		1440
		1441	/* the callback is illegal, but won't be called as we stop during check */
		1442	ev_timer_init (&tw, 0, timeout * 1e-3);
		1443	ev_timer_start (loop, &tw);
		1444
		1445	// create on ev_io per pollfd
		1446	for (int i = 0; i < nfd; ++i)
		1447	{
		1448	ev_io_init (iow + i, io_cb, fds [i].fd,
		1449	((fds [i].events & POLLIN ? EV_READ : 0)
		1450	| (fds [i].events & POLLOUT ? EV_WRITE : 0)));
		1451
		1452	fds [i].revents = 0;
		1453	iow [i].data = fds + i;
		1454	ev_io_start (loop, iow + i);
		1455	}
		1456	}
		1457
		1458	// stop all watchers after blocking
		1459	static void
		1460	adns_check_cb (ev_loop *loop, ev_check *w, int revents)
		1461	{
		1462	ev_timer_stop (loop, &tw);
		1463
		1464	for (int i = 0; i < nfd; ++i)
		1465	ev_io_stop (loop, iow + i);
		1466
		1467	adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));
		1468	}
		1469
		1470
1134	=head2 C<ev_embed> - when one backend isn't enough	1471	=head2 C<ev_embed> - when one backend isn't enough...
1135		1472
1136	This is a rather advanced watcher type that lets you embed one event loop	1473	This is a rather advanced watcher type that lets you embed one event loop
1137	into another (currently only C<ev_io> events are supported in the embedded	1474	into another (currently only C<ev_io> events are supported in the embedded
1138	loop, other types of watchers might be handled in a delayed or incorrect	1475	loop, other types of watchers might be handled in a delayed or incorrect
1139	fashion and must not be used).	1476	fashion and must not be used).
…		…
1217		1554
1218	Make a single, non-blocking sweep over the embedded loop. This works	1555	Make a single, non-blocking sweep over the embedded loop. This works
1219	similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most	1556	similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most
1220	apropriate way for embedded loops.	1557	apropriate way for embedded loops.
1221		1558
		1559	=item struct ev_loop *loop [read-only]
		1560
		1561	The embedded event loop.
		1562
		1563	=back
		1564
		1565
		1566	=head2 C<ev_fork> - the audacity to resume the event loop after a fork
		1567
		1568	Fork watchers are called when a C<fork ()> was detected (usually because
		1569	whoever is a good citizen cared to tell libev about it by calling
		1570	C<ev_default_fork> or C<ev_loop_fork>). The invocation is done before the
		1571	event loop blocks next and before C<ev_check> watchers are being called,
		1572	and only in the child after the fork. If whoever good citizen calling
		1573	C<ev_default_fork> cheats and calls it in the wrong process, the fork
		1574	handlers will be invoked, too, of course.
		1575
		1576	=over 4
		1577
		1578	=item ev_fork_init (ev_signal *, callback)
		1579
		1580	Initialises and configures the fork watcher - it has no parameters of any
		1581	kind. There is a C<ev_fork_set> macro, but using it is utterly pointless,
		1582	believe me.
		1583
1222	=back	1584	=back
1223		1585
1224		1586
1225	=head1 OTHER FUNCTIONS	1587	=head1 OTHER FUNCTIONS
1226		1588
…		…
1306		1668
1307	=back	1669	=back
1308		1670
1309	=head1 C++ SUPPORT	1671	=head1 C++ SUPPORT
1310		1672
1311	TBD.	1673	Libev comes with some simplistic wrapper classes for C++ that mainly allow
		1674	you to use some convinience methods to start/stop watchers and also change
		1675	the callback model to a model using method callbacks on objects.
		1676
		1677	To use it,
		1678
		1679	#include <ev++.h>
		1680
		1681	(it is not installed by default). This automatically includes F<ev.h>
		1682	and puts all of its definitions (many of them macros) into the global
		1683	namespace. All C++ specific things are put into the C<ev> namespace.
		1684
		1685	It should support all the same embedding options as F<ev.h>, most notably
		1686	C<EV_MULTIPLICITY>.
		1687
		1688	Here is a list of things available in the C<ev> namespace:
		1689
		1690	=over 4
		1691
		1692	=item C<ev::READ>, C<ev::WRITE> etc.
		1693
		1694	These are just enum values with the same values as the C<EV_READ> etc.
		1695	macros from F<ev.h>.
		1696
		1697	=item C<ev::tstamp>, C<ev::now>
		1698
		1699	Aliases to the same types/functions as with the C<ev_> prefix.
		1700
		1701	=item C<ev::io>, C<ev::timer>, C<ev::periodic>, C<ev::idle>, C<ev::sig> etc.
		1702
		1703	For each C<ev_TYPE> watcher in F<ev.h> there is a corresponding class of
		1704	the same name in the C<ev> namespace, with the exception of C<ev_signal>
		1705	which is called C<ev::sig> to avoid clashes with the C<signal> macro
		1706	defines by many implementations.
		1707
		1708	All of those classes have these methods:
		1709
		1710	=over 4
		1711
		1712	=item ev::TYPE::TYPE (object *, object::method *)
		1713
		1714	=item ev::TYPE::TYPE (object *, object::method *, struct ev_loop *)
		1715
		1716	=item ev::TYPE::~TYPE
		1717
		1718	The constructor takes a pointer to an object and a method pointer to
		1719	the event handler callback to call in this class. The constructor calls
		1720	C<ev_init> for you, which means you have to call the C<set> method
		1721	before starting it. If you do not specify a loop then the constructor
		1722	automatically associates the default loop with this watcher.
		1723
		1724	The destructor automatically stops the watcher if it is active.
		1725
		1726	=item w->set (struct ev_loop *)
		1727
		1728	Associates a different C<struct ev_loop> with this watcher. You can only
		1729	do this when the watcher is inactive (and not pending either).
		1730
		1731	=item w->set ([args])
		1732
		1733	Basically the same as C<ev_TYPE_set>, with the same args. Must be
		1734	called at least once. Unlike the C counterpart, an active watcher gets
		1735	automatically stopped and restarted.
		1736
		1737	=item w->start ()
		1738
		1739	Starts the watcher. Note that there is no C<loop> argument as the
		1740	constructor already takes the loop.
		1741
		1742	=item w->stop ()
		1743
		1744	Stops the watcher if it is active. Again, no C<loop> argument.
		1745
		1746	=item w->again () C<ev::timer>, C<ev::periodic> only
		1747
		1748	For C<ev::timer> and C<ev::periodic>, this invokes the corresponding
		1749	C<ev_TYPE_again> function.
		1750
		1751	=item w->sweep () C<ev::embed> only
		1752
		1753	Invokes C<ev_embed_sweep>.
		1754
		1755	=item w->update () C<ev::stat> only
		1756
		1757	Invokes C<ev_stat_stat>.
		1758
		1759	=back
		1760
		1761	=back
		1762
		1763	Example: Define a class with an IO and idle watcher, start one of them in
		1764	the constructor.
		1765
		1766	class myclass
		1767	{
		1768	ev_io io; void io_cb (ev::io &w, int revents);
		1769	ev_idle idle void idle_cb (ev::idle &w, int revents);
		1770
		1771	myclass ();
		1772	}
		1773
		1774	myclass::myclass (int fd)
		1775	: io (this, &myclass::io_cb),
		1776	idle (this, &myclass::idle_cb)
		1777	{
		1778	io.start (fd, ev::READ);
		1779	}
		1780
		1781
		1782	=head1 MACRO MAGIC
		1783
		1784	Libev can be compiled with a variety of options, the most fundemantal is
		1785	C<EV_MULTIPLICITY>. This option determines wether (most) functions and
		1786	callbacks have an initial C<struct ev_loop *> argument.
		1787
		1788	To make it easier to write programs that cope with either variant, the
		1789	following macros are defined:
		1790
		1791	=over 4
		1792
		1793	=item C<EV_A>, C<EV_A_>
		1794
		1795	This provides the loop I<argument> for functions, if one is required ("ev
		1796	loop argument"). The C<EV_A> form is used when this is the sole argument,
		1797	C<EV_A_> is used when other arguments are following. Example:
		1798
		1799	ev_unref (EV_A);
		1800	ev_timer_add (EV_A_ watcher);
		1801	ev_loop (EV_A_ 0);
		1802
		1803	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,
		1804	which is often provided by the following macro.
		1805
		1806	=item C<EV_P>, C<EV_P_>
		1807
		1808	This provides the loop I<parameter> for functions, if one is required ("ev
		1809	loop parameter"). The C<EV_P> form is used when this is the sole parameter,
		1810	C<EV_P_> is used when other parameters are following. Example:
		1811
		1812	// this is how ev_unref is being declared
		1813	static void ev_unref (EV_P);
		1814
		1815	// this is how you can declare your typical callback
		1816	static void cb (EV_P_ ev_timer *w, int revents)
		1817
		1818	It declares a parameter C<loop> of type C<struct ev_loop *>, quite
		1819	suitable for use with C<EV_A>.
		1820
		1821	=item C<EV_DEFAULT>, C<EV_DEFAULT_>
		1822
		1823	Similar to the other two macros, this gives you the value of the default
		1824	loop, if multiple loops are supported ("ev loop default").
		1825
		1826	=back
		1827
		1828	Example: Declare and initialise a check watcher, working regardless of
		1829	wether multiple loops are supported or not.
		1830
		1831	static void
		1832	check_cb (EV_P_ ev_timer *w, int revents)
		1833	{
		1834	ev_check_stop (EV_A_ w);
		1835	}
		1836
		1837	ev_check check;
		1838	ev_check_init (&check, check_cb);
		1839	ev_check_start (EV_DEFAULT_ &check);
		1840	ev_loop (EV_DEFAULT_ 0);
		1841
		1842
		1843	=head1 EMBEDDING
		1844
		1845	Libev can (and often is) directly embedded into host
		1846	applications. Examples of applications that embed it include the Deliantra
		1847	Game Server, the EV perl module, the GNU Virtual Private Ethernet (gvpe)
		1848	and rxvt-unicode.
		1849
		1850	The goal is to enable you to just copy the neecssary files into your
		1851	source directory without having to change even a single line in them, so
		1852	you can easily upgrade by simply copying (or having a checked-out copy of
		1853	libev somewhere in your source tree).
		1854
		1855	=head2 FILESETS
		1856
		1857	Depending on what features you need you need to include one or more sets of files
		1858	in your app.
		1859
		1860	=head3 CORE EVENT LOOP
		1861
		1862	To include only the libev core (all the C<ev_*> functions), with manual
		1863	configuration (no autoconf):
		1864
		1865	#define EV_STANDALONE 1
		1866	#include "ev.c"
		1867
		1868	This will automatically include F<ev.h>, too, and should be done in a
		1869	single C source file only to provide the function implementations. To use
		1870	it, do the same for F<ev.h> in all files wishing to use this API (best
		1871	done by writing a wrapper around F<ev.h> that you can include instead and
		1872	where you can put other configuration options):
		1873
		1874	#define EV_STANDALONE 1
		1875	#include "ev.h"
		1876
		1877	Both header files and implementation files can be compiled with a C++
		1878	compiler (at least, thats a stated goal, and breakage will be treated
		1879	as a bug).
		1880
		1881	You need the following files in your source tree, or in a directory
		1882	in your include path (e.g. in libev/ when using -Ilibev):
		1883
		1884	ev.h
		1885	ev.c
		1886	ev_vars.h
		1887	ev_wrap.h
		1888
		1889	ev_win32.c required on win32 platforms only
		1890
		1891	ev_select.c only when select backend is enabled (which is by default)
		1892	ev_poll.c only when poll backend is enabled (disabled by default)
		1893	ev_epoll.c only when the epoll backend is enabled (disabled by default)
		1894	ev_kqueue.c only when the kqueue backend is enabled (disabled by default)
		1895	ev_port.c only when the solaris port backend is enabled (disabled by default)
		1896
		1897	F<ev.c> includes the backend files directly when enabled, so you only need
		1898	to compile this single file.
		1899
		1900	=head3 LIBEVENT COMPATIBILITY API
		1901
		1902	To include the libevent compatibility API, also include:
		1903
		1904	#include "event.c"
		1905
		1906	in the file including F<ev.c>, and:
		1907
		1908	#include "event.h"
		1909
		1910	in the files that want to use the libevent API. This also includes F<ev.h>.
		1911
		1912	You need the following additional files for this:
		1913
		1914	event.h
		1915	event.c
		1916
		1917	=head3 AUTOCONF SUPPORT
		1918
		1919	Instead of using C<EV_STANDALONE=1> and providing your config in
		1920	whatever way you want, you can also C<m4_include([libev.m4])> in your
		1921	F<configure.ac> and leave C<EV_STANDALONE> undefined. F<ev.c> will then
		1922	include F<config.h> and configure itself accordingly.
		1923
		1924	For this of course you need the m4 file:
		1925
		1926	libev.m4
		1927
		1928	=head2 PREPROCESSOR SYMBOLS/MACROS
		1929
		1930	Libev can be configured via a variety of preprocessor symbols you have to define
		1931	before including any of its files. The default is not to build for multiplicity
		1932	and only include the select backend.
		1933
		1934	=over 4
		1935
		1936	=item EV_STANDALONE
		1937
		1938	Must always be C<1> if you do not use autoconf configuration, which
		1939	keeps libev from including F<config.h>, and it also defines dummy
		1940	implementations for some libevent functions (such as logging, which is not
		1941	supported). It will also not define any of the structs usually found in
		1942	F<event.h> that are not directly supported by the libev core alone.
		1943
		1944	=item EV_USE_MONOTONIC
		1945
		1946	If defined to be C<1>, libev will try to detect the availability of the
		1947	monotonic clock option at both compiletime and runtime. Otherwise no use
		1948	of the monotonic clock option will be attempted. If you enable this, you
		1949	usually have to link against librt or something similar. Enabling it when
		1950	the functionality isn't available is safe, though, althoguh you have
		1951	to make sure you link against any libraries where the C<clock_gettime>
		1952	function is hiding in (often F<-lrt>).
		1953
		1954	=item EV_USE_REALTIME
		1955
		1956	If defined to be C<1>, libev will try to detect the availability of the
		1957	realtime clock option at compiletime (and assume its availability at
		1958	runtime if successful). Otherwise no use of the realtime clock option will
		1959	be attempted. This effectively replaces C<gettimeofday> by C<clock_get
		1960	(CLOCK_REALTIME, ...)> and will not normally affect correctness. See tzhe note about libraries
		1961	in the description of C<EV_USE_MONOTONIC>, though.
		1962
		1963	=item EV_USE_SELECT
		1964
		1965	If undefined or defined to be C<1>, libev will compile in support for the
		1966	C<select>(2) backend. No attempt at autodetection will be done: if no
		1967	other method takes over, select will be it. Otherwise the select backend
		1968	will not be compiled in.
		1969
		1970	=item EV_SELECT_USE_FD_SET
		1971
		1972	If defined to C<1>, then the select backend will use the system C<fd_set>
		1973	structure. This is useful if libev doesn't compile due to a missing
		1974	C<NFDBITS> or C<fd_mask> definition or it misguesses the bitset layout on
		1975	exotic systems. This usually limits the range of file descriptors to some
		1976	low limit such as 1024 or might have other limitations (winsocket only
		1977	allows 64 sockets). The C<FD_SETSIZE> macro, set before compilation, might
		1978	influence the size of the C<fd_set> used.
		1979
		1980	=item EV_SELECT_IS_WINSOCKET
		1981
		1982	When defined to C<1>, the select backend will assume that
		1983	select/socket/connect etc. don't understand file descriptors but
		1984	wants osf handles on win32 (this is the case when the select to
		1985	be used is the winsock select). This means that it will call
		1986	C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise,
		1987	it is assumed that all these functions actually work on fds, even
		1988	on win32. Should not be defined on non-win32 platforms.
		1989
		1990	=item EV_USE_POLL
		1991
		1992	If defined to be C<1>, libev will compile in support for the C<poll>(2)
		1993	backend. Otherwise it will be enabled on non-win32 platforms. It
		1994	takes precedence over select.
		1995
		1996	=item EV_USE_EPOLL
		1997
		1998	If defined to be C<1>, libev will compile in support for the Linux
		1999	C<epoll>(7) backend. Its availability will be detected at runtime,
		2000	otherwise another method will be used as fallback. This is the
		2001	preferred backend for GNU/Linux systems.
		2002
		2003	=item EV_USE_KQUEUE
		2004
		2005	If defined to be C<1>, libev will compile in support for the BSD style
		2006	C<kqueue>(2) backend. Its actual availability will be detected at runtime,
		2007	otherwise another method will be used as fallback. This is the preferred
		2008	backend for BSD and BSD-like systems, although on most BSDs kqueue only
		2009	supports some types of fds correctly (the only platform we found that
		2010	supports ptys for example was NetBSD), so kqueue might be compiled in, but
		2011	not be used unless explicitly requested. The best way to use it is to find
		2012	out whether kqueue supports your type of fd properly and use an embedded
		2013	kqueue loop.
		2014
		2015	=item EV_USE_PORT
		2016
		2017	If defined to be C<1>, libev will compile in support for the Solaris
		2018	10 port style backend. Its availability will be detected at runtime,
		2019	otherwise another method will be used as fallback. This is the preferred
		2020	backend for Solaris 10 systems.
		2021
		2022	=item EV_USE_DEVPOLL
		2023
		2024	reserved for future expansion, works like the USE symbols above.
		2025
		2026	=item EV_USE_INOTIFY
		2027
		2028	If defined to be C<1>, libev will compile in support for the Linux inotify
		2029	interface to speed up C<ev_stat> watchers. Its actual availability will
		2030	be detected at runtime.
		2031
		2032	=item EV_H
		2033
		2034	The name of the F<ev.h> header file used to include it. The default if
		2035	undefined is C<< <ev.h> >> in F<event.h> and C<"ev.h"> in F<ev.c>. This
		2036	can be used to virtually rename the F<ev.h> header file in case of conflicts.
		2037
		2038	=item EV_CONFIG_H
		2039
		2040	If C<EV_STANDALONE> isn't C<1>, this variable can be used to override
		2041	F<ev.c>'s idea of where to find the F<config.h> file, similarly to
		2042	C<EV_H>, above.
		2043
		2044	=item EV_EVENT_H
		2045
		2046	Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea
		2047	of how the F<event.h> header can be found.
		2048
		2049	=item EV_PROTOTYPES
		2050
		2051	If defined to be C<0>, then F<ev.h> will not define any function
		2052	prototypes, but still define all the structs and other symbols. This is
		2053	occasionally useful if you want to provide your own wrapper functions
		2054	around libev functions.
		2055
		2056	=item EV_MULTIPLICITY
		2057
		2058	If undefined or defined to C<1>, then all event-loop-specific functions
		2059	will have the C<struct ev_loop *> as first argument, and you can create
		2060	additional independent event loops. Otherwise there will be no support
		2061	for multiple event loops and there is no first event loop pointer
		2062	argument. Instead, all functions act on the single default loop.
		2063
		2064	=item EV_PERIODIC_ENABLE
		2065
		2066	If undefined or defined to be C<1>, then periodic timers are supported. If
		2067	defined to be C<0>, then they are not. Disabling them saves a few kB of
		2068	code.
		2069
		2070	=item EV_EMBED_ENABLE
		2071
		2072	If undefined or defined to be C<1>, then embed watchers are supported. If
		2073	defined to be C<0>, then they are not.
		2074
		2075	=item EV_STAT_ENABLE
		2076
		2077	If undefined or defined to be C<1>, then stat watchers are supported. If
		2078	defined to be C<0>, then they are not.
		2079
		2080	=item EV_FORK_ENABLE
		2081
		2082	If undefined or defined to be C<1>, then fork watchers are supported. If
		2083	defined to be C<0>, then they are not.
		2084
		2085	=item EV_MINIMAL
		2086
		2087	If you need to shave off some kilobytes of code at the expense of some
		2088	speed, define this symbol to C<1>. Currently only used for gcc to override
		2089	some inlining decisions, saves roughly 30% codesize of amd64.
		2090
		2091	=item EV_PID_HASHSIZE
		2092
		2093	C<ev_child> watchers use a small hash table to distribute workload by
		2094	pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more
		2095	than enough. If you need to manage thousands of children you might want to
		2096	increase this value (I<must> be a power of two).
		2097
		2098	=item EV_INOTIFY_HASHSIZE
		2099
		2100	C<ev_staz> watchers use a small hash table to distribute workload by
		2101	inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>),
		2102	usually more than enough. If you need to manage thousands of C<ev_stat>
		2103	watchers you might want to increase this value (I<must> be a power of
		2104	two).
		2105
		2106	=item EV_COMMON
		2107
		2108	By default, all watchers have a C<void *data> member. By redefining
		2109	this macro to a something else you can include more and other types of
		2110	members. You have to define it each time you include one of the files,
		2111	though, and it must be identical each time.
		2112
		2113	For example, the perl EV module uses something like this:
		2114
		2115	#define EV_COMMON \
		2116	SV *self; /* contains this struct */ \
		2117	SV *cb_sv, *fh /* note no trailing ";" */
		2118
		2119	=item EV_CB_DECLARE (type)
		2120
		2121	=item EV_CB_INVOKE (watcher, revents)
		2122
		2123	=item ev_set_cb (ev, cb)
		2124
		2125	Can be used to change the callback member declaration in each watcher,
		2126	and the way callbacks are invoked and set. Must expand to a struct member
		2127	definition and a statement, respectively. See the F<ev.v> header file for
		2128	their default definitions. One possible use for overriding these is to
		2129	avoid the C<struct ev_loop *> as first argument in all cases, or to use
		2130	method calls instead of plain function calls in C++.
		2131
		2132	=head2 EXAMPLES
		2133
		2134	For a real-world example of a program the includes libev
		2135	verbatim, you can have a look at the EV perl module
		2136	(L<http://software.schmorp.de/pkg/EV.html>). It has the libev files in
		2137	the F<libev/> subdirectory and includes them in the F<EV/EVAPI.h> (public
		2138	interface) and F<EV.xs> (implementation) files. Only the F<EV.xs> file
		2139	will be compiled. It is pretty complex because it provides its own header
		2140	file.
		2141
		2142	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file
		2143	that everybody includes and which overrides some autoconf choices:
		2144
		2145	#define EV_USE_POLL 0
		2146	#define EV_MULTIPLICITY 0
		2147	#define EV_PERIODICS 0
		2148	#define EV_CONFIG_H <config.h>
		2149
		2150	#include "ev++.h"
		2151
		2152	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
		2153
		2154	#include "ev_cpp.h"
		2155	#include "ev.c"
		2156
		2157
		2158	=head1 COMPLEXITIES
		2159
		2160	In this section the complexities of (many of) the algorithms used inside
		2161	libev will be explained. For complexity discussions about backends see the
		2162	documentation for C<ev_default_init>.
		2163
		2164	=over 4
		2165
		2166	=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers)
		2167
		2168	=item Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)
		2169
		2170	=item Starting io/check/prepare/idle/signal/child watchers: O(1)
		2171
		2172	=item Stopping check/prepare/idle watchers: O(1)
		2173
		2174	=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))
		2175
		2176	=item Finding the next timer per loop iteration: O(1)
		2177
		2178	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)
		2179
		2180	=item Activating one watcher: O(1)
		2181
		2182	=back
		2183
1312		2184
1313	=head1 AUTHOR	2185	=head1 AUTHOR
1314		2186
1315	Marc Lehmann <libev@schmorp.de>.	2187	Marc Lehmann <libev@schmorp.de>.
1316		2188

Diff Legend

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