[ViewVC] Diff of: cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.57 by root, Wed Nov 28 11:27:29 2007 UTC vs.
Revision 1.86 by root, Tue Dec 18 01:20:33 2007 UTC

…		…
47		47
48	return 0;	48	return 0;
49	}	49	}
50		50
51	=head1 DESCRIPTION	51	=head1 DESCRIPTION
		52
		53	The newest version of this document is also available as a html-formatted
		54	web page you might find easier to navigate when reading it for the first
		55	time: L<http://cvs.schmorp.de/libev/ev.html>.
52		56
53	Libev is an event loop: you register interest in certain events (such as a	57	Libev is an event loop: you register interest in certain events (such as a
54	file descriptor being readable or a timeout occuring), and it will manage	58	file descriptor being readable or a timeout occuring), and it will manage
55	these event sources and provide your program with events.	59	these event sources and provide your program with events.
56		60
…		…
63	details of the event, and then hand it over to libev by I<starting> the	67	details of the event, and then hand it over to libev by I<starting> the
64	watcher.	68	watcher.
65		69
66	=head1 FEATURES	70	=head1 FEATURES
67		71
68	Libev supports C<select>, C<poll>, the linux-specific C<epoll>, the	72	Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the
69	bsd-specific C<kqueue> and the solaris-specific event port mechanisms	73	BSD-specific C<kqueue> and the Solaris-specific event port mechanisms
70	for file descriptor events (C<ev_io>), relative timers (C<ev_timer>),	74	for file descriptor events (C<ev_io>), the Linux C<inotify> interface
		75	(for C<ev_stat>), relative timers (C<ev_timer>), absolute timers
71	absolute timers with customised rescheduling (C<ev_periodic>), synchronous	76	with customised rescheduling (C<ev_periodic>), synchronous signals
72	signals (C<ev_signal>), process status change events (C<ev_child>), and	77	(C<ev_signal>), process status change events (C<ev_child>), and event
73	event watchers dealing with the event loop mechanism itself (C<ev_idle>,	78	watchers dealing with the event loop mechanism itself (C<ev_idle>,
74	C<ev_embed>, C<ev_prepare> and C<ev_check> watchers) as well as	79	C<ev_embed>, C<ev_prepare> and C<ev_check> watchers) as well as
75	file watchers (C<ev_stat>) and even limited support for fork events	80	file watchers (C<ev_stat>) and even limited support for fork events
76	(C<ev_fork>).	81	(C<ev_fork>).
77		82
78	It also is quite fast (see this	83	It also is quite fast (see this
…		…
93	Libev represents time as a single floating point number, representing the	98	Libev represents time as a single floating point number, representing the
94	(fractional) number of seconds since the (POSIX) epoch (somewhere near	99	(fractional) number of seconds since the (POSIX) epoch (somewhere near
95	the beginning of 1970, details are complicated, don't ask). This type is	100	the beginning of 1970, details are complicated, don't ask). This type is
96	called C<ev_tstamp>, which is what you should use too. It usually aliases	101	called C<ev_tstamp>, which is what you should use too. It usually aliases
97	to the C<double> type in C, and when you need to do any calculations on	102	to the C<double> type in C, and when you need to do any calculations on
98	it, you should treat it as such.	103	it, you should treat it as some floatingpoint value. Unlike the name
		104	component C<stamp> might indicate, it is also used for time differences
		105	throughout libev.
99		106
100	=head1 GLOBAL FUNCTIONS	107	=head1 GLOBAL FUNCTIONS
101		108
102	These functions can be called anytime, even before initialising the	109	These functions can be called anytime, even before initialising the
103	library in any way.	110	library in any way.
…		…
112		119
113	=item int ev_version_major ()	120	=item int ev_version_major ()
114		121
115	=item int ev_version_minor ()	122	=item int ev_version_minor ()
116		123
117	You can find out the major and minor version numbers of the library	124	You can find out the major and minor ABI version numbers of the library
118	you linked against by calling the functions C<ev_version_major> and	125	you linked against by calling the functions C<ev_version_major> and
119	C<ev_version_minor>. If you want, you can compare against the global	126	C<ev_version_minor>. If you want, you can compare against the global
120	symbols C<EV_VERSION_MAJOR> and C<EV_VERSION_MINOR>, which specify the	127	symbols C<EV_VERSION_MAJOR> and C<EV_VERSION_MINOR>, which specify the
121	version of the library your program was compiled against.	128	version of the library your program was compiled against.
122		129
		130	These version numbers refer to the ABI version of the library, not the
		131	release version.
		132
123	Usually, it's a good idea to terminate if the major versions mismatch,	133	Usually, it's a good idea to terminate if the major versions mismatch,
124	as this indicates an incompatible change. Minor versions are usually	134	as this indicates an incompatible change. Minor versions are usually
125	compatible to older versions, so a larger minor version alone is usually	135	compatible to older versions, so a larger minor version alone is usually
126	not a problem.	136	not a problem.
127		137
128	Example: Make sure we haven't accidentally been linked against the wrong	138	Example: Make sure we haven't accidentally been linked against the wrong
129	version.	139	version.
…		…
162	C<ev_embeddable_backends () & ev_supported_backends ()>, likewise for	172	C<ev_embeddable_backends () & ev_supported_backends ()>, likewise for
163	recommended ones.	173	recommended ones.
164		174
165	See the description of C<ev_embed> watchers for more info.	175	See the description of C<ev_embed> watchers for more info.
166		176
167	=item ev_set_allocator (void (cb)(void *ptr, size_t size))	177	=item ev_set_allocator (void (cb)(void *ptr, long size))
168		178
169	Sets the allocation function to use (the prototype and semantics are	179	Sets the allocation function to use (the prototype is similar - the
170	identical to the realloc C function). It is used to allocate and free	180	semantics is identical - to the realloc C function). It is used to
171	memory (no surprises here). If it returns zero when memory needs to be	181	allocate and free memory (no surprises here). If it returns zero when
172	allocated, the library might abort or take some potentially destructive	182	memory needs to be allocated, the library might abort or take some
173	action. The default is your system realloc function.	183	potentially destructive action. The default is your system realloc
		184	function.
174		185
175	You could override this function in high-availability programs to, say,	186	You could override this function in high-availability programs to, say,
176	free some memory if it cannot allocate memory, to use a special allocator,	187	free some memory if it cannot allocate memory, to use a special allocator,
177	or even to sleep a while and retry until some memory is available.	188	or even to sleep a while and retry until some memory is available.
178		189
…		…
264	C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will	275	C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will
265	override the flags completely if it is found in the environment. This is	276	override the flags completely if it is found in the environment. This is
266	useful to try out specific backends to test their performance, or to work	277	useful to try out specific backends to test their performance, or to work
267	around bugs.	278	around bugs.
268		279
		280	=item C<EVFLAG_FORKCHECK>
		281
		282	Instead of calling C<ev_default_fork> or C<ev_loop_fork> manually after
		283	a fork, you can also make libev check for a fork in each iteration by
		284	enabling this flag.
		285
		286	This works by calling C<getpid ()> on every iteration of the loop,
		287	and thus this might slow down your event loop if you do a lot of loop
		288	iterations and little real work, but is usually not noticeable (on my
		289	Linux system for example, C<getpid> is actually a simple 5-insn sequence
		290	without a syscall and thus I<very> fast, but my Linux system also has
		291	C<pthread_atfork> which is even faster).
		292
		293	The big advantage of this flag is that you can forget about fork (and
		294	forget about forgetting to tell libev about forking) when you use this
		295	flag.
		296
		297	This flag setting cannot be overriden or specified in the C<LIBEV_FLAGS>
		298	environment variable.
		299
269	=item C<EVBACKEND_SELECT> (value 1, portable select backend)	300	=item C<EVBACKEND_SELECT> (value 1, portable select backend)
270		301
271	This is your standard select(2) backend. Not I<completely> standard, as	302	This is your standard select(2) backend. Not I<completely> standard, as
272	libev tries to roll its own fd_set with no limits on the number of fds,	303	libev tries to roll its own fd_set with no limits on the number of fds,
273	but if that fails, expect a fairly low limit on the number of fds when	304	but if that fails, expect a fairly low limit on the number of fds when
…		…
408		439
409	Like C<ev_default_fork>, but acts on an event loop created by	440	Like C<ev_default_fork>, but acts on an event loop created by
410	C<ev_loop_new>. Yes, you have to call this on every allocated event loop	441	C<ev_loop_new>. Yes, you have to call this on every allocated event loop
411	after fork, and how you do this is entirely your own problem.	442	after fork, and how you do this is entirely your own problem.
412		443
		444	=item unsigned int ev_loop_count (loop)
		445
		446	Returns the count of loop iterations for the loop, which is identical to
		447	the number of times libev did poll for new events. It starts at C<0> and
		448	happily wraps around with enough iterations.
		449
		450	This value can sometimes be useful as a generation counter of sorts (it
		451	"ticks" the number of loop iterations), as it roughly corresponds with
		452	C<ev_prepare> and C<ev_check> calls.
		453
413	=item unsigned int ev_backend (loop)	454	=item unsigned int ev_backend (loop)
414		455
415	Returns one of the C<EVBACKEND_*> flags indicating the event backend in	456	Returns one of the C<EVBACKEND_*> flags indicating the event backend in
416	use.	457	use.
417		458
…		…
450	libev watchers. However, a pair of C<ev_prepare>/C<ev_check> watchers is	491	libev watchers. However, a pair of C<ev_prepare>/C<ev_check> watchers is
451	usually a better approach for this kind of thing.	492	usually a better approach for this kind of thing.
452		493
453	Here are the gory details of what C<ev_loop> does:	494	Here are the gory details of what C<ev_loop> does:
454		495
		496	- Before the first iteration, call any pending watchers.
455	* If there are no active watchers (reference count is zero), return.	497	* If there are no active watchers (reference count is zero), return.
456	- Queue prepare watchers and then call all outstanding watchers.	498	- Queue all prepare watchers and then call all outstanding watchers.
457	- If we have been forked, recreate the kernel state.	499	- If we have been forked, recreate the kernel state.
458	- Update the kernel state with all outstanding changes.	500	- Update the kernel state with all outstanding changes.
459	- Update the "event loop time".	501	- Update the "event loop time".
460	- Calculate for how long to block.	502	- Calculate for how long to block.
461	- Block the process, waiting for any events.	503	- Block the process, waiting for any events.
…		…
700	=item bool ev_is_pending (ev_TYPE *watcher)	742	=item bool ev_is_pending (ev_TYPE *watcher)
701		743
702	Returns a true value iff the watcher is pending, (i.e. it has outstanding	744	Returns a true value iff the watcher is pending, (i.e. it has outstanding
703	events but its callback has not yet been invoked). As long as a watcher	745	events but its callback has not yet been invoked). As long as a watcher
704	is pending (but not active) you must not call an init function on it (but	746	is pending (but not active) you must not call an init function on it (but
705	C<ev_TYPE_set> is safe) and you must make sure the watcher is available to	747	C<ev_TYPE_set> is safe), you must not change its priority, and you must
706	libev (e.g. you cnanot C<free ()> it).	748	make sure the watcher is available to libev (e.g. you cannot C<free ()>
		749	it).
707		750
708	=item callback ev_cb (ev_TYPE *watcher)	751	=item callback ev_cb (ev_TYPE *watcher)
709		752
710	Returns the callback currently set on the watcher.	753	Returns the callback currently set on the watcher.
711		754
712	=item ev_cb_set (ev_TYPE *watcher, callback)	755	=item ev_cb_set (ev_TYPE *watcher, callback)
713		756
714	Change the callback. You can change the callback at virtually any time	757	Change the callback. You can change the callback at virtually any time
715	(modulo threads).	758	(modulo threads).
		759
		760	=item ev_set_priority (ev_TYPE *watcher, priority)
		761
		762	=item int ev_priority (ev_TYPE *watcher)
		763
		764	Set and query the priority of the watcher. The priority is a small
		765	integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>
		766	(default: C<-2>). Pending watchers with higher priority will be invoked
		767	before watchers with lower priority, but priority will not keep watchers
		768	from being executed (except for C<ev_idle> watchers).
		769
		770	This means that priorities are I<only> used for ordering callback
		771	invocation after new events have been received. This is useful, for
		772	example, to reduce latency after idling, or more often, to bind two
		773	watchers on the same event and make sure one is called first.
		774
		775	If you need to suppress invocation when higher priority events are pending
		776	you need to look at C<ev_idle> watchers, which provide this functionality.
		777
		778	You I<must not> change the priority of a watcher as long as it is active or
		779	pending.
		780
		781	The default priority used by watchers when no priority has been set is
		782	always C<0>, which is supposed to not be too high and not be too low :).
		783
		784	Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is
		785	fine, as long as you do not mind that the priority value you query might
		786	or might not have been adjusted to be within valid range.
		787
		788	=item ev_invoke (loop, ev_TYPE *watcher, int revents)
		789
		790	Invoke the C<watcher> with the given C<loop> and C<revents>. Neither
		791	C<loop> nor C<revents> need to be valid as long as the watcher callback
		792	can deal with that fact.
		793
		794	=item int ev_clear_pending (loop, ev_TYPE *watcher)
		795
		796	If the watcher is pending, this function returns clears its pending status
		797	and returns its C<revents> bitset (as if its callback was invoked). If the
		798	watcher isn't pending it does nothing and returns C<0>.
716		799
717	=back	800	=back
718		801
719		802
720	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER	803	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
…		…
826	it is best to always use non-blocking I/O: An extra C<read>(2) returning	909	it is best to always use non-blocking I/O: An extra C<read>(2) returning
827	C<EAGAIN> is far preferable to a program hanging until some data arrives.	910	C<EAGAIN> is far preferable to a program hanging until some data arrives.
828		911
829	If you cannot run the fd in non-blocking mode (for example you should not	912	If you cannot run the fd in non-blocking mode (for example you should not
830	play around with an Xlib connection), then you have to seperately re-test	913	play around with an Xlib connection), then you have to seperately re-test
831	wether a file descriptor is really ready with a known-to-be good interface	914	whether a file descriptor is really ready with a known-to-be good interface
832	such as poll (fortunately in our Xlib example, Xlib already does this on	915	such as poll (fortunately in our Xlib example, Xlib already does this on
833	its own, so its quite safe to use).	916	its own, so its quite safe to use).
		917
		918	=head3 The special problem of disappearing file descriptors
		919
		920	Some backends (e.g kqueue, epoll) need to be told about closing a file
		921	descriptor (either by calling C<close> explicitly or by any other means,
		922	such as C<dup>). The reason is that you register interest in some file
		923	descriptor, but when it goes away, the operating system will silently drop
		924	this interest. If another file descriptor with the same number then is
		925	registered with libev, there is no efficient way to see that this is, in
		926	fact, a different file descriptor.
		927
		928	To avoid having to explicitly tell libev about such cases, libev follows
		929	the following policy: Each time C<ev_io_set> is being called, libev
		930	will assume that this is potentially a new file descriptor, otherwise
		931	it is assumed that the file descriptor stays the same. That means that
		932	you I<have> to call C<ev_io_set> (or C<ev_io_init>) when you change the
		933	descriptor even if the file descriptor number itself did not change.
		934
		935	This is how one would do it normally anyway, the important point is that
		936	the libev application should not optimise around libev but should leave
		937	optimisations to libev.
		938
		939
		940	=head3 Watcher-Specific Functions
834		941
835	=over 4	942	=over 4
836		943
837	=item ev_io_init (ev_io *, callback, int fd, int events)	944	=item ev_io_init (ev_io *, callback, int fd, int events)
838		945
…		…
892		999
893	The callback is guarenteed to be invoked only when its timeout has passed,	1000	The callback is guarenteed to be invoked only when its timeout has passed,
894	but if multiple timers become ready during the same loop iteration then	1001	but if multiple timers become ready during the same loop iteration then
895	order of execution is undefined.	1002	order of execution is undefined.
896		1003
		1004	=head3 Watcher-Specific Functions and Data Members
		1005
897	=over 4	1006	=over 4
898		1007
899	=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)	1008	=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
900		1009
901	=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)	1010	=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)
…		…
914	=item ev_timer_again (loop)	1023	=item ev_timer_again (loop)
915		1024
916	This will act as if the timer timed out and restart it again if it is	1025	This will act as if the timer timed out and restart it again if it is
917	repeating. The exact semantics are:	1026	repeating. The exact semantics are:
918		1027
		1028	If the timer is pending, its pending status is cleared.
		1029
919	If the timer is started but nonrepeating, stop it.	1030	If the timer is started but nonrepeating, stop it (as if it timed out).
920		1031
921	If the timer is repeating, either start it if necessary (with the repeat	1032	If the timer is repeating, either start it if necessary (with the
922	value), or reset the running timer to the repeat value.	1033	C<repeat> value), or reset the running timer to the C<repeat> value.
923		1034
924	This sounds a bit complicated, but here is a useful and typical	1035	This sounds a bit complicated, but here is a useful and typical
925	example: Imagine you have a tcp connection and you want a so-called	1036	example: Imagine you have a tcp connection and you want a so-called idle
926	idle timeout, that is, you want to be called when there have been,	1037	timeout, that is, you want to be called when there have been, say, 60
927	say, 60 seconds of inactivity on the socket. The easiest way to do	1038	seconds of inactivity on the socket. The easiest way to do this is to
928	this is to configure an C<ev_timer> with C<after>=C<repeat>=C<60> and calling	1039	configure an C<ev_timer> with a C<repeat> value of C<60> and then call
929	C<ev_timer_again> each time you successfully read or write some data. If	1040	C<ev_timer_again> each time you successfully read or write some data. If
930	you go into an idle state where you do not expect data to travel on the	1041	you go into an idle state where you do not expect data to travel on the
931	socket, you can stop the timer, and again will automatically restart it if	1042	socket, you can C<ev_timer_stop> the timer, and C<ev_timer_again> will
932	need be.	1043	automatically restart it if need be.
933		1044
934	You can also ignore the C<after> value and C<ev_timer_start> altogether	1045	That means you can ignore the C<after> value and C<ev_timer_start>
935	and only ever use the C<repeat> value:	1046	altogether and only ever use the C<repeat> value and C<ev_timer_again>:
936		1047
937	ev_timer_init (timer, callback, 0., 5.);	1048	ev_timer_init (timer, callback, 0., 5.);
938	ev_timer_again (loop, timer);	1049	ev_timer_again (loop, timer);
939	...	1050	...
940	timer->again = 17.;	1051	timer->again = 17.;
941	ev_timer_again (loop, timer);	1052	ev_timer_again (loop, timer);
942	...	1053	...
943	timer->again = 10.;	1054	timer->again = 10.;
944	ev_timer_again (loop, timer);	1055	ev_timer_again (loop, timer);
945		1056
946	This is more efficient then stopping/starting the timer eahc time you want	1057	This is more slightly efficient then stopping/starting the timer each time
947	to modify its timeout value.	1058	you want to modify its timeout value.
948		1059
949	=item ev_tstamp repeat [read-write]	1060	=item ev_tstamp repeat [read-write]
950		1061
951	The current C<repeat> value. Will be used each time the watcher times out	1062	The current C<repeat> value. Will be used each time the watcher times out
952	or C<ev_timer_again> is called and determines the next timeout (if any),	1063	or C<ev_timer_again> is called and determines the next timeout (if any),
…		…
994	but on wallclock time (absolute time). You can tell a periodic watcher	1105	but on wallclock time (absolute time). You can tell a periodic watcher
995	to trigger "at" some specific point in time. For example, if you tell a	1106	to trigger "at" some specific point in time. For example, if you tell a
996	periodic watcher to trigger in 10 seconds (by specifiying e.g. C<ev_now ()	1107	periodic watcher to trigger in 10 seconds (by specifiying e.g. C<ev_now ()
997	+ 10.>) and then reset your system clock to the last year, then it will	1108	+ 10.>) and then reset your system clock to the last year, then it will
998	take a year to trigger the event (unlike an C<ev_timer>, which would trigger	1109	take a year to trigger the event (unlike an C<ev_timer>, which would trigger
999	roughly 10 seconds later and of course not if you reset your system time	1110	roughly 10 seconds later).
1000	again).
1001		1111
1002	They can also be used to implement vastly more complex timers, such as	1112	They can also be used to implement vastly more complex timers, such as
1003	triggering an event on eahc midnight, local time.	1113	triggering an event on each midnight, local time or other, complicated,
		1114	rules.
1004		1115
1005	As with timers, the callback is guarenteed to be invoked only when the	1116	As with timers, the callback is guarenteed to be invoked only when the
1006	time (C<at>) has been passed, but if multiple periodic timers become ready	1117	time (C<at>) has been passed, but if multiple periodic timers become ready
1007	during the same loop iteration then order of execution is undefined.	1118	during the same loop iteration then order of execution is undefined.
1008		1119
		1120	=head3 Watcher-Specific Functions and Data Members
		1121
1009	=over 4	1122	=over 4
1010		1123
1011	=item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)	1124	=item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)
1012		1125
1013	=item ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)	1126	=item ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)
…		…
1015	Lots of arguments, lets sort it out... There are basically three modes of	1128	Lots of arguments, lets sort it out... There are basically three modes of
1016	operation, and we will explain them from simplest to complex:	1129	operation, and we will explain them from simplest to complex:
1017		1130
1018	=over 4	1131	=over 4
1019		1132
1020	=item * absolute timer (interval = reschedule_cb = 0)	1133	=item * absolute timer (at = time, interval = reschedule_cb = 0)
1021		1134
1022	In this configuration the watcher triggers an event at the wallclock time	1135	In this configuration the watcher triggers an event at the wallclock time
1023	C<at> and doesn't repeat. It will not adjust when a time jump occurs,	1136	C<at> and doesn't repeat. It will not adjust when a time jump occurs,
1024	that is, if it is to be run at January 1st 2011 then it will run when the	1137	that is, if it is to be run at January 1st 2011 then it will run when the
1025	system time reaches or surpasses this time.	1138	system time reaches or surpasses this time.
1026		1139
1027	=item * non-repeating interval timer (interval > 0, reschedule_cb = 0)	1140	=item * non-repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)
1028		1141
1029	In this mode the watcher will always be scheduled to time out at the next	1142	In this mode the watcher will always be scheduled to time out at the next
1030	C<at + N * interval> time (for some integer N) and then repeat, regardless	1143	C<at + N * interval> time (for some integer N, which can also be negative)
1031	of any time jumps.	1144	and then repeat, regardless of any time jumps.
1032		1145
1033	This can be used to create timers that do not drift with respect to system	1146	This can be used to create timers that do not drift with respect to system
1034	time:	1147	time:
1035		1148
1036	ev_periodic_set (&periodic, 0., 3600., 0);	1149	ev_periodic_set (&periodic, 0., 3600., 0);
…		…
1042		1155
1043	Another way to think about it (for the mathematically inclined) is that	1156	Another way to think about it (for the mathematically inclined) is that
1044	C<ev_periodic> will try to run the callback in this mode at the next possible	1157	C<ev_periodic> will try to run the callback in this mode at the next possible
1045	time where C<time = at (mod interval)>, regardless of any time jumps.	1158	time where C<time = at (mod interval)>, regardless of any time jumps.
1046		1159
		1160	For numerical stability it is preferable that the C<at> value is near
		1161	C<ev_now ()> (the current time), but there is no range requirement for
		1162	this value.
		1163
1047	=item * manual reschedule mode (reschedule_cb = callback)	1164	=item * manual reschedule mode (at and interval ignored, reschedule_cb = callback)
1048		1165
1049	In this mode the values for C<interval> and C<at> are both being	1166	In this mode the values for C<interval> and C<at> are both being
1050	ignored. Instead, each time the periodic watcher gets scheduled, the	1167	ignored. Instead, each time the periodic watcher gets scheduled, the
1051	reschedule callback will be called with the watcher as first, and the	1168	reschedule callback will be called with the watcher as first, and the
1052	current time as second argument.	1169	current time as second argument.
1053		1170
1054	NOTE: I<This callback MUST NOT stop or destroy any periodic watcher,	1171	NOTE: I<This callback MUST NOT stop or destroy any periodic watcher,
1055	ever, or make any event loop modifications>. If you need to stop it,	1172	ever, or make any event loop modifications>. If you need to stop it,
1056	return C<now + 1e30> (or so, fudge fudge) and stop it afterwards (e.g. by	1173	return C<now + 1e30> (or so, fudge fudge) and stop it afterwards (e.g. by
1057	starting a prepare watcher).	1174	starting an C<ev_prepare> watcher, which is legal).
1058		1175
1059	Its prototype is C<ev_tstamp (reschedule_cb)(struct ev_periodic w,	1176	Its prototype is C<ev_tstamp (reschedule_cb)(struct ev_periodic w,
1060	ev_tstamp now)>, e.g.:	1177	ev_tstamp now)>, e.g.:
1061		1178
1062	static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)	1179	static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)
…		…
1085	Simply stops and restarts the periodic watcher again. This is only useful	1202	Simply stops and restarts the periodic watcher again. This is only useful
1086	when you changed some parameters or the reschedule callback would return	1203	when you changed some parameters or the reschedule callback would return
1087	a different time than the last time it was called (e.g. in a crond like	1204	a different time than the last time it was called (e.g. in a crond like
1088	program when the crontabs have changed).	1205	program when the crontabs have changed).
1089		1206
		1207	=item ev_tstamp offset [read-write]
		1208
		1209	When repeating, this contains the offset value, otherwise this is the
		1210	absolute point in time (the C<at> value passed to C<ev_periodic_set>).
		1211
		1212	Can be modified any time, but changes only take effect when the periodic
		1213	timer fires or C<ev_periodic_again> is being called.
		1214
1090	=item ev_tstamp interval [read-write]	1215	=item ev_tstamp interval [read-write]
1091		1216
1092	The current interval value. Can be modified any time, but changes only	1217	The current interval value. Can be modified any time, but changes only
1093	take effect when the periodic timer fires or C<ev_periodic_again> is being	1218	take effect when the periodic timer fires or C<ev_periodic_again> is being
1094	called.	1219	called.
…		…
1096	=item ev_tstamp (reschedule_cb)(struct ev_periodic w, ev_tstamp now) [read-write]	1221	=item ev_tstamp (reschedule_cb)(struct ev_periodic w, ev_tstamp now) [read-write]
1097		1222
1098	The current reschedule callback, or C<0>, if this functionality is	1223	The current reschedule callback, or C<0>, if this functionality is
1099	switched off. Can be changed any time, but changes only take effect when	1224	switched off. Can be changed any time, but changes only take effect when
1100	the periodic timer fires or C<ev_periodic_again> is being called.	1225	the periodic timer fires or C<ev_periodic_again> is being called.
		1226
		1227	=item ev_tstamp at [read-only]
		1228
		1229	When active, contains the absolute time that the watcher is supposed to
		1230	trigger next.
1101		1231
1102	=back	1232	=back
1103		1233
1104	Example: Call a callback every hour, or, more precisely, whenever the	1234	Example: Call a callback every hour, or, more precisely, whenever the
1105	system clock is divisible by 3600. The callback invocation times have	1235	system clock is divisible by 3600. The callback invocation times have
…		…
1147	with the kernel (thus it coexists with your own signal handlers as long	1277	with the kernel (thus it coexists with your own signal handlers as long
1148	as you don't register any with libev). Similarly, when the last signal	1278	as you don't register any with libev). Similarly, when the last signal
1149	watcher for a signal is stopped libev will reset the signal handler to	1279	watcher for a signal is stopped libev will reset the signal handler to
1150	SIG_DFL (regardless of what it was set to before).	1280	SIG_DFL (regardless of what it was set to before).
1151		1281
		1282	=head3 Watcher-Specific Functions and Data Members
		1283
1152	=over 4	1284	=over 4
1153		1285
1154	=item ev_signal_init (ev_signal *, callback, int signum)	1286	=item ev_signal_init (ev_signal *, callback, int signum)
1155		1287
1156	=item ev_signal_set (ev_signal *, int signum)	1288	=item ev_signal_set (ev_signal *, int signum)
…		…
1167		1299
1168	=head2 C<ev_child> - watch out for process status changes	1300	=head2 C<ev_child> - watch out for process status changes
1169		1301
1170	Child watchers trigger when your process receives a SIGCHLD in response to	1302	Child watchers trigger when your process receives a SIGCHLD in response to
1171	some child status changes (most typically when a child of yours dies).	1303	some child status changes (most typically when a child of yours dies).
		1304
		1305	=head3 Watcher-Specific Functions and Data Members
1172		1306
1173	=over 4	1307	=over 4
1174		1308
1175	=item ev_child_init (ev_child *, callback, int pid)	1309	=item ev_child_init (ev_child *, callback, int pid)
1176		1310
…		…
1220	The path does not need to exist: changing from "path exists" to "path does	1354	The path does not need to exist: changing from "path exists" to "path does
1221	not exist" is a status change like any other. The condition "path does	1355	not exist" is a status change like any other. The condition "path does
1222	not exist" is signified by the C<st_nlink> field being zero (which is	1356	not exist" is signified by the C<st_nlink> field being zero (which is
1223	otherwise always forced to be at least one) and all the other fields of	1357	otherwise always forced to be at least one) and all the other fields of
1224	the stat buffer having unspecified contents.	1358	the stat buffer having unspecified contents.
		1359
		1360	The path I<should> be absolute and I<must not> end in a slash. If it is
		1361	relative and your working directory changes, the behaviour is undefined.
1225		1362
1226	Since there is no standard to do this, the portable implementation simply	1363	Since there is no standard to do this, the portable implementation simply
1227	calls C<stat (2)> regularly on the path to see if it changed somehow. You	1364	calls C<stat (2)> regularly on the path to see if it changed somehow. You
1228	can specify a recommended polling interval for this case. If you specify	1365	can specify a recommended polling interval for this case. If you specify
1229	a polling interval of C<0> (highly recommended!) then a I<suitable,	1366	a polling interval of C<0> (highly recommended!) then a I<suitable,
…		…
1241	reader). Inotify will be used to give hints only and should not change the	1378	reader). Inotify will be used to give hints only and should not change the
1242	semantics of C<ev_stat> watchers, which means that libev sometimes needs	1379	semantics of C<ev_stat> watchers, which means that libev sometimes needs
1243	to fall back to regular polling again even with inotify, but changes are	1380	to fall back to regular polling again even with inotify, but changes are
1244	usually detected immediately, and if the file exists there will be no	1381	usually detected immediately, and if the file exists there will be no
1245	polling.	1382	polling.
		1383
		1384	=head3 Watcher-Specific Functions and Data Members
1246		1385
1247	=over 4	1386	=over 4
1248		1387
1249	=item ev_stat_init (ev_stat , callback, const char path, ev_tstamp interval)	1388	=item ev_stat_init (ev_stat , callback, const char path, ev_tstamp interval)
1250		1389
…		…
1314	ev_stat_start (loop, &passwd);	1453	ev_stat_start (loop, &passwd);
1315		1454
1316		1455
1317	=head2 C<ev_idle> - when you've got nothing better to do...	1456	=head2 C<ev_idle> - when you've got nothing better to do...
1318		1457
1319	Idle watchers trigger events when there are no other events are pending	1458	Idle watchers trigger events when no other events of the same or higher
1320	(prepare, check and other idle watchers do not count). That is, as long	1459	priority are pending (prepare, check and other idle watchers do not
1321	as your process is busy handling sockets or timeouts (or even signals,	1460	count).
1322	imagine) it will not be triggered. But when your process is idle all idle	1461
1323	watchers are being called again and again, once per event loop iteration -	1462	That is, as long as your process is busy handling sockets or timeouts
		1463	(or even signals, imagine) of the same or higher priority it will not be
		1464	triggered. But when your process is idle (or only lower-priority watchers
		1465	are pending), the idle watchers are being called once per event loop
1324	until stopped, that is, or your process receives more events and becomes	1466	iteration - until stopped, that is, or your process receives more events
1325	busy.	1467	and becomes busy again with higher priority stuff.
1326		1468
1327	The most noteworthy effect is that as long as any idle watchers are	1469	The most noteworthy effect is that as long as any idle watchers are
1328	active, the process will not block when waiting for new events.	1470	active, the process will not block when waiting for new events.
1329		1471
1330	Apart from keeping your process non-blocking (which is a useful	1472	Apart from keeping your process non-blocking (which is a useful
1331	effect on its own sometimes), idle watchers are a good place to do	1473	effect on its own sometimes), idle watchers are a good place to do
1332	"pseudo-background processing", or delay processing stuff to after the	1474	"pseudo-background processing", or delay processing stuff to after the
1333	event loop has handled all outstanding events.	1475	event loop has handled all outstanding events.
		1476
		1477	=head3 Watcher-Specific Functions and Data Members
1334		1478
1335	=over 4	1479	=over 4
1336		1480
1337	=item ev_idle_init (ev_signal *, callback)	1481	=item ev_idle_init (ev_signal *, callback)
1338		1482
…		…
1396	with priority higher than or equal to the event loop and one coroutine	1540	with priority higher than or equal to the event loop and one coroutine
1397	of lower priority, but only once, using idle watchers to keep the event	1541	of lower priority, but only once, using idle watchers to keep the event
1398	loop from blocking if lower-priority coroutines are active, thus mapping	1542	loop from blocking if lower-priority coroutines are active, thus mapping
1399	low-priority coroutines to idle/background tasks).	1543	low-priority coroutines to idle/background tasks).
1400		1544
		1545	It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>)
		1546	priority, to ensure that they are being run before any other watchers
		1547	after the poll. Also, C<ev_check> watchers (and C<ev_prepare> watchers,
		1548	too) should not activate ("feed") events into libev. While libev fully
		1549	supports this, they will be called before other C<ev_check> watchers did
		1550	their job. As C<ev_check> watchers are often used to embed other event
		1551	loops those other event loops might be in an unusable state until their
		1552	C<ev_check> watcher ran (always remind yourself to coexist peacefully with
		1553	others).
		1554
		1555	=head3 Watcher-Specific Functions and Data Members
		1556
1401	=over 4	1557	=over 4
1402		1558
1403	=item ev_prepare_init (ev_prepare *, callback)	1559	=item ev_prepare_init (ev_prepare *, callback)
1404		1560
1405	=item ev_check_init (ev_check *, callback)	1561	=item ev_check_init (ev_check *, callback)
…		…
1408	parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>	1564	parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>
1409	macros, but using them is utterly, utterly and completely pointless.	1565	macros, but using them is utterly, utterly and completely pointless.
1410		1566
1411	=back	1567	=back
1412		1568
1413	Example: To include a library such as adns, you would add IO watchers	1569	There are a number of principal ways to embed other event loops or modules
1414	and a timeout watcher in a prepare handler, as required by libadns, and	1570	into libev. Here are some ideas on how to include libadns into libev
		1571	(there is a Perl module named C<EV::ADNS> that does this, which you could
		1572	use for an actually working example. Another Perl module named C<EV::Glib>
		1573	embeds a Glib main context into libev, and finally, C<Glib::EV> embeds EV
		1574	into the Glib event loop).
		1575
		1576	Method 1: Add IO watchers and a timeout watcher in a prepare handler,
1415	in a check watcher, destroy them and call into libadns. What follows is	1577	and in a check watcher, destroy them and call into libadns. What follows
1416	pseudo-code only of course:	1578	is pseudo-code only of course. This requires you to either use a low
		1579	priority for the check watcher or use C<ev_clear_pending> explicitly, as
		1580	the callbacks for the IO/timeout watchers might not have been called yet.
1417		1581
1418	static ev_io iow [nfd];	1582	static ev_io iow [nfd];
1419	static ev_timer tw;	1583	static ev_timer tw;
1420		1584
1421	static void	1585	static void
1422	io_cb (ev_loop loop, ev_io w, int revents)	1586	io_cb (ev_loop loop, ev_io w, int revents)
1423	{	1587	{
1424	// set the relevant poll flags
1425	// could also call adns_processreadable etc. here
1426	struct pollfd fd = (struct pollfd )w->data;
1427	if (revents & EV_READ ) fd->revents \|= fd->events & POLLIN;
1428	if (revents & EV_WRITE) fd->revents \|= fd->events & POLLOUT;
1429	}	1588	}
1430		1589
1431	// create io watchers for each fd and a timer before blocking	1590	// create io watchers for each fd and a timer before blocking
1432	static void	1591	static void
1433	adns_prepare_cb (ev_loop loop, ev_prepare w, int revents)	1592	adns_prepare_cb (ev_loop loop, ev_prepare w, int revents)
1434	{	1593	{
1435	int timeout = 3600000;truct pollfd fds [nfd];	1594	int timeout = 3600000;
		1595	struct pollfd fds [nfd];
1436	// actual code will need to loop here and realloc etc.	1596	// actual code will need to loop here and realloc etc.
1437	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));	1597	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
1438		1598
1439	/* the callback is illegal, but won't be called as we stop during check */	1599	/* the callback is illegal, but won't be called as we stop during check */
1440	ev_timer_init (&tw, 0, timeout * 1e-3);	1600	ev_timer_init (&tw, 0, timeout * 1e-3);
1441	ev_timer_start (loop, &tw);	1601	ev_timer_start (loop, &tw);
1442		1602
1443	// create on ev_io per pollfd	1603	// create one ev_io per pollfd
1444	for (int i = 0; i < nfd; ++i)	1604	for (int i = 0; i < nfd; ++i)
1445	{	1605	{
1446	ev_io_init (iow + i, io_cb, fds [i].fd,	1606	ev_io_init (iow + i, io_cb, fds [i].fd,
1447	((fds [i].events & POLLIN ? EV_READ : 0)	1607	((fds [i].events & POLLIN ? EV_READ : 0)
1448	\| (fds [i].events & POLLOUT ? EV_WRITE : 0)));	1608	\| (fds [i].events & POLLOUT ? EV_WRITE : 0)));
1449		1609
1450	fds [i].revents = 0;	1610	fds [i].revents = 0;
1451	iow [i].data = fds + i;
1452	ev_io_start (loop, iow + i);	1611	ev_io_start (loop, iow + i);
1453	}	1612	}
1454	}	1613	}
1455		1614
1456	// stop all watchers after blocking	1615	// stop all watchers after blocking
…		…
1458	adns_check_cb (ev_loop loop, ev_check w, int revents)	1617	adns_check_cb (ev_loop loop, ev_check w, int revents)
1459	{	1618	{
1460	ev_timer_stop (loop, &tw);	1619	ev_timer_stop (loop, &tw);
1461		1620
1462	for (int i = 0; i < nfd; ++i)	1621	for (int i = 0; i < nfd; ++i)
		1622	{
		1623	// set the relevant poll flags
		1624	// could also call adns_processreadable etc. here
		1625	struct pollfd *fd = fds + i;
		1626	int revents = ev_clear_pending (iow + i);
		1627	if (revents & EV_READ ) fd->revents \|= fd->events & POLLIN;
		1628	if (revents & EV_WRITE) fd->revents \|= fd->events & POLLOUT;
		1629
		1630	// now stop the watcher
1463	ev_io_stop (loop, iow + i);	1631	ev_io_stop (loop, iow + i);
		1632	}
1464		1633
1465	adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));	1634	adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));
		1635	}
		1636
		1637	Method 2: This would be just like method 1, but you run C<adns_afterpoll>
		1638	in the prepare watcher and would dispose of the check watcher.
		1639
		1640	Method 3: If the module to be embedded supports explicit event
		1641	notification (adns does), you can also make use of the actual watcher
		1642	callbacks, and only destroy/create the watchers in the prepare watcher.
		1643
		1644	static void
		1645	timer_cb (EV_P_ ev_timer *w, int revents)
		1646	{
		1647	adns_state ads = (adns_state)w->data;
		1648	update_now (EV_A);
		1649
		1650	adns_processtimeouts (ads, &tv_now);
		1651	}
		1652
		1653	static void
		1654	io_cb (EV_P_ ev_io *w, int revents)
		1655	{
		1656	adns_state ads = (adns_state)w->data;
		1657	update_now (EV_A);
		1658
		1659	if (revents & EV_READ ) adns_processreadable (ads, w->fd, &tv_now);
		1660	if (revents & EV_WRITE) adns_processwriteable (ads, w->fd, &tv_now);
		1661	}
		1662
		1663	// do not ever call adns_afterpoll
		1664
		1665	Method 4: Do not use a prepare or check watcher because the module you
		1666	want to embed is too inflexible to support it. Instead, youc na override
		1667	their poll function. The drawback with this solution is that the main
		1668	loop is now no longer controllable by EV. The C<Glib::EV> module does
		1669	this.
		1670
		1671	static gint
		1672	event_poll_func (GPollFD *fds, guint nfds, gint timeout)
		1673	{
		1674	int got_events = 0;
		1675
		1676	for (n = 0; n < nfds; ++n)
		1677	// create/start io watcher that sets the relevant bits in fds[n] and increment got_events
		1678
		1679	if (timeout >= 0)
		1680	// create/start timer
		1681
		1682	// poll
		1683	ev_loop (EV_A_ 0);
		1684
		1685	// stop timer again
		1686	if (timeout >= 0)
		1687	ev_timer_stop (EV_A_ &to);
		1688
		1689	// stop io watchers again - their callbacks should have set
		1690	for (n = 0; n < nfds; ++n)
		1691	ev_io_stop (EV_A_ iow [n]);
		1692
		1693	return got_events;
1466	}	1694	}
1467		1695
1468		1696
1469	=head2 C<ev_embed> - when one backend isn't enough...	1697	=head2 C<ev_embed> - when one backend isn't enough...
1470		1698
…		…
1534	ev_embed_start (loop_hi, &embed);	1762	ev_embed_start (loop_hi, &embed);
1535	}	1763	}
1536	else	1764	else
1537	loop_lo = loop_hi;	1765	loop_lo = loop_hi;
1538		1766
		1767	=head3 Watcher-Specific Functions and Data Members
		1768
1539	=over 4	1769	=over 4
1540		1770
1541	=item ev_embed_init (ev_embed , callback, struct ev_loop embedded_loop)	1771	=item ev_embed_init (ev_embed , callback, struct ev_loop embedded_loop)
1542		1772
1543	=item ev_embed_set (ev_embed , callback, struct ev_loop embedded_loop)	1773	=item ev_embed_set (ev_embed , callback, struct ev_loop embedded_loop)
…		…
1569	event loop blocks next and before C<ev_check> watchers are being called,	1799	event loop blocks next and before C<ev_check> watchers are being called,
1570	and only in the child after the fork. If whoever good citizen calling	1800	and only in the child after the fork. If whoever good citizen calling
1571	C<ev_default_fork> cheats and calls it in the wrong process, the fork	1801	C<ev_default_fork> cheats and calls it in the wrong process, the fork
1572	handlers will be invoked, too, of course.	1802	handlers will be invoked, too, of course.
1573		1803
		1804	=head3 Watcher-Specific Functions and Data Members
		1805
1574	=over 4	1806	=over 4
1575		1807
1576	=item ev_fork_init (ev_signal *, callback)	1808	=item ev_fork_init (ev_signal *, callback)
1577		1809
1578	Initialises and configures the fork watcher - it has no parameters of any	1810	Initialises and configures the fork watcher - it has no parameters of any
…		…
1674		1906
1675	To use it,	1907	To use it,
1676		1908
1677	#include <ev++.h>	1909	#include <ev++.h>
1678		1910
1679	(it is not installed by default). This automatically includes F<ev.h>	1911	This automatically includes F<ev.h> and puts all of its definitions (many
1680	and puts all of its definitions (many of them macros) into the global	1912	of them macros) into the global namespace. All C++ specific things are
1681	namespace. All C++ specific things are put into the C<ev> namespace.	1913	put into the C<ev> namespace. It should support all the same embedding
		1914	options as F<ev.h>, most notably C<EV_MULTIPLICITY>.
1682		1915
1683	It should support all the same embedding options as F<ev.h>, most notably	1916	Care has been taken to keep the overhead low. The only data member the C++
1684	C<EV_MULTIPLICITY>.	1917	classes add (compared to plain C-style watchers) is the event loop pointer
		1918	that the watcher is associated with (or no additional members at all if
		1919	you disable C<EV_MULTIPLICITY> when embedding libev).
		1920
		1921	Currently, functions, and static and non-static member functions can be
		1922	used as callbacks. Other types should be easy to add as long as they only
		1923	need one additional pointer for context. If you need support for other
		1924	types of functors please contact the author (preferably after implementing
		1925	it).
1685		1926
1686	Here is a list of things available in the C<ev> namespace:	1927	Here is a list of things available in the C<ev> namespace:
1687		1928
1688	=over 4	1929	=over 4
1689		1930
…		…
1705		1946
1706	All of those classes have these methods:	1947	All of those classes have these methods:
1707		1948
1708	=over 4	1949	=over 4
1709		1950
1710	=item ev::TYPE::TYPE (object , object::method )	1951	=item ev::TYPE::TYPE ()
1711		1952
1712	=item ev::TYPE::TYPE (object , object::method , struct ev_loop *)	1953	=item ev::TYPE::TYPE (struct ev_loop *)
1713		1954
1714	=item ev::TYPE::~TYPE	1955	=item ev::TYPE::~TYPE
1715		1956
1716	The constructor takes a pointer to an object and a method pointer to	1957	The constructor (optionally) takes an event loop to associate the watcher
1717	the event handler callback to call in this class. The constructor calls	1958	with. If it is omitted, it will use C<EV_DEFAULT>.
1718	C<ev_init> for you, which means you have to call the C<set> method	1959
1719	before starting it. If you do not specify a loop then the constructor	1960	The constructor calls C<ev_init> for you, which means you have to call the
1720	automatically associates the default loop with this watcher.	1961	C<set> method before starting it.
		1962
		1963	It will not set a callback, however: You have to call the templated C<set>
		1964	method to set a callback before you can start the watcher.
		1965
		1966	(The reason why you have to use a method is a limitation in C++ which does
		1967	not allow explicit template arguments for constructors).
1721		1968
1722	The destructor automatically stops the watcher if it is active.	1969	The destructor automatically stops the watcher if it is active.
		1970
		1971	=item w->set<class, &class::method> (object *)
		1972
		1973	This method sets the callback method to call. The method has to have a
		1974	signature of C<void (*)(ev_TYPE &, int)>, it receives the watcher as
		1975	first argument and the C<revents> as second. The object must be given as
		1976	parameter and is stored in the C<data> member of the watcher.
		1977
		1978	This method synthesizes efficient thunking code to call your method from
		1979	the C callback that libev requires. If your compiler can inline your
		1980	callback (i.e. it is visible to it at the place of the C<set> call and
		1981	your compiler is good :), then the method will be fully inlined into the
		1982	thunking function, making it as fast as a direct C callback.
		1983
		1984	Example: simple class declaration and watcher initialisation
		1985
		1986	struct myclass
		1987	{
		1988	void io_cb (ev::io &w, int revents) { }
		1989	}
		1990
		1991	myclass obj;
		1992	ev::io iow;
		1993	iow.set <myclass, &myclass::io_cb> (&obj);
		1994
		1995	=item w->set<function> (void *data = 0)
		1996
		1997	Also sets a callback, but uses a static method or plain function as
		1998	callback. The optional C<data> argument will be stored in the watcher's
		1999	C<data> member and is free for you to use.
		2000
		2001	The prototype of the C<function> must be C<void (*)(ev::TYPE &w, int)>.
		2002
		2003	See the method-C<set> above for more details.
		2004
		2005	Example:
		2006
		2007	static void io_cb (ev::io &w, int revents) { }
		2008	iow.set <io_cb> ();
1723		2009
1724	=item w->set (struct ev_loop *)	2010	=item w->set (struct ev_loop *)
1725		2011
1726	Associates a different C<struct ev_loop> with this watcher. You can only	2012	Associates a different C<struct ev_loop> with this watcher. You can only
1727	do this when the watcher is inactive (and not pending either).	2013	do this when the watcher is inactive (and not pending either).
1728		2014
1729	=item w->set ([args])	2015	=item w->set ([args])
1730		2016
1731	Basically the same as C<ev_TYPE_set>, with the same args. Must be	2017	Basically the same as C<ev_TYPE_set>, with the same args. Must be
1732	called at least once. Unlike the C counterpart, an active watcher gets	2018	called at least once. Unlike the C counterpart, an active watcher gets
1733	automatically stopped and restarted.	2019	automatically stopped and restarted when reconfiguring it with this
		2020	method.
1734		2021
1735	=item w->start ()	2022	=item w->start ()
1736		2023
1737	Starts the watcher. Note that there is no C<loop> argument as the	2024	Starts the watcher. Note that there is no C<loop> argument, as the
1738	constructor already takes the loop.	2025	constructor already stores the event loop.
1739		2026
1740	=item w->stop ()	2027	=item w->stop ()
1741		2028
1742	Stops the watcher if it is active. Again, no C<loop> argument.	2029	Stops the watcher if it is active. Again, no C<loop> argument.
1743		2030
1744	=item w->again () C<ev::timer>, C<ev::periodic> only	2031	=item w->again () (C<ev::timer>, C<ev::periodic> only)
1745		2032
1746	For C<ev::timer> and C<ev::periodic>, this invokes the corresponding	2033	For C<ev::timer> and C<ev::periodic>, this invokes the corresponding
1747	C<ev_TYPE_again> function.	2034	C<ev_TYPE_again> function.
1748		2035
1749	=item w->sweep () C<ev::embed> only	2036	=item w->sweep () (C<ev::embed> only)
1750		2037
1751	Invokes C<ev_embed_sweep>.	2038	Invokes C<ev_embed_sweep>.
1752		2039
1753	=item w->update () C<ev::stat> only	2040	=item w->update () (C<ev::stat> only)
1754		2041
1755	Invokes C<ev_stat_stat>.	2042	Invokes C<ev_stat_stat>.
1756		2043
1757	=back	2044	=back
1758		2045
…		…
1768		2055
1769	myclass ();	2056	myclass ();
1770	}	2057	}
1771		2058
1772	myclass::myclass (int fd)	2059	myclass::myclass (int fd)
1773	: io (this, &myclass::io_cb),
1774	idle (this, &myclass::idle_cb)
1775	{	2060	{
		2061	io .set <myclass, &myclass::io_cb > (this);
		2062	idle.set <myclass, &myclass::idle_cb> (this);
		2063
1776	io.start (fd, ev::READ);	2064	io.start (fd, ev::READ);
1777	}	2065	}
1778		2066
1779		2067
1780	=head1 MACRO MAGIC	2068	=head1 MACRO MAGIC
1781		2069
1782	Libev can be compiled with a variety of options, the most fundemantal is	2070	Libev can be compiled with a variety of options, the most fundamantal
1783	C<EV_MULTIPLICITY>. This option determines wether (most) functions and	2071	of which is C<EV_MULTIPLICITY>. This option determines whether (most)
1784	callbacks have an initial C<struct ev_loop *> argument.	2072	functions and callbacks have an initial C<struct ev_loop *> argument.
1785		2073
1786	To make it easier to write programs that cope with either variant, the	2074	To make it easier to write programs that cope with either variant, the
1787	following macros are defined:	2075	following macros are defined:
1788		2076
1789	=over 4	2077	=over 4
…		…
1821	Similar to the other two macros, this gives you the value of the default	2109	Similar to the other two macros, this gives you the value of the default
1822	loop, if multiple loops are supported ("ev loop default").	2110	loop, if multiple loops are supported ("ev loop default").
1823		2111
1824	=back	2112	=back
1825		2113
1826	Example: Declare and initialise a check watcher, working regardless of	2114	Example: Declare and initialise a check watcher, utilising the above
1827	wether multiple loops are supported or not.	2115	macros so it will work regardless of whether multiple loops are supported
		2116	or not.
1828		2117
1829	static void	2118	static void
1830	check_cb (EV_P_ ev_timer *w, int revents)	2119	check_cb (EV_P_ ev_timer *w, int revents)
1831	{	2120	{
1832	ev_check_stop (EV_A_ w);	2121	ev_check_stop (EV_A_ w);
…		…
1834		2123
1835	ev_check check;	2124	ev_check check;
1836	ev_check_init (&check, check_cb);	2125	ev_check_init (&check, check_cb);
1837	ev_check_start (EV_DEFAULT_ &check);	2126	ev_check_start (EV_DEFAULT_ &check);
1838	ev_loop (EV_DEFAULT_ 0);	2127	ev_loop (EV_DEFAULT_ 0);
1839
1840		2128
1841	=head1 EMBEDDING	2129	=head1 EMBEDDING
1842		2130
1843	Libev can (and often is) directly embedded into host	2131	Libev can (and often is) directly embedded into host
1844	applications. Examples of applications that embed it include the Deliantra	2132	applications. Examples of applications that embed it include the Deliantra
…		…
1884	ev_vars.h	2172	ev_vars.h
1885	ev_wrap.h	2173	ev_wrap.h
1886		2174
1887	ev_win32.c required on win32 platforms only	2175	ev_win32.c required on win32 platforms only
1888		2176
1889	ev_select.c only when select backend is enabled (which is by default)	2177	ev_select.c only when select backend is enabled (which is enabled by default)
1890	ev_poll.c only when poll backend is enabled (disabled by default)	2178	ev_poll.c only when poll backend is enabled (disabled by default)
1891	ev_epoll.c only when the epoll backend is enabled (disabled by default)	2179	ev_epoll.c only when the epoll backend is enabled (disabled by default)
1892	ev_kqueue.c only when the kqueue backend is enabled (disabled by default)	2180	ev_kqueue.c only when the kqueue backend is enabled (disabled by default)
1893	ev_port.c only when the solaris port backend is enabled (disabled by default)	2181	ev_port.c only when the solaris port backend is enabled (disabled by default)
1894		2182
…		…
2057	will have the C<struct ev_loop *> as first argument, and you can create	2345	will have the C<struct ev_loop *> as first argument, and you can create
2058	additional independent event loops. Otherwise there will be no support	2346	additional independent event loops. Otherwise there will be no support
2059	for multiple event loops and there is no first event loop pointer	2347	for multiple event loops and there is no first event loop pointer
2060	argument. Instead, all functions act on the single default loop.	2348	argument. Instead, all functions act on the single default loop.
2061		2349
		2350	=item EV_MINPRI
		2351
		2352	=item EV_MAXPRI
		2353
		2354	The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to
		2355	C<EV_MAXPRI>, but otherwise there are no non-obvious limitations. You can
		2356	provide for more priorities by overriding those symbols (usually defined
		2357	to be C<-2> and C<2>, respectively).
		2358
		2359	When doing priority-based operations, libev usually has to linearly search
		2360	all the priorities, so having many of them (hundreds) uses a lot of space
		2361	and time, so using the defaults of five priorities (-2 .. +2) is usually
		2362	fine.
		2363
		2364	If your embedding app does not need any priorities, defining these both to
		2365	C<0> will save some memory and cpu.
		2366
2062	=item EV_PERIODIC_ENABLE	2367	=item EV_PERIODIC_ENABLE
2063		2368
2064	If undefined or defined to be C<1>, then periodic timers are supported. If	2369	If undefined or defined to be C<1>, then periodic timers are supported. If
		2370	defined to be C<0>, then they are not. Disabling them saves a few kB of
		2371	code.
		2372
		2373	=item EV_IDLE_ENABLE
		2374
		2375	If undefined or defined to be C<1>, then idle watchers are supported. If
2065	defined to be C<0>, then they are not. Disabling them saves a few kB of	2376	defined to be C<0>, then they are not. Disabling them saves a few kB of
2066	code.	2377	code.
2067		2378
2068	=item EV_EMBED_ENABLE	2379	=item EV_EMBED_ENABLE
2069		2380
…		…
2136	interface) and F<EV.xs> (implementation) files. Only the F<EV.xs> file	2447	interface) and F<EV.xs> (implementation) files. Only the F<EV.xs> file
2137	will be compiled. It is pretty complex because it provides its own header	2448	will be compiled. It is pretty complex because it provides its own header
2138	file.	2449	file.
2139		2450
2140	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file	2451	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file
2141	that everybody includes and which overrides some autoconf choices:	2452	that everybody includes and which overrides some configure choices:
2142		2453
		2454	#define EV_MINIMAL 1
2143	#define EV_USE_POLL 0	2455	#define EV_USE_POLL 0
2144	#define EV_MULTIPLICITY 0	2456	#define EV_MULTIPLICITY 0
2145	#define EV_PERIODICS 0	2457	#define EV_PERIODIC_ENABLE 0
		2458	#define EV_STAT_ENABLE 0
		2459	#define EV_FORK_ENABLE 0
2146	#define EV_CONFIG_H <config.h>	2460	#define EV_CONFIG_H <config.h>
		2461	#define EV_MINPRI 0
		2462	#define EV_MAXPRI 0
2147		2463
2148	#include "ev++.h"	2464	#include "ev++.h"
2149		2465
2150	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:	2466	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
2151		2467
…		…
2157		2473
2158	In this section the complexities of (many of) the algorithms used inside	2474	In this section the complexities of (many of) the algorithms used inside
2159	libev will be explained. For complexity discussions about backends see the	2475	libev will be explained. For complexity discussions about backends see the
2160	documentation for C<ev_default_init>.	2476	documentation for C<ev_default_init>.
2161		2477
		2478	All of the following are about amortised time: If an array needs to be
		2479	extended, libev needs to realloc and move the whole array, but this
		2480	happens asymptotically never with higher number of elements, so O(1) might
		2481	mean it might do a lengthy realloc operation in rare cases, but on average
		2482	it is much faster and asymptotically approaches constant time.
		2483
2162	=over 4	2484	=over 4
2163		2485
2164	=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers)	2486	=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers)
2165		2487
		2488	This means that, when you have a watcher that triggers in one hour and
		2489	there are 100 watchers that would trigger before that then inserting will
		2490	have to skip those 100 watchers.
		2491
2166	=item Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)	2492	=item Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)
2167		2493
		2494	That means that for changing a timer costs less than removing/adding them
		2495	as only the relative motion in the event queue has to be paid for.
		2496
2168	=item Starting io/check/prepare/idle/signal/child watchers: O(1)	2497	=item Starting io/check/prepare/idle/signal/child watchers: O(1)
2169		2498
		2499	These just add the watcher into an array or at the head of a list.
2170	=item Stopping check/prepare/idle watchers: O(1)	2500	=item Stopping check/prepare/idle watchers: O(1)
2171		2501
2172	=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))	2502	=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))
2173		2503
		2504	These watchers are stored in lists then need to be walked to find the
		2505	correct watcher to remove. The lists are usually short (you don't usually
		2506	have many watchers waiting for the same fd or signal).
		2507
2174	=item Finding the next timer per loop iteration: O(1)	2508	=item Finding the next timer per loop iteration: O(1)
2175		2509
2176	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)	2510	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)
2177		2511
		2512	A change means an I/O watcher gets started or stopped, which requires
		2513	libev to recalculate its status (and possibly tell the kernel).
		2514
2178	=item Activating one watcher: O(1)	2515	=item Activating one watcher: O(1)
2179		2516
		2517	=item Priority handling: O(number_of_priorities)
		2518
		2519	Priorities are implemented by allocating some space for each
		2520	priority. When doing priority-based operations, libev usually has to
		2521	linearly search all the priorities.
		2522
2180	=back	2523	=back
2181		2524
2182		2525
2183	=head1 AUTHOR	2526	=head1 AUTHOR
2184		2527

Diff Legend

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

Comparing libev/ev.pod (file contents): Revision 1.57 by root, Wed Nov 28 11:27:29 2007 UTC vs. Revision 1.86 by root, Tue Dec 18 01:20:33 2007 UTC

Diff Legend

Comparing libev/ev.pod (file contents):
Revision 1.57 by root, Wed Nov 28 11:27:29 2007 UTC vs.
Revision 1.86 by root, Tue Dec 18 01:20:33 2007 UTC