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

Comparing libev/ev.pod (file contents):
Revision 1.230 by root, Wed Apr 15 18:47:07 2009 UTC vs.
Revision 1.275 by root, Sat Dec 26 09:21:54 2009 UTC

…		…
62		62
63	// unloop was called, so exit	63	// unloop was called, so exit
64	return 0;	64	return 0;
65	}	65	}
66		66
67	=head1 DESCRIPTION	67	=head1 ABOUT THIS DOCUMENT
		68
		69	This document documents the libev software package.
68		70
69	The newest version of this document is also available as an html-formatted	71	The newest version of this document is also available as an html-formatted
70	web page you might find easier to navigate when reading it for the first	72	web page you might find easier to navigate when reading it for the first
71	time: L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod>.	73	time: L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod>.
		74
		75	While this document tries to be as complete as possible in documenting
		76	libev, its usage and the rationale behind its design, it is not a tutorial
		77	on event-based programming, nor will it introduce event-based programming
		78	with libev.
		79
		80	Familarity with event based programming techniques in general is assumed
		81	throughout this document.
		82
		83	=head1 ABOUT LIBEV
72		84
73	Libev is an event loop: you register interest in certain events (such as a	85	Libev is an event loop: you register interest in certain events (such as a
74	file descriptor being readable or a timeout occurring), and it will manage	86	file descriptor being readable or a timeout occurring), and it will manage
75	these event sources and provide your program with events.	87	these event sources and provide your program with events.
76		88
…		…
86	=head2 FEATURES	98	=head2 FEATURES
87		99
88	Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the	100	Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the
89	BSD-specific C<kqueue> and the Solaris-specific event port mechanisms	101	BSD-specific C<kqueue> and the Solaris-specific event port mechanisms
90	for file descriptor events (C<ev_io>), the Linux C<inotify> interface	102	for file descriptor events (C<ev_io>), the Linux C<inotify> interface
91	(for C<ev_stat>), relative timers (C<ev_timer>), absolute timers	103	(for C<ev_stat>), Linux eventfd/signalfd (for faster and cleaner
92	with customised rescheduling (C<ev_periodic>), synchronous signals	104	inter-thread wakeup (C<ev_async>)/signal handling (C<ev_signal>)) relative
93	(C<ev_signal>), process status change events (C<ev_child>), and event	105	timers (C<ev_timer>), absolute timers with customised rescheduling
94	watchers dealing with the event loop mechanism itself (C<ev_idle>,	106	(C<ev_periodic>), synchronous signals (C<ev_signal>), process status
95	C<ev_embed>, C<ev_prepare> and C<ev_check> watchers) as well as	107	change events (C<ev_child>), and event watchers dealing with the event
96	file watchers (C<ev_stat>) and even limited support for fork events	108	loop mechanism itself (C<ev_idle>, C<ev_embed>, C<ev_prepare> and
97	(C<ev_fork>).	109	C<ev_check> watchers) as well as file watchers (C<ev_stat>) and even
		110	limited support for fork events (C<ev_fork>).
98		111
99	It also is quite fast (see this	112	It also is quite fast (see this
100	L<benchmark\|http://libev.schmorp.de/bench.html> comparing it to libevent	113	L<benchmark\|http://libev.schmorp.de/bench.html> comparing it to libevent
101	for example).	114	for example).
102		115
…		…
105	Libev is very configurable. In this manual the default (and most common)	118	Libev is very configurable. In this manual the default (and most common)
106	configuration will be described, which supports multiple event loops. For	119	configuration will be described, which supports multiple event loops. For
107	more info about various configuration options please have a look at	120	more info about various configuration options please have a look at
108	B<EMBED> section in this manual. If libev was configured without support	121	B<EMBED> section in this manual. If libev was configured without support
109	for multiple event loops, then all functions taking an initial argument of	122	for multiple event loops, then all functions taking an initial argument of
110	name C<loop> (which is always of type C<ev_loop *>) will not have	123	name C<loop> (which is always of type C<struct ev_loop *>) will not have
111	this argument.	124	this argument.
112		125
113	=head2 TIME REPRESENTATION	126	=head2 TIME REPRESENTATION
114		127
115	Libev represents time as a single floating point number, representing the	128	Libev represents time as a single floating point number, representing
116	(fractional) number of seconds since the (POSIX) epoch (somewhere near	129	the (fractional) number of seconds since the (POSIX) epoch (somewhere
117	the beginning of 1970, details are complicated, don't ask). This type is	130	near the beginning of 1970, details are complicated, don't ask). This
118	called C<ev_tstamp>, which is what you should use too. It usually aliases	131	type is called C<ev_tstamp>, which is what you should use too. It usually
119	to the C<double> type in C, and when you need to do any calculations on	132	aliases to the C<double> type in C. When you need to do any calculations
120	it, you should treat it as some floating point value. Unlike the name	133	on it, you should treat it as some floating point value. Unlike the name
121	component C<stamp> might indicate, it is also used for time differences	134	component C<stamp> might indicate, it is also used for time differences
122	throughout libev.	135	throughout libev.
123		136
124	=head1 ERROR HANDLING	137	=head1 ERROR HANDLING
125		138
…		…
350	flag.	363	flag.
351		364
352	This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS>	365	This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS>
353	environment variable.	366	environment variable.
354		367
		368	=item C<EVFLAG_NOINOTIFY>
		369
		370	When this flag is specified, then libev will not attempt to use the
		371	I<inotify> API for it's C<ev_stat> watchers. Apart from debugging and
		372	testing, this flag can be useful to conserve inotify file descriptors, as
		373	otherwise each loop using C<ev_stat> watchers consumes one inotify handle.
		374
		375	=item C<EVFLAG_NOSIGFD>
		376
		377	When this flag is specified, then libev will not attempt to use the
		378	I<signalfd> API for it's C<ev_signal> (and C<ev_child>) watchers. This is
		379	probably only useful to work around any bugs in libev. Consequently, this
		380	flag might go away once the signalfd functionality is considered stable,
		381	so it's useful mostly in environment variables and not in program code.
		382
355	=item C<EVBACKEND_SELECT> (value 1, portable select backend)	383	=item C<EVBACKEND_SELECT> (value 1, portable select backend)
356		384
357	This is your standard select(2) backend. Not I<completely> standard, as	385	This is your standard select(2) backend. Not I<completely> standard, as
358	libev tries to roll its own fd_set with no limits on the number of fds,	386	libev tries to roll its own fd_set with no limits on the number of fds,
359	but if that fails, expect a fairly low limit on the number of fds when	387	but if that fails, expect a fairly low limit on the number of fds when
…		…
382		410
383	This backend maps C<EV_READ> to C<POLLIN \| POLLERR \| POLLHUP>, and	411	This backend maps C<EV_READ> to C<POLLIN \| POLLERR \| POLLHUP>, and
384	C<EV_WRITE> to C<POLLOUT \| POLLERR \| POLLHUP>.	412	C<EV_WRITE> to C<POLLOUT \| POLLERR \| POLLHUP>.
385		413
386	=item C<EVBACKEND_EPOLL> (value 4, Linux)	414	=item C<EVBACKEND_EPOLL> (value 4, Linux)
		415
		416	Use the linux-specific epoll(7) interface (for both pre- and post-2.6.9
		417	kernels).
387		418
388	For few fds, this backend is a bit little slower than poll and select,	419	For few fds, this backend is a bit little slower than poll and select,
389	but it scales phenomenally better. While poll and select usually scale	420	but it scales phenomenally better. While poll and select usually scale
390	like O(total_fds) where n is the total number of fds (or the highest fd),	421	like O(total_fds) where n is the total number of fds (or the highest fd),
391	epoll scales either O(1) or O(active_fds).	422	epoll scales either O(1) or O(active_fds).
…		…
506		537
507	It is definitely not recommended to use this flag.	538	It is definitely not recommended to use this flag.
508		539
509	=back	540	=back
510		541
511	If one or more of these are or'ed into the flags value, then only these	542	If one or more of the backend flags are or'ed into the flags value,
512	backends will be tried (in the reverse order as listed here). If none are	543	then only these backends will be tried (in the reverse order as listed
513	specified, all backends in C<ev_recommended_backends ()> will be tried.	544	here). If none are specified, all backends in C<ev_recommended_backends
		545	()> will be tried.
514		546
515	Example: This is the most typical usage.	547	Example: This is the most typical usage.
516		548
517	if (!ev_default_loop (0))	549	if (!ev_default_loop (0))
518	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");	550	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
…		…
561	as signal and child watchers) would need to be stopped manually.	593	as signal and child watchers) would need to be stopped manually.
562		594
563	In general it is not advisable to call this function except in the	595	In general it is not advisable to call this function except in the
564	rare occasion where you really need to free e.g. the signal handling	596	rare occasion where you really need to free e.g. the signal handling
565	pipe fds. If you need dynamically allocated loops it is better to use	597	pipe fds. If you need dynamically allocated loops it is better to use
566	C<ev_loop_new> and C<ev_loop_destroy>).	598	C<ev_loop_new> and C<ev_loop_destroy>.
567		599
568	=item ev_loop_destroy (loop)	600	=item ev_loop_destroy (loop)
569		601
570	Like C<ev_default_destroy>, but destroys an event loop created by an	602	Like C<ev_default_destroy>, but destroys an event loop created by an
571	earlier call to C<ev_loop_new>.	603	earlier call to C<ev_loop_new>.
…		…
609		641
610	This value can sometimes be useful as a generation counter of sorts (it	642	This value can sometimes be useful as a generation counter of sorts (it
611	"ticks" the number of loop iterations), as it roughly corresponds with	643	"ticks" the number of loop iterations), as it roughly corresponds with
612	C<ev_prepare> and C<ev_check> calls.	644	C<ev_prepare> and C<ev_check> calls.
613		645
		646	=item unsigned int ev_loop_depth (loop)
		647
		648	Returns the number of times C<ev_loop> was entered minus the number of
		649	times C<ev_loop> was exited, in other words, the recursion depth.
		650
		651	Outside C<ev_loop>, this number is zero. In a callback, this number is
		652	C<1>, unless C<ev_loop> was invoked recursively (or from another thread),
		653	in which case it is higher.
		654
		655	Leaving C<ev_loop> abnormally (setjmp/longjmp, cancelling the thread
		656	etc.), doesn't count as exit.
		657
614	=item unsigned int ev_backend (loop)	658	=item unsigned int ev_backend (loop)
615		659
616	Returns one of the C<EVBACKEND_*> flags indicating the event backend in	660	Returns one of the C<EVBACKEND_*> flags indicating the event backend in
617	use.	661	use.
618		662
…		…
632		676
633	This function is rarely useful, but when some event callback runs for a	677	This function is rarely useful, but when some event callback runs for a
634	very long time without entering the event loop, updating libev's idea of	678	very long time without entering the event loop, updating libev's idea of
635	the current time is a good idea.	679	the current time is a good idea.
636		680
637	See also "The special problem of time updates" in the C<ev_timer> section.	681	See also L<The special problem of time updates> in the C<ev_timer> section.
		682
		683	=item ev_suspend (loop)
		684
		685	=item ev_resume (loop)
		686
		687	These two functions suspend and resume a loop, for use when the loop is
		688	not used for a while and timeouts should not be processed.
		689
		690	A typical use case would be an interactive program such as a game: When
		691	the user presses C<^Z> to suspend the game and resumes it an hour later it
		692	would be best to handle timeouts as if no time had actually passed while
		693	the program was suspended. This can be achieved by calling C<ev_suspend>
		694	in your C<SIGTSTP> handler, sending yourself a C<SIGSTOP> and calling
		695	C<ev_resume> directly afterwards to resume timer processing.
		696
		697	Effectively, all C<ev_timer> watchers will be delayed by the time spend
		698	between C<ev_suspend> and C<ev_resume>, and all C<ev_periodic> watchers
		699	will be rescheduled (that is, they will lose any events that would have
		700	occured while suspended).
		701
		702	After calling C<ev_suspend> you B<must not> call I<any> function on the
		703	given loop other than C<ev_resume>, and you B<must not> call C<ev_resume>
		704	without a previous call to C<ev_suspend>.
		705
		706	Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the
		707	event loop time (see C<ev_now_update>).
638		708
639	=item ev_loop (loop, int flags)	709	=item ev_loop (loop, int flags)
640		710
641	Finally, this is it, the event handler. This function usually is called	711	Finally, this is it, the event handler. This function usually is called
642	after you initialised all your watchers and you want to start handling	712	after you have initialised all your watchers and you want to start
643	events.	713	handling events.
644		714
645	If the flags argument is specified as C<0>, it will not return until	715	If the flags argument is specified as C<0>, it will not return until
646	either no event watchers are active anymore or C<ev_unloop> was called.	716	either no event watchers are active anymore or C<ev_unloop> was called.
647		717
648	Please note that an explicit C<ev_unloop> is usually better than	718	Please note that an explicit C<ev_unloop> is usually better than
…		…
773		843
774	By setting a higher I<io collect interval> you allow libev to spend more	844	By setting a higher I<io collect interval> you allow libev to spend more
775	time collecting I/O events, so you can handle more events per iteration,	845	time collecting I/O events, so you can handle more events per iteration,
776	at the cost of increasing latency. Timeouts (both C<ev_periodic> and	846	at the cost of increasing latency. Timeouts (both C<ev_periodic> and
777	C<ev_timer>) will be not affected. Setting this to a non-null value will	847	C<ev_timer>) will be not affected. Setting this to a non-null value will
778	introduce an additional C<ev_sleep ()> call into most loop iterations.	848	introduce an additional C<ev_sleep ()> call into most loop iterations. The
		849	sleep time ensures that libev will not poll for I/O events more often then
		850	once per this interval, on average.
779		851
780	Likewise, by setting a higher I<timeout collect interval> you allow libev	852	Likewise, by setting a higher I<timeout collect interval> you allow libev
781	to spend more time collecting timeouts, at the expense of increased	853	to spend more time collecting timeouts, at the expense of increased
782	latency/jitter/inexactness (the watcher callback will be called	854	latency/jitter/inexactness (the watcher callback will be called
783	later). C<ev_io> watchers will not be affected. Setting this to a non-null	855	later). C<ev_io> watchers will not be affected. Setting this to a non-null
…		…
785		857
786	Many (busy) programs can usually benefit by setting the I/O collect	858	Many (busy) programs can usually benefit by setting the I/O collect
787	interval to a value near C<0.1> or so, which is often enough for	859	interval to a value near C<0.1> or so, which is often enough for
788	interactive servers (of course not for games), likewise for timeouts. It	860	interactive servers (of course not for games), likewise for timeouts. It
789	usually doesn't make much sense to set it to a lower value than C<0.01>,	861	usually doesn't make much sense to set it to a lower value than C<0.01>,
790	as this approaches the timing granularity of most systems.	862	as this approaches the timing granularity of most systems. Note that if
		863	you do transactions with the outside world and you can't increase the
		864	parallelity, then this setting will limit your transaction rate (if you
		865	need to poll once per transaction and the I/O collect interval is 0.01,
		866	then you can't do more than 100 transations per second).
791		867
792	Setting the I<timeout collect interval> can improve the opportunity for	868	Setting the I<timeout collect interval> can improve the opportunity for
793	saving power, as the program will "bundle" timer callback invocations that	869	saving power, as the program will "bundle" timer callback invocations that
794	are "near" in time together, by delaying some, thus reducing the number of	870	are "near" in time together, by delaying some, thus reducing the number of
795	times the process sleeps and wakes up again. Another useful technique to	871	times the process sleeps and wakes up again. Another useful technique to
796	reduce iterations/wake-ups is to use C<ev_periodic> watchers and make sure	872	reduce iterations/wake-ups is to use C<ev_periodic> watchers and make sure
797	they fire on, say, one-second boundaries only.	873	they fire on, say, one-second boundaries only.
		874
		875	Example: we only need 0.1s timeout granularity, and we wish not to poll
		876	more often than 100 times per second:
		877
		878	ev_set_timeout_collect_interval (EV_DEFAULT_UC_ 0.1);
		879	ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01);
		880
		881	=item ev_invoke_pending (loop)
		882
		883	This call will simply invoke all pending watchers while resetting their
		884	pending state. Normally, C<ev_loop> does this automatically when required,
		885	but when overriding the invoke callback this call comes handy.
		886
		887	=item int ev_pending_count (loop)
		888
		889	Returns the number of pending watchers - zero indicates that no watchers
		890	are pending.
		891
		892	=item ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P))
		893
		894	This overrides the invoke pending functionality of the loop: Instead of
		895	invoking all pending watchers when there are any, C<ev_loop> will call
		896	this callback instead. This is useful, for example, when you want to
		897	invoke the actual watchers inside another context (another thread etc.).
		898
		899	If you want to reset the callback, use C<ev_invoke_pending> as new
		900	callback.
		901
		902	=item ev_set_loop_release_cb (loop, void (release)(EV_P), void (acquire)(EV_P))
		903
		904	Sometimes you want to share the same loop between multiple threads. This
		905	can be done relatively simply by putting mutex_lock/unlock calls around
		906	each call to a libev function.
		907
		908	However, C<ev_loop> can run an indefinite time, so it is not feasible to
		909	wait for it to return. One way around this is to wake up the loop via
		910	C<ev_unloop> and C<av_async_send>, another way is to set these I<release>
		911	and I<acquire> callbacks on the loop.
		912
		913	When set, then C<release> will be called just before the thread is
		914	suspended waiting for new events, and C<acquire> is called just
		915	afterwards.
		916
		917	Ideally, C<release> will just call your mutex_unlock function, and
		918	C<acquire> will just call the mutex_lock function again.
		919
		920	While event loop modifications are allowed between invocations of
		921	C<release> and C<acquire> (that's their only purpose after all), no
		922	modifications done will affect the event loop, i.e. adding watchers will
		923	have no effect on the set of file descriptors being watched, or the time
		924	waited. Use an C<ev_async> watcher to wake up C<ev_loop> when you want it
		925	to take note of any changes you made.
		926
		927	In theory, threads executing C<ev_loop> will be async-cancel safe between
		928	invocations of C<release> and C<acquire>.
		929
		930	See also the locking example in the C<THREADS> section later in this
		931	document.
		932
		933	=item ev_set_userdata (loop, void *data)
		934
		935	=item ev_userdata (loop)
		936
		937	Set and retrieve a single C<void *> associated with a loop. When
		938	C<ev_set_userdata> has never been called, then C<ev_userdata> returns
		939	C<0.>
		940
		941	These two functions can be used to associate arbitrary data with a loop,
		942	and are intended solely for the C<invoke_pending_cb>, C<release> and
		943	C<acquire> callbacks described above, but of course can be (ab-)used for
		944	any other purpose as well.
798		945
799	=item ev_loop_verify (loop)	946	=item ev_loop_verify (loop)
800		947
801	This function only does something when C<EV_VERIFY> support has been	948	This function only does something when C<EV_VERIFY> support has been
802	compiled in, which is the default for non-minimal builds. It tries to go	949	compiled in, which is the default for non-minimal builds. It tries to go
…		…
979		1126
980	ev_io w;	1127	ev_io w;
981	ev_init (&w, my_cb);	1128	ev_init (&w, my_cb);
982	ev_io_set (&w, STDIN_FILENO, EV_READ);	1129	ev_io_set (&w, STDIN_FILENO, EV_READ);
983		1130
984	=item C<ev_TYPE_set> (ev_TYPE *, [args])	1131	=item C<ev_TYPE_set> (ev_TYPE *watcher, [args])
985		1132
986	This macro initialises the type-specific parts of a watcher. You need to	1133	This macro initialises the type-specific parts of a watcher. You need to
987	call C<ev_init> at least once before you call this macro, but you can	1134	call C<ev_init> at least once before you call this macro, but you can
988	call C<ev_TYPE_set> any number of times. You must not, however, call this	1135	call C<ev_TYPE_set> any number of times. You must not, however, call this
989	macro on a watcher that is active (it can be pending, however, which is a	1136	macro on a watcher that is active (it can be pending, however, which is a
…		…
1002		1149
1003	Example: Initialise and set an C<ev_io> watcher in one step.	1150	Example: Initialise and set an C<ev_io> watcher in one step.
1004		1151
1005	ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ);	1152	ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ);
1006		1153
1007	=item C<ev_TYPE_start> (loop , ev_TYPE watcher)	1154	=item C<ev_TYPE_start> (loop, ev_TYPE *watcher)
1008		1155
1009	Starts (activates) the given watcher. Only active watchers will receive	1156	Starts (activates) the given watcher. Only active watchers will receive
1010	events. If the watcher is already active nothing will happen.	1157	events. If the watcher is already active nothing will happen.
1011		1158
1012	Example: Start the C<ev_io> watcher that is being abused as example in this	1159	Example: Start the C<ev_io> watcher that is being abused as example in this
1013	whole section.	1160	whole section.
1014		1161
1015	ev_io_start (EV_DEFAULT_UC, &w);	1162	ev_io_start (EV_DEFAULT_UC, &w);
1016		1163
1017	=item C<ev_TYPE_stop> (loop , ev_TYPE watcher)	1164	=item C<ev_TYPE_stop> (loop, ev_TYPE *watcher)
1018		1165
1019	Stops the given watcher if active, and clears the pending status (whether	1166	Stops the given watcher if active, and clears the pending status (whether
1020	the watcher was active or not).	1167	the watcher was active or not).
1021		1168
1022	It is possible that stopped watchers are pending - for example,	1169	It is possible that stopped watchers are pending - for example,
…		…
1047	=item ev_cb_set (ev_TYPE *watcher, callback)	1194	=item ev_cb_set (ev_TYPE *watcher, callback)
1048		1195
1049	Change the callback. You can change the callback at virtually any time	1196	Change the callback. You can change the callback at virtually any time
1050	(modulo threads).	1197	(modulo threads).
1051		1198
1052	=item ev_set_priority (ev_TYPE *watcher, priority)	1199	=item ev_set_priority (ev_TYPE *watcher, int priority)
1053		1200
1054	=item int ev_priority (ev_TYPE *watcher)	1201	=item int ev_priority (ev_TYPE *watcher)
1055		1202
1056	Set and query the priority of the watcher. The priority is a small	1203	Set and query the priority of the watcher. The priority is a small
1057	integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>	1204	integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>
1058	(default: C<-2>). Pending watchers with higher priority will be invoked	1205	(default: C<-2>). Pending watchers with higher priority will be invoked
1059	before watchers with lower priority, but priority will not keep watchers	1206	before watchers with lower priority, but priority will not keep watchers
1060	from being executed (except for C<ev_idle> watchers).	1207	from being executed (except for C<ev_idle> watchers).
1061		1208
1062	This means that priorities are I<only> used for ordering callback
1063	invocation after new events have been received. This is useful, for
1064	example, to reduce latency after idling, or more often, to bind two
1065	watchers on the same event and make sure one is called first.
1066
1067	If you need to suppress invocation when higher priority events are pending	1209	If you need to suppress invocation when higher priority events are pending
1068	you need to look at C<ev_idle> watchers, which provide this functionality.	1210	you need to look at C<ev_idle> watchers, which provide this functionality.
1069		1211
1070	You I<must not> change the priority of a watcher as long as it is active or	1212	You I<must not> change the priority of a watcher as long as it is active or
1071	pending.	1213	pending.
1072
1073	The default priority used by watchers when no priority has been set is
1074	always C<0>, which is supposed to not be too high and not be too low :).
1075		1214
1076	Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is	1215	Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is
1077	fine, as long as you do not mind that the priority value you query might	1216	fine, as long as you do not mind that the priority value you query might
1078	or might not have been clamped to the valid range.	1217	or might not have been clamped to the valid range.
		1218
		1219	The default priority used by watchers when no priority has been set is
		1220	always C<0>, which is supposed to not be too high and not be too low :).
		1221
		1222	See L<WATCHER PRIORITY MODELS>, below, for a more thorough treatment of
		1223	priorities.
1079		1224
1080	=item ev_invoke (loop, ev_TYPE *watcher, int revents)	1225	=item ev_invoke (loop, ev_TYPE *watcher, int revents)
1081		1226
1082	Invoke the C<watcher> with the given C<loop> and C<revents>. Neither	1227	Invoke the C<watcher> with the given C<loop> and C<revents>. Neither
1083	C<loop> nor C<revents> need to be valid as long as the watcher callback	1228	C<loop> nor C<revents> need to be valid as long as the watcher callback
…		…
1090	returns its C<revents> bitset (as if its callback was invoked). If the	1235	returns its C<revents> bitset (as if its callback was invoked). If the
1091	watcher isn't pending it does nothing and returns C<0>.	1236	watcher isn't pending it does nothing and returns C<0>.
1092		1237
1093	Sometimes it can be useful to "poll" a watcher instead of waiting for its	1238	Sometimes it can be useful to "poll" a watcher instead of waiting for its
1094	callback to be invoked, which can be accomplished with this function.	1239	callback to be invoked, which can be accomplished with this function.
		1240
		1241	=item ev_feed_event (loop, ev_TYPE *watcher, int revents)
		1242
		1243	Feeds the given event set into the event loop, as if the specified event
		1244	had happened for the specified watcher (which must be a pointer to an
		1245	initialised but not necessarily started event watcher). Obviously you must
		1246	not free the watcher as long as it has pending events.
		1247
		1248	Stopping the watcher, letting libev invoke it, or calling
		1249	C<ev_clear_pending> will clear the pending event, even if the watcher was
		1250	not started in the first place.
		1251
		1252	See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related
		1253	functions that do not need a watcher.
1095		1254
1096	=back	1255	=back
1097		1256
1098		1257
1099	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER	1258	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
…		…
1148	#include <stddef.h>	1307	#include <stddef.h>
1149		1308
1150	static void	1309	static void
1151	t1_cb (EV_P_ ev_timer *w, int revents)	1310	t1_cb (EV_P_ ev_timer *w, int revents)
1152	{	1311	{
1153	struct my_biggy big = (struct my_biggy *	1312	struct my_biggy big = (struct my_biggy *)
1154	(((char *)w) - offsetof (struct my_biggy, t1));	1313	(((char *)w) - offsetof (struct my_biggy, t1));
1155	}	1314	}
1156		1315
1157	static void	1316	static void
1158	t2_cb (EV_P_ ev_timer *w, int revents)	1317	t2_cb (EV_P_ ev_timer *w, int revents)
1159	{	1318	{
1160	struct my_biggy big = (struct my_biggy *	1319	struct my_biggy big = (struct my_biggy *)
1161	(((char *)w) - offsetof (struct my_biggy, t2));	1320	(((char *)w) - offsetof (struct my_biggy, t2));
1162	}	1321	}
		1322
		1323	=head2 WATCHER PRIORITY MODELS
		1324
		1325	Many event loops support I<watcher priorities>, which are usually small
		1326	integers that influence the ordering of event callback invocation
		1327	between watchers in some way, all else being equal.
		1328
		1329	In libev, Watcher priorities can be set using C<ev_set_priority>. See its
		1330	description for the more technical details such as the actual priority
		1331	range.
		1332
		1333	There are two common ways how these these priorities are being interpreted
		1334	by event loops:
		1335
		1336	In the more common lock-out model, higher priorities "lock out" invocation
		1337	of lower priority watchers, which means as long as higher priority
		1338	watchers receive events, lower priority watchers are not being invoked.
		1339
		1340	The less common only-for-ordering model uses priorities solely to order
		1341	callback invocation within a single event loop iteration: Higher priority
		1342	watchers are invoked before lower priority ones, but they all get invoked
		1343	before polling for new events.
		1344
		1345	Libev uses the second (only-for-ordering) model for all its watchers
		1346	except for idle watchers (which use the lock-out model).
		1347
		1348	The rationale behind this is that implementing the lock-out model for
		1349	watchers is not well supported by most kernel interfaces, and most event
		1350	libraries will just poll for the same events again and again as long as
		1351	their callbacks have not been executed, which is very inefficient in the
		1352	common case of one high-priority watcher locking out a mass of lower
		1353	priority ones.
		1354
		1355	Static (ordering) priorities are most useful when you have two or more
		1356	watchers handling the same resource: a typical usage example is having an
		1357	C<ev_io> watcher to receive data, and an associated C<ev_timer> to handle
		1358	timeouts. Under load, data might be received while the program handles
		1359	other jobs, but since timers normally get invoked first, the timeout
		1360	handler will be executed before checking for data. In that case, giving
		1361	the timer a lower priority than the I/O watcher ensures that I/O will be
		1362	handled first even under adverse conditions (which is usually, but not
		1363	always, what you want).
		1364
		1365	Since idle watchers use the "lock-out" model, meaning that idle watchers
		1366	will only be executed when no same or higher priority watchers have
		1367	received events, they can be used to implement the "lock-out" model when
		1368	required.
		1369
		1370	For example, to emulate how many other event libraries handle priorities,
		1371	you can associate an C<ev_idle> watcher to each such watcher, and in
		1372	the normal watcher callback, you just start the idle watcher. The real
		1373	processing is done in the idle watcher callback. This causes libev to
		1374	continously poll and process kernel event data for the watcher, but when
		1375	the lock-out case is known to be rare (which in turn is rare :), this is
		1376	workable.
		1377
		1378	Usually, however, the lock-out model implemented that way will perform
		1379	miserably under the type of load it was designed to handle. In that case,
		1380	it might be preferable to stop the real watcher before starting the
		1381	idle watcher, so the kernel will not have to process the event in case
		1382	the actual processing will be delayed for considerable time.
		1383
		1384	Here is an example of an I/O watcher that should run at a strictly lower
		1385	priority than the default, and which should only process data when no
		1386	other events are pending:
		1387
		1388	ev_idle idle; // actual processing watcher
		1389	ev_io io; // actual event watcher
		1390
		1391	static void
		1392	io_cb (EV_P_ ev_io *w, int revents)
		1393	{
		1394	// stop the I/O watcher, we received the event, but
		1395	// are not yet ready to handle it.
		1396	ev_io_stop (EV_A_ w);
		1397
		1398	// start the idle watcher to ahndle the actual event.
		1399	// it will not be executed as long as other watchers
		1400	// with the default priority are receiving events.
		1401	ev_idle_start (EV_A_ &idle);
		1402	}
		1403
		1404	static void
		1405	idle_cb (EV_P_ ev_idle *w, int revents)
		1406	{
		1407	// actual processing
		1408	read (STDIN_FILENO, ...);
		1409
		1410	// have to start the I/O watcher again, as
		1411	// we have handled the event
		1412	ev_io_start (EV_P_ &io);
		1413	}
		1414
		1415	// initialisation
		1416	ev_idle_init (&idle, idle_cb);
		1417	ev_io_init (&io, io_cb, STDIN_FILENO, EV_READ);
		1418	ev_io_start (EV_DEFAULT_ &io);
		1419
		1420	In the "real" world, it might also be beneficial to start a timer, so that
		1421	low-priority connections can not be locked out forever under load. This
		1422	enables your program to keep a lower latency for important connections
		1423	during short periods of high load, while not completely locking out less
		1424	important ones.
1163		1425
1164		1426
1165	=head1 WATCHER TYPES	1427	=head1 WATCHER TYPES
1166		1428
1167	This section describes each watcher in detail, but will not repeat	1429	This section describes each watcher in detail, but will not repeat
…		…
1193	descriptors to non-blocking mode is also usually a good idea (but not	1455	descriptors to non-blocking mode is also usually a good idea (but not
1194	required if you know what you are doing).	1456	required if you know what you are doing).
1195		1457
1196	If you cannot use non-blocking mode, then force the use of a	1458	If you cannot use non-blocking mode, then force the use of a
1197	known-to-be-good backend (at the time of this writing, this includes only	1459	known-to-be-good backend (at the time of this writing, this includes only
1198	C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>).	1460	C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>). The same applies to file
		1461	descriptors for which non-blocking operation makes no sense (such as
		1462	files) - libev doesn't guarentee any specific behaviour in that case.
1199		1463
1200	Another thing you have to watch out for is that it is quite easy to	1464	Another thing you have to watch out for is that it is quite easy to
1201	receive "spurious" readiness notifications, that is your callback might	1465	receive "spurious" readiness notifications, that is your callback might
1202	be called with C<EV_READ> but a subsequent C<read>(2) will actually block	1466	be called with C<EV_READ> but a subsequent C<read>(2) will actually block
1203	because there is no data. Not only are some backends known to create a	1467	because there is no data. Not only are some backends known to create a
…		…
1324	year, it will still time out after (roughly) one hour. "Roughly" because	1588	year, it will still time out after (roughly) one hour. "Roughly" because
1325	detecting time jumps is hard, and some inaccuracies are unavoidable (the	1589	detecting time jumps is hard, and some inaccuracies are unavoidable (the
1326	monotonic clock option helps a lot here).	1590	monotonic clock option helps a lot here).
1327		1591
1328	The callback is guaranteed to be invoked only I<after> its timeout has	1592	The callback is guaranteed to be invoked only I<after> its timeout has
1329	passed. If multiple timers become ready during the same loop iteration	1593	passed (not I<at>, so on systems with very low-resolution clocks this
1330	then the ones with earlier time-out values are invoked before ones with	1594	might introduce a small delay). If multiple timers become ready during the
1331	later time-out values (but this is no longer true when a callback calls	1595	same loop iteration then the ones with earlier time-out values are invoked
1332	C<ev_loop> recursively).	1596	before ones of the same priority with later time-out values (but this is
		1597	no longer true when a callback calls C<ev_loop> recursively).
1333		1598
1334	=head3 Be smart about timeouts	1599	=head3 Be smart about timeouts
1335		1600
1336	Many real-world problems involve some kind of timeout, usually for error	1601	Many real-world problems involve some kind of timeout, usually for error
1337	recovery. A typical example is an HTTP request - if the other side hangs,	1602	recovery. A typical example is an HTTP request - if the other side hangs,
…		…
1381	C<after> argument to C<ev_timer_set>, and only ever use the C<repeat>	1646	C<after> argument to C<ev_timer_set>, and only ever use the C<repeat>
1382	member and C<ev_timer_again>.	1647	member and C<ev_timer_again>.
1383		1648
1384	At start:	1649	At start:
1385		1650
1386	ev_timer_init (timer, callback);	1651	ev_init (timer, callback);
1387	timer->repeat = 60.;	1652	timer->repeat = 60.;
1388	ev_timer_again (loop, timer);	1653	ev_timer_again (loop, timer);
1389		1654
1390	Each time there is some activity:	1655	Each time there is some activity:
1391		1656
…		…
1453		1718
1454	To start the timer, simply initialise the watcher and set C<last_activity>	1719	To start the timer, simply initialise the watcher and set C<last_activity>
1455	to the current time (meaning we just have some activity :), then call the	1720	to the current time (meaning we just have some activity :), then call the
1456	callback, which will "do the right thing" and start the timer:	1721	callback, which will "do the right thing" and start the timer:
1457		1722
1458	ev_timer_init (timer, callback);	1723	ev_init (timer, callback);
1459	last_activity = ev_now (loop);	1724	last_activity = ev_now (loop);
1460	callback (loop, timer, EV_TIMEOUT);	1725	callback (loop, timer, EV_TIMEOUT);
1461		1726
1462	And when there is some activity, simply store the current time in	1727	And when there is some activity, simply store the current time in
1463	C<last_activity>, no libev calls at all:	1728	C<last_activity>, no libev calls at all:
…		…
1524		1789
1525	If the event loop is suspended for a long time, you can also force an	1790	If the event loop is suspended for a long time, you can also force an
1526	update of the time returned by C<ev_now ()> by calling C<ev_now_update	1791	update of the time returned by C<ev_now ()> by calling C<ev_now_update
1527	()>.	1792	()>.
1528		1793
		1794	=head3 The special problems of suspended animation
		1795
		1796	When you leave the server world it is quite customary to hit machines that
		1797	can suspend/hibernate - what happens to the clocks during such a suspend?
		1798
		1799	Some quick tests made with a Linux 2.6.28 indicate that a suspend freezes
		1800	all processes, while the clocks (C<times>, C<CLOCK_MONOTONIC>) continue
		1801	to run until the system is suspended, but they will not advance while the
		1802	system is suspended. That means, on resume, it will be as if the program
		1803	was frozen for a few seconds, but the suspend time will not be counted
		1804	towards C<ev_timer> when a monotonic clock source is used. The real time
		1805	clock advanced as expected, but if it is used as sole clocksource, then a
		1806	long suspend would be detected as a time jump by libev, and timers would
		1807	be adjusted accordingly.
		1808
		1809	I would not be surprised to see different behaviour in different between
		1810	operating systems, OS versions or even different hardware.
		1811
		1812	The other form of suspend (job control, or sending a SIGSTOP) will see a
		1813	time jump in the monotonic clocks and the realtime clock. If the program
		1814	is suspended for a very long time, and monotonic clock sources are in use,
		1815	then you can expect C<ev_timer>s to expire as the full suspension time
		1816	will be counted towards the timers. When no monotonic clock source is in
		1817	use, then libev will again assume a timejump and adjust accordingly.
		1818
		1819	It might be beneficial for this latter case to call C<ev_suspend>
		1820	and C<ev_resume> in code that handles C<SIGTSTP>, to at least get
		1821	deterministic behaviour in this case (you can do nothing against
		1822	C<SIGSTOP>).
		1823
1529	=head3 Watcher-Specific Functions and Data Members	1824	=head3 Watcher-Specific Functions and Data Members
1530		1825
1531	=over 4	1826	=over 4
1532		1827
1533	=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)	1828	=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
…		…
1556	If the timer is started but non-repeating, stop it (as if it timed out).	1851	If the timer is started but non-repeating, stop it (as if it timed out).
1557		1852
1558	If the timer is repeating, either start it if necessary (with the	1853	If the timer is repeating, either start it if necessary (with the
1559	C<repeat> value), or reset the running timer to the C<repeat> value.	1854	C<repeat> value), or reset the running timer to the C<repeat> value.
1560		1855
1561	This sounds a bit complicated, see "Be smart about timeouts", above, for a	1856	This sounds a bit complicated, see L<Be smart about timeouts>, above, for a
1562	usage example.	1857	usage example.
		1858
		1859	=item ev_tstamp ev_timer_remaining (loop, ev_timer *)
		1860
		1861	Returns the remaining time until a timer fires. If the timer is active,
		1862	then this time is relative to the current event loop time, otherwise it's
		1863	the timeout value currently configured.
		1864
		1865	That is, after an C<ev_timer_set (w, 5, 7)>, C<ev_timer_remaining> returns
		1866	C<5>. When the timer is started and one second passes, C<ev_timer_remain>
		1867	will return C<4>. When the timer expires and is restarted, it will return
		1868	roughly C<7> (likely slightly less as callback invocation takes some time,
		1869	too), and so on.
1563		1870
1564	=item ev_tstamp repeat [read-write]	1871	=item ev_tstamp repeat [read-write]
1565		1872
1566	The current C<repeat> value. Will be used each time the watcher times out	1873	The current C<repeat> value. Will be used each time the watcher times out
1567	or C<ev_timer_again> is called, and determines the next timeout (if any),	1874	or C<ev_timer_again> is called, and determines the next timeout (if any),
…		…
1803	Signal watchers will trigger an event when the process receives a specific	2110	Signal watchers will trigger an event when the process receives a specific
1804	signal one or more times. Even though signals are very asynchronous, libev	2111	signal one or more times. Even though signals are very asynchronous, libev
1805	will try it's best to deliver signals synchronously, i.e. as part of the	2112	will try it's best to deliver signals synchronously, i.e. as part of the
1806	normal event processing, like any other event.	2113	normal event processing, like any other event.
1807		2114
1808	If you want signals asynchronously, just use C<sigaction> as you would	2115	If you want signals to be delivered truly asynchronously, just use
1809	do without libev and forget about sharing the signal. You can even use	2116	C<sigaction> as you would do without libev and forget about sharing
1810	C<ev_async> from a signal handler to synchronously wake up an event loop.	2117	the signal. You can even use C<ev_async> from a signal handler to
		2118	synchronously wake up an event loop.
1811		2119
1812	You can configure as many watchers as you like per signal. Only when the	2120	You can configure as many watchers as you like for the same signal, but
		2121	only within the same loop, i.e. you can watch for C<SIGINT> in your
		2122	default loop and for C<SIGIO> in another loop, but you cannot watch for
		2123	C<SIGINT> in both the default loop and another loop at the same time. At
		2124	the moment, C<SIGCHLD> is permanently tied to the default loop.
		2125
1813	first watcher gets started will libev actually register a signal handler	2126	When the first watcher gets started will libev actually register something
1814	with the kernel (thus it coexists with your own signal handlers as long as	2127	with the kernel (thus it coexists with your own signal handlers as long as
1815	you don't register any with libev for the same signal). Similarly, when	2128	you don't register any with libev for the same signal).
1816	the last signal watcher for a signal is stopped, libev will reset the
1817	signal handler to SIG_DFL (regardless of what it was set to before).
1818		2129
1819	If possible and supported, libev will install its handlers with	2130	If possible and supported, libev will install its handlers with
1820	C<SA_RESTART> behaviour enabled, so system calls should not be unduly	2131	C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should
1821	interrupted. If you have a problem with system calls getting interrupted by	2132	not be unduly interrupted. If you have a problem with system calls getting
1822	signals you can block all signals in an C<ev_check> watcher and unblock	2133	interrupted by signals you can block all signals in an C<ev_check> watcher
1823	them in an C<ev_prepare> watcher.	2134	and unblock them in an C<ev_prepare> watcher.
		2135
		2136	=head3 The special problem of inheritance over execve
		2137
		2138	Both the signal mask (C<sigprocmask>) and the signal disposition
		2139	(C<sigaction>) are unspecified after starting a signal watcher (and after
		2140	stopping it again), that is, libev might or might not block the signal,
		2141	and might or might not set or restore the installed signal handler.
		2142
		2143	While this does not matter for the signal disposition (libev never
		2144	sets signals to C<SIG_IGN>, so handlers will be reset to C<SIG_DFL> on
		2145	C<execve>), this matters for the signal mask: many programs do not expect
		2146	certain signals to be blocked.
		2147
		2148	This means that before calling C<exec> (from the child) you should reset
		2149	the signal mask to whatever "default" you expect (all clear is a good
		2150	choice usually).
		2151
		2152	The simplest way to ensure that the signal mask is reset in the child is
		2153	to install a fork handler with C<pthread_atfork> that resets it. That will
		2154	catch fork calls done by libraries (such as the libc) as well.
		2155
		2156	In current versions of libev, you can also ensure that the signal mask is
		2157	not blocking any signals (except temporarily, so thread users watch out)
		2158	by specifying the C<EVFLAG_NOSIGFD> when creating the event loop. This
		2159	is not guaranteed for future versions, however.
1824		2160
1825	=head3 Watcher-Specific Functions and Data Members	2161	=head3 Watcher-Specific Functions and Data Members
1826		2162
1827	=over 4	2163	=over 4
1828		2164
…		…
1860	some child status changes (most typically when a child of yours dies or	2196	some child status changes (most typically when a child of yours dies or
1861	exits). It is permissible to install a child watcher I<after> the child	2197	exits). It is permissible to install a child watcher I<after> the child
1862	has been forked (which implies it might have already exited), as long	2198	has been forked (which implies it might have already exited), as long
1863	as the event loop isn't entered (or is continued from a watcher), i.e.,	2199	as the event loop isn't entered (or is continued from a watcher), i.e.,
1864	forking and then immediately registering a watcher for the child is fine,	2200	forking and then immediately registering a watcher for the child is fine,
1865	but forking and registering a watcher a few event loop iterations later is	2201	but forking and registering a watcher a few event loop iterations later or
1866	not.	2202	in the next callback invocation is not.
1867		2203
1868	Only the default event loop is capable of handling signals, and therefore	2204	Only the default event loop is capable of handling signals, and therefore
1869	you can only register child watchers in the default event loop.	2205	you can only register child watchers in the default event loop.
1870		2206
		2207	Due to some design glitches inside libev, child watchers will always be
		2208	handled at maximum priority (their priority is set to C<EV_MAXPRI> by
		2209	libev)
		2210
1871	=head3 Process Interaction	2211	=head3 Process Interaction
1872		2212
1873	Libev grabs C<SIGCHLD> as soon as the default event loop is	2213	Libev grabs C<SIGCHLD> as soon as the default event loop is
1874	initialised. This is necessary to guarantee proper behaviour even if	2214	initialised. This is necessary to guarantee proper behaviour even if the
1875	the first child watcher is started after the child exits. The occurrence	2215	first child watcher is started after the child exits. The occurrence
1876	of C<SIGCHLD> is recorded asynchronously, but child reaping is done	2216	of C<SIGCHLD> is recorded asynchronously, but child reaping is done
1877	synchronously as part of the event loop processing. Libev always reaps all	2217	synchronously as part of the event loop processing. Libev always reaps all
1878	children, even ones not watched.	2218	children, even ones not watched.
1879		2219
1880	=head3 Overriding the Built-In Processing	2220	=head3 Overriding the Built-In Processing
…		…
1890	=head3 Stopping the Child Watcher	2230	=head3 Stopping the Child Watcher
1891		2231
1892	Currently, the child watcher never gets stopped, even when the	2232	Currently, the child watcher never gets stopped, even when the
1893	child terminates, so normally one needs to stop the watcher in the	2233	child terminates, so normally one needs to stop the watcher in the
1894	callback. Future versions of libev might stop the watcher automatically	2234	callback. Future versions of libev might stop the watcher automatically
1895	when a child exit is detected.	2235	when a child exit is detected (calling C<ev_child_stop> twice is not a
		2236	problem).
1896		2237
1897	=head3 Watcher-Specific Functions and Data Members	2238	=head3 Watcher-Specific Functions and Data Members
1898		2239
1899	=over 4	2240	=over 4
1900		2241
…		…
2226	// no longer anything immediate to do.	2567	// no longer anything immediate to do.
2227	}	2568	}
2228		2569
2229	ev_idle *idle_watcher = malloc (sizeof (ev_idle));	2570	ev_idle *idle_watcher = malloc (sizeof (ev_idle));
2230	ev_idle_init (idle_watcher, idle_cb);	2571	ev_idle_init (idle_watcher, idle_cb);
2231	ev_idle_start (loop, idle_cb);	2572	ev_idle_start (loop, idle_watcher);
2232		2573
2233		2574
2234	=head2 C<ev_prepare> and C<ev_check> - customise your event loop!	2575	=head2 C<ev_prepare> and C<ev_check> - customise your event loop!
2235		2576
2236	Prepare and check watchers are usually (but not always) used in pairs:	2577	Prepare and check watchers are usually (but not always) used in pairs:
…		…
2329	struct pollfd fds [nfd];	2670	struct pollfd fds [nfd];
2330	// actual code will need to loop here and realloc etc.	2671	// actual code will need to loop here and realloc etc.
2331	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));	2672	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
2332		2673
2333	/* the callback is illegal, but won't be called as we stop during check */	2674	/* the callback is illegal, but won't be called as we stop during check */
2334	ev_timer_init (&tw, 0, timeout * 1e-3);	2675	ev_timer_init (&tw, 0, timeout * 1e-3, 0.);
2335	ev_timer_start (loop, &tw);	2676	ev_timer_start (loop, &tw);
2336		2677
2337	// create one ev_io per pollfd	2678	// create one ev_io per pollfd
2338	for (int i = 0; i < nfd; ++i)	2679	for (int i = 0; i < nfd; ++i)
2339	{	2680	{
…		…
2569	event loop blocks next and before C<ev_check> watchers are being called,	2910	event loop blocks next and before C<ev_check> watchers are being called,
2570	and only in the child after the fork. If whoever good citizen calling	2911	and only in the child after the fork. If whoever good citizen calling
2571	C<ev_default_fork> cheats and calls it in the wrong process, the fork	2912	C<ev_default_fork> cheats and calls it in the wrong process, the fork
2572	handlers will be invoked, too, of course.	2913	handlers will be invoked, too, of course.
2573		2914
		2915	=head3 The special problem of life after fork - how is it possible?
		2916
		2917	Most uses of C<fork()> consist of forking, then some simple calls to ste
		2918	up/change the process environment, followed by a call to C<exec()>. This
		2919	sequence should be handled by libev without any problems.
		2920
		2921	This changes when the application actually wants to do event handling
		2922	in the child, or both parent in child, in effect "continuing" after the
		2923	fork.
		2924
		2925	The default mode of operation (for libev, with application help to detect
		2926	forks) is to duplicate all the state in the child, as would be expected
		2927	when I<either> the parent I<or> the child process continues.
		2928
		2929	When both processes want to continue using libev, then this is usually the
		2930	wrong result. In that case, usually one process (typically the parent) is
		2931	supposed to continue with all watchers in place as before, while the other
		2932	process typically wants to start fresh, i.e. without any active watchers.
		2933
		2934	The cleanest and most efficient way to achieve that with libev is to
		2935	simply create a new event loop, which of course will be "empty", and
		2936	use that for new watchers. This has the advantage of not touching more
		2937	memory than necessary, and thus avoiding the copy-on-write, and the
		2938	disadvantage of having to use multiple event loops (which do not support
		2939	signal watchers).
		2940
		2941	When this is not possible, or you want to use the default loop for
		2942	other reasons, then in the process that wants to start "fresh", call
		2943	C<ev_default_destroy ()> followed by C<ev_default_loop (...)>. Destroying
		2944	the default loop will "orphan" (not stop) all registered watchers, so you
		2945	have to be careful not to execute code that modifies those watchers. Note
		2946	also that in that case, you have to re-register any signal watchers.
		2947
2574	=head3 Watcher-Specific Functions and Data Members	2948	=head3 Watcher-Specific Functions and Data Members
2575		2949
2576	=over 4	2950	=over 4
2577		2951
2578	=item ev_fork_init (ev_signal *, callback)	2952	=item ev_fork_init (ev_signal *, callback)
…		…
2607	=head3 Queueing	2981	=head3 Queueing
2608		2982
2609	C<ev_async> does not support queueing of data in any way. The reason	2983	C<ev_async> does not support queueing of data in any way. The reason
2610	is that the author does not know of a simple (or any) algorithm for a	2984	is that the author does not know of a simple (or any) algorithm for a
2611	multiple-writer-single-reader queue that works in all cases and doesn't	2985	multiple-writer-single-reader queue that works in all cases and doesn't
2612	need elaborate support such as pthreads.	2986	need elaborate support such as pthreads or unportable memory access
		2987	semantics.
2613		2988
2614	That means that if you want to queue data, you have to provide your own	2989	That means that if you want to queue data, you have to provide your own
2615	queue. But at least I can tell you how to implement locking around your	2990	queue. But at least I can tell you how to implement locking around your
2616	queue:	2991	queue:
2617		2992
…		…
2775	/* doh, nothing entered */;	3150	/* doh, nothing entered */;
2776	}	3151	}
2777		3152
2778	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);	3153	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
2779		3154
2780	=item ev_feed_event (struct ev_loop , watcher , int revents)
2781
2782	Feeds the given event set into the event loop, as if the specified event
2783	had happened for the specified watcher (which must be a pointer to an
2784	initialised but not necessarily started event watcher).
2785
2786	=item ev_feed_fd_event (struct ev_loop *, int fd, int revents)	3155	=item ev_feed_fd_event (loop, int fd, int revents)
2787		3156
2788	Feed an event on the given fd, as if a file descriptor backend detected	3157	Feed an event on the given fd, as if a file descriptor backend detected
2789	the given events it.	3158	the given events it.
2790		3159
2791	=item ev_feed_signal_event (struct ev_loop *loop, int signum)	3160	=item ev_feed_signal_event (loop, int signum)
2792		3161
2793	Feed an event as if the given signal occurred (C<loop> must be the default	3162	Feed an event as if the given signal occurred (C<loop> must be the default
2794	loop!).	3163	loop!).
2795		3164
2796	=back	3165	=back
…		…
2876		3245
2877	=over 4	3246	=over 4
2878		3247
2879	=item ev::TYPE::TYPE ()	3248	=item ev::TYPE::TYPE ()
2880		3249
2881	=item ev::TYPE::TYPE (struct ev_loop *)	3250	=item ev::TYPE::TYPE (loop)
2882		3251
2883	=item ev::TYPE::~TYPE	3252	=item ev::TYPE::~TYPE
2884		3253
2885	The constructor (optionally) takes an event loop to associate the watcher	3254	The constructor (optionally) takes an event loop to associate the watcher
2886	with. If it is omitted, it will use C<EV_DEFAULT>.	3255	with. If it is omitted, it will use C<EV_DEFAULT>.
…		…
2963	Example: Use a plain function as callback.	3332	Example: Use a plain function as callback.
2964		3333
2965	static void io_cb (ev::io &w, int revents) { }	3334	static void io_cb (ev::io &w, int revents) { }
2966	iow.set <io_cb> ();	3335	iow.set <io_cb> ();
2967		3336
2968	=item w->set (struct ev_loop *)	3337	=item w->set (loop)
2969		3338
2970	Associates a different C<struct ev_loop> with this watcher. You can only	3339	Associates a different C<struct ev_loop> with this watcher. You can only
2971	do this when the watcher is inactive (and not pending either).	3340	do this when the watcher is inactive (and not pending either).
2972		3341
2973	=item w->set ([arguments])	3342	=item w->set ([arguments])
…		…
3070	=item Ocaml	3439	=item Ocaml
3071		3440
3072	Erkki Seppala has written Ocaml bindings for libev, to be found at	3441	Erkki Seppala has written Ocaml bindings for libev, to be found at
3073	L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.	3442	L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.
3074		3443
		3444	=item Lua
		3445
		3446	Brian Maher has written a partial interface to libev
		3447	for lua (only C<ev_io> and C<ev_timer>), to be found at
		3448	L<http://github.com/brimworks/lua-ev>.
		3449
3075	=back	3450	=back
3076		3451
3077		3452
3078	=head1 MACRO MAGIC	3453	=head1 MACRO MAGIC
3079		3454
…		…
3245	keeps libev from including F<config.h>, and it also defines dummy	3620	keeps libev from including F<config.h>, and it also defines dummy
3246	implementations for some libevent functions (such as logging, which is not	3621	implementations for some libevent functions (such as logging, which is not
3247	supported). It will also not define any of the structs usually found in	3622	supported). It will also not define any of the structs usually found in
3248	F<event.h> that are not directly supported by the libev core alone.	3623	F<event.h> that are not directly supported by the libev core alone.
3249		3624
3250	In stanbdalone mode, libev will still try to automatically deduce the	3625	In standalone mode, libev will still try to automatically deduce the
3251	configuration, but has to be more conservative.	3626	configuration, but has to be more conservative.
3252		3627
3253	=item EV_USE_MONOTONIC	3628	=item EV_USE_MONOTONIC
3254		3629
3255	If defined to be C<1>, libev will try to detect the availability of the	3630	If defined to be C<1>, libev will try to detect the availability of the
…		…
3320	be used is the winsock select). This means that it will call	3695	be used is the winsock select). This means that it will call
3321	C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise,	3696	C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise,
3322	it is assumed that all these functions actually work on fds, even	3697	it is assumed that all these functions actually work on fds, even
3323	on win32. Should not be defined on non-win32 platforms.	3698	on win32. Should not be defined on non-win32 platforms.
3324		3699
3325	=item EV_FD_TO_WIN32_HANDLE	3700	=item EV_FD_TO_WIN32_HANDLE(fd)
3326		3701
3327	If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map	3702	If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map
3328	file descriptors to socket handles. When not defining this symbol (the	3703	file descriptors to socket handles. When not defining this symbol (the
3329	default), then libev will call C<_get_osfhandle>, which is usually	3704	default), then libev will call C<_get_osfhandle>, which is usually
3330	correct. In some cases, programs use their own file descriptor management,	3705	correct. In some cases, programs use their own file descriptor management,
3331	in which case they can provide this function to map fds to socket handles.	3706	in which case they can provide this function to map fds to socket handles.
		3707
		3708	=item EV_WIN32_HANDLE_TO_FD(handle)
		3709
		3710	If C<EV_SELECT_IS_WINSOCKET> then libev maps handles to file descriptors
		3711	using the standard C<_open_osfhandle> function. For programs implementing
		3712	their own fd to handle mapping, overwriting this function makes it easier
		3713	to do so. This can be done by defining this macro to an appropriate value.
		3714
		3715	=item EV_WIN32_CLOSE_FD(fd)
		3716
		3717	If programs implement their own fd to handle mapping on win32, then this
		3718	macro can be used to override the C<close> function, useful to unregister
		3719	file descriptors again. Note that the replacement function has to close
		3720	the underlying OS handle.
3332		3721
3333	=item EV_USE_POLL	3722	=item EV_USE_POLL
3334		3723
3335	If defined to be C<1>, libev will compile in support for the C<poll>(2)	3724	If defined to be C<1>, libev will compile in support for the C<poll>(2)
3336	backend. Otherwise it will be enabled on non-win32 platforms. It	3725	backend. Otherwise it will be enabled on non-win32 platforms. It
…		…
3468	defined to be C<0>, then they are not.	3857	defined to be C<0>, then they are not.
3469		3858
3470	=item EV_MINIMAL	3859	=item EV_MINIMAL
3471		3860
3472	If you need to shave off some kilobytes of code at the expense of some	3861	If you need to shave off some kilobytes of code at the expense of some
3473	speed, define this symbol to C<1>. Currently this is used to override some	3862	speed (but with the full API), define this symbol to C<1>. Currently this
3474	inlining decisions, saves roughly 30% code size on amd64. It also selects a	3863	is used to override some inlining decisions, saves roughly 30% code size
3475	much smaller 2-heap for timer management over the default 4-heap.	3864	on amd64. It also selects a much smaller 2-heap for timer management over
		3865	the default 4-heap.
		3866
		3867	You can save even more by disabling watcher types you do not need
		3868	and setting C<EV_MAXPRI> == C<EV_MINPRI>. Also, disabling C<assert>
		3869	(C<-DNDEBUG>) will usually reduce code size a lot.
		3870
		3871	Defining C<EV_MINIMAL> to C<2> will additionally reduce the core API to
		3872	provide a bare-bones event library. See C<ev.h> for details on what parts
		3873	of the API are still available, and do not complain if this subset changes
		3874	over time.
		3875
		3876	=item EV_NSIG
		3877
		3878	The highest supported signal number, +1 (or, the number of
		3879	signals): Normally, libev tries to deduce the maximum number of signals
		3880	automatically, but sometimes this fails, in which case it can be
		3881	specified. Also, using a lower number than detected (C<32> should be
		3882	good for about any system in existance) can save some memory, as libev
		3883	statically allocates some 12-24 bytes per signal number.
3476		3884
3477	=item EV_PID_HASHSIZE	3885	=item EV_PID_HASHSIZE
3478		3886
3479	C<ev_child> watchers use a small hash table to distribute workload by	3887	C<ev_child> watchers use a small hash table to distribute workload by
3480	pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more	3888	pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more
…		…
3666	default loop and triggering an C<ev_async> watcher from the default loop	4074	default loop and triggering an C<ev_async> watcher from the default loop
3667	watcher callback into the event loop interested in the signal.	4075	watcher callback into the event loop interested in the signal.
3668		4076
3669	=back	4077	=back
3670		4078
		4079	=head4 THREAD LOCKING EXAMPLE
		4080
		4081	Here is a fictitious example of how to run an event loop in a different
		4082	thread than where callbacks are being invoked and watchers are
		4083	created/added/removed.
		4084
		4085	For a real-world example, see the C<EV::Loop::Async> perl module,
		4086	which uses exactly this technique (which is suited for many high-level
		4087	languages).
		4088
		4089	The example uses a pthread mutex to protect the loop data, a condition
		4090	variable to wait for callback invocations, an async watcher to notify the
		4091	event loop thread and an unspecified mechanism to wake up the main thread.
		4092
		4093	First, you need to associate some data with the event loop:
		4094
		4095	typedef struct {
		4096	mutex_t lock; /* global loop lock */
		4097	ev_async async_w;
		4098	thread_t tid;
		4099	cond_t invoke_cv;
		4100	} userdata;
		4101
		4102	void prepare_loop (EV_P)
		4103	{
		4104	// for simplicity, we use a static userdata struct.
		4105	static userdata u;
		4106
		4107	ev_async_init (&u->async_w, async_cb);
		4108	ev_async_start (EV_A_ &u->async_w);
		4109
		4110	pthread_mutex_init (&u->lock, 0);
		4111	pthread_cond_init (&u->invoke_cv, 0);
		4112
		4113	// now associate this with the loop
		4114	ev_set_userdata (EV_A_ u);
		4115	ev_set_invoke_pending_cb (EV_A_ l_invoke);
		4116	ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
		4117
		4118	// then create the thread running ev_loop
		4119	pthread_create (&u->tid, 0, l_run, EV_A);
		4120	}
		4121
		4122	The callback for the C<ev_async> watcher does nothing: the watcher is used
		4123	solely to wake up the event loop so it takes notice of any new watchers
		4124	that might have been added:
		4125
		4126	static void
		4127	async_cb (EV_P_ ev_async *w, int revents)
		4128	{
		4129	// just used for the side effects
		4130	}
		4131
		4132	The C<l_release> and C<l_acquire> callbacks simply unlock/lock the mutex
		4133	protecting the loop data, respectively.
		4134
		4135	static void
		4136	l_release (EV_P)
		4137	{
		4138	userdata *u = ev_userdata (EV_A);
		4139	pthread_mutex_unlock (&u->lock);
		4140	}
		4141
		4142	static void
		4143	l_acquire (EV_P)
		4144	{
		4145	userdata *u = ev_userdata (EV_A);
		4146	pthread_mutex_lock (&u->lock);
		4147	}
		4148
		4149	The event loop thread first acquires the mutex, and then jumps straight
		4150	into C<ev_loop>:
		4151
		4152	void *
		4153	l_run (void *thr_arg)
		4154	{
		4155	struct ev_loop loop = (struct ev_loop )thr_arg;
		4156
		4157	l_acquire (EV_A);
		4158	pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
		4159	ev_loop (EV_A_ 0);
		4160	l_release (EV_A);
		4161
		4162	return 0;
		4163	}
		4164
		4165	Instead of invoking all pending watchers, the C<l_invoke> callback will
		4166	signal the main thread via some unspecified mechanism (signals? pipe
		4167	writes? C<Async::Interrupt>?) and then waits until all pending watchers
		4168	have been called (in a while loop because a) spurious wakeups are possible
		4169	and b) skipping inter-thread-communication when there are no pending
		4170	watchers is very beneficial):
		4171
		4172	static void
		4173	l_invoke (EV_P)
		4174	{
		4175	userdata *u = ev_userdata (EV_A);
		4176
		4177	while (ev_pending_count (EV_A))
		4178	{
		4179	wake_up_other_thread_in_some_magic_or_not_so_magic_way ();
		4180	pthread_cond_wait (&u->invoke_cv, &u->lock);
		4181	}
		4182	}
		4183
		4184	Now, whenever the main thread gets told to invoke pending watchers, it
		4185	will grab the lock, call C<ev_invoke_pending> and then signal the loop
		4186	thread to continue:
		4187
		4188	static void
		4189	real_invoke_pending (EV_P)
		4190	{
		4191	userdata *u = ev_userdata (EV_A);
		4192
		4193	pthread_mutex_lock (&u->lock);
		4194	ev_invoke_pending (EV_A);
		4195	pthread_cond_signal (&u->invoke_cv);
		4196	pthread_mutex_unlock (&u->lock);
		4197	}
		4198
		4199	Whenever you want to start/stop a watcher or do other modifications to an
		4200	event loop, you will now have to lock:
		4201
		4202	ev_timer timeout_watcher;
		4203	userdata *u = ev_userdata (EV_A);
		4204
		4205	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
		4206
		4207	pthread_mutex_lock (&u->lock);
		4208	ev_timer_start (EV_A_ &timeout_watcher);
		4209	ev_async_send (EV_A_ &u->async_w);
		4210	pthread_mutex_unlock (&u->lock);
		4211
		4212	Note that sending the C<ev_async> watcher is required because otherwise
		4213	an event loop currently blocking in the kernel will have no knowledge
		4214	about the newly added timer. By waking up the loop it will pick up any new
		4215	watchers in the next event loop iteration.
		4216
3671	=head3 COROUTINES	4217	=head3 COROUTINES
3672		4218
3673	Libev is very accommodating to coroutines ("cooperative threads"):	4219	Libev is very accommodating to coroutines ("cooperative threads"):
3674	libev fully supports nesting calls to its functions from different	4220	libev fully supports nesting calls to its functions from different
3675	coroutines (e.g. you can call C<ev_loop> on the same loop from two	4221	coroutines (e.g. you can call C<ev_loop> on the same loop from two
3676	different coroutines, and switch freely between both coroutines running the	4222	different coroutines, and switch freely between both coroutines running
3677	loop, as long as you don't confuse yourself). The only exception is that	4223	the loop, as long as you don't confuse yourself). The only exception is
3678	you must not do this from C<ev_periodic> reschedule callbacks.	4224	that you must not do this from C<ev_periodic> reschedule callbacks.
3679		4225
3680	Care has been taken to ensure that libev does not keep local state inside	4226	Care has been taken to ensure that libev does not keep local state inside
3681	C<ev_loop>, and other calls do not usually allow for coroutine switches as	4227	C<ev_loop>, and other calls do not usually allow for coroutine switches as
3682	they do not call any callbacks.	4228	they do not call any callbacks.
3683		4229
…		…
3760	way (note also that glib is the slowest event library known to man).	4306	way (note also that glib is the slowest event library known to man).
3761		4307
3762	There is no supported compilation method available on windows except	4308	There is no supported compilation method available on windows except
3763	embedding it into other applications.	4309	embedding it into other applications.
3764		4310
		4311	Sensible signal handling is officially unsupported by Microsoft - libev
		4312	tries its best, but under most conditions, signals will simply not work.
		4313
3765	Not a libev limitation but worth mentioning: windows apparently doesn't	4314	Not a libev limitation but worth mentioning: windows apparently doesn't
3766	accept large writes: instead of resulting in a partial write, windows will	4315	accept large writes: instead of resulting in a partial write, windows will
3767	either accept everything or return C<ENOBUFS> if the buffer is too large,	4316	either accept everything or return C<ENOBUFS> if the buffer is too large,
3768	so make sure you only write small amounts into your sockets (less than a	4317	so make sure you only write small amounts into your sockets (less than a
3769	megabyte seems safe, but this apparently depends on the amount of memory	4318	megabyte seems safe, but this apparently depends on the amount of memory
…		…
3773	the abysmal performance of winsockets, using a large number of sockets	4322	the abysmal performance of winsockets, using a large number of sockets
3774	is not recommended (and not reasonable). If your program needs to use	4323	is not recommended (and not reasonable). If your program needs to use
3775	more than a hundred or so sockets, then likely it needs to use a totally	4324	more than a hundred or so sockets, then likely it needs to use a totally
3776	different implementation for windows, as libev offers the POSIX readiness	4325	different implementation for windows, as libev offers the POSIX readiness
3777	notification model, which cannot be implemented efficiently on windows	4326	notification model, which cannot be implemented efficiently on windows
3778	(Microsoft monopoly games).	4327	(due to Microsoft monopoly games).
3779		4328
3780	A typical way to use libev under windows is to embed it (see the embedding	4329	A typical way to use libev under windows is to embed it (see the embedding
3781	section for details) and use the following F<evwrap.h> header file instead	4330	section for details) and use the following F<evwrap.h> header file instead
3782	of F<ev.h>:	4331	of F<ev.h>:
3783		4332
…		…
3819		4368
3820	Early versions of winsocket's select only supported waiting for a maximum	4369	Early versions of winsocket's select only supported waiting for a maximum
3821	of C<64> handles (probably owning to the fact that all windows kernels	4370	of C<64> handles (probably owning to the fact that all windows kernels
3822	can only wait for C<64> things at the same time internally; Microsoft	4371	can only wait for C<64> things at the same time internally; Microsoft
3823	recommends spawning a chain of threads and wait for 63 handles and the	4372	recommends spawning a chain of threads and wait for 63 handles and the
3824	previous thread in each. Great).	4373	previous thread in each. Sounds great!).
3825		4374
3826	Newer versions support more handles, but you need to define C<FD_SETSIZE>	4375	Newer versions support more handles, but you need to define C<FD_SETSIZE>
3827	to some high number (e.g. C<2048>) before compiling the winsocket select	4376	to some high number (e.g. C<2048>) before compiling the winsocket select
3828	call (which might be in libev or elsewhere, for example, perl does its own	4377	call (which might be in libev or elsewhere, for example, perl and many
3829	select emulation on windows).	4378	other interpreters do their own select emulation on windows).
3830		4379
3831	Another limit is the number of file descriptors in the Microsoft runtime	4380	Another limit is the number of file descriptors in the Microsoft runtime
3832	libraries, which by default is C<64> (there must be a hidden I<64> fetish	4381	libraries, which by default is C<64> (there must be a hidden I<64>
3833	or something like this inside Microsoft). You can increase this by calling	4382	fetish or something like this inside Microsoft). You can increase this
3834	C<_setmaxstdio>, which can increase this limit to C<2048> (another	4383	by calling C<_setmaxstdio>, which can increase this limit to C<2048>
3835	arbitrary limit), but is broken in many versions of the Microsoft runtime	4384	(another arbitrary limit), but is broken in many versions of the Microsoft
3836	libraries.
3837
3838	This might get you to about C<512> or C<2048> sockets (depending on	4385	runtime libraries. This might get you to about C<512> or C<2048> sockets
3839	windows version and/or the phase of the moon). To get more, you need to	4386	(depending on windows version and/or the phase of the moon). To get more,
3840	wrap all I/O functions and provide your own fd management, but the cost of	4387	you need to wrap all I/O functions and provide your own fd management, but
3841	calling select (O(n²)) will likely make this unworkable.	4388	the cost of calling select (O(n²)) will likely make this unworkable.
3842		4389
3843	=back	4390	=back
3844		4391
3845	=head2 PORTABILITY REQUIREMENTS	4392	=head2 PORTABILITY REQUIREMENTS
3846		4393
…		…
3889	=item C<double> must hold a time value in seconds with enough accuracy	4436	=item C<double> must hold a time value in seconds with enough accuracy
3890		4437
3891	The type C<double> is used to represent timestamps. It is required to	4438	The type C<double> is used to represent timestamps. It is required to
3892	have at least 51 bits of mantissa (and 9 bits of exponent), which is good	4439	have at least 51 bits of mantissa (and 9 bits of exponent), which is good
3893	enough for at least into the year 4000. This requirement is fulfilled by	4440	enough for at least into the year 4000. This requirement is fulfilled by
3894	implementations implementing IEEE 754 (basically all existing ones).	4441	implementations implementing IEEE 754, which is basically all existing
		4442	ones. With IEEE 754 doubles, you get microsecond accuracy until at least
		4443	2200.
3895		4444
3896	=back	4445	=back
3897		4446
3898	If you know of other additional requirements drop me a note.	4447	If you know of other additional requirements drop me a note.
3899		4448
…		…
3967	involves iterating over all running async watchers or all signal numbers.	4516	involves iterating over all running async watchers or all signal numbers.
3968		4517
3969	=back	4518	=back
3970		4519
3971		4520
		4521	=head1 GLOSSARY
		4522
		4523	=over 4
		4524
		4525	=item active
		4526
		4527	A watcher is active as long as it has been started (has been attached to
		4528	an event loop) but not yet stopped (disassociated from the event loop).
		4529
		4530	=item application
		4531
		4532	In this document, an application is whatever is using libev.
		4533
		4534	=item callback
		4535
		4536	The address of a function that is called when some event has been
		4537	detected. Callbacks are being passed the event loop, the watcher that
		4538	received the event, and the actual event bitset.
		4539
		4540	=item callback invocation
		4541
		4542	The act of calling the callback associated with a watcher.
		4543
		4544	=item event
		4545
		4546	A change of state of some external event, such as data now being available
		4547	for reading on a file descriptor, time having passed or simply not having
		4548	any other events happening anymore.
		4549
		4550	In libev, events are represented as single bits (such as C<EV_READ> or
		4551	C<EV_TIMEOUT>).
		4552
		4553	=item event library
		4554
		4555	A software package implementing an event model and loop.
		4556
		4557	=item event loop
		4558
		4559	An entity that handles and processes external events and converts them
		4560	into callback invocations.
		4561
		4562	=item event model
		4563
		4564	The model used to describe how an event loop handles and processes
		4565	watchers and events.
		4566
		4567	=item pending
		4568
		4569	A watcher is pending as soon as the corresponding event has been detected,
		4570	and stops being pending as soon as the watcher will be invoked or its
		4571	pending status is explicitly cleared by the application.
		4572
		4573	A watcher can be pending, but not active. Stopping a watcher also clears
		4574	its pending status.
		4575
		4576	=item real time
		4577
		4578	The physical time that is observed. It is apparently strictly monotonic :)
		4579
		4580	=item wall-clock time
		4581
		4582	The time and date as shown on clocks. Unlike real time, it can actually
		4583	be wrong and jump forwards and backwards, e.g. when the you adjust your
		4584	clock.
		4585
		4586	=item watcher
		4587
		4588	A data structure that describes interest in certain events. Watchers need
		4589	to be started (attached to an event loop) before they can receive events.
		4590
		4591	=item watcher invocation
		4592
		4593	The act of calling the callback associated with a watcher.
		4594
		4595	=back
		4596
3972	=head1 AUTHOR	4597	=head1 AUTHOR
3973		4598
3974	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson.	4599	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson.
3975		4600

Diff Legend

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

Comparing libev/ev.pod (file contents): Revision 1.230 by root, Wed Apr 15 18:47:07 2009 UTC vs. Revision 1.275 by root, Sat Dec 26 09:21:54 2009 UTC

Diff Legend

Comparing libev/ev.pod (file contents):
Revision 1.230 by root, Wed Apr 15 18:47:07 2009 UTC vs.
Revision 1.275 by root, Sat Dec 26 09:21:54 2009 UTC