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

Comparing libev/ev.pod (file contents):
Revision 1.245 by root, Tue Jun 30 06:24:38 2009 UTC vs.
Revision 1.272 by root, Tue Nov 24 06:39:28 2009 UTC

…		…
98	=head2 FEATURES	98	=head2 FEATURES
99		99
100	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
101	BSD-specific C<kqueue> and the Solaris-specific event port mechanisms	101	BSD-specific C<kqueue> and the Solaris-specific event port mechanisms
102	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
103	(for C<ev_stat>), relative timers (C<ev_timer>), absolute timers	103	(for C<ev_stat>), Linux eventfd/signalfd (for faster and cleaner
104	with customised rescheduling (C<ev_periodic>), synchronous signals	104	inter-thread wakeup (C<ev_async>)/signal handling (C<ev_signal>)) relative
105	(C<ev_signal>), process status change events (C<ev_child>), and event	105	timers (C<ev_timer>), absolute timers with customised rescheduling
106	watchers dealing with the event loop mechanism itself (C<ev_idle>,	106	(C<ev_periodic>), synchronous signals (C<ev_signal>), process status
107	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
108	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
109	(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>).
110		111
111	It also is quite fast (see this	112	It also is quite fast (see this
112	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
113	for example).	114	for example).
114		115
…		…
362	flag.	363	flag.
363		364
364	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>
365	environment variable.	366	environment variable.
366		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
367	=item C<EVBACKEND_SELECT> (value 1, portable select backend)	383	=item C<EVBACKEND_SELECT> (value 1, portable select backend)
368		384
369	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
370	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,
371	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
…		…
394		410
395	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
396	C<EV_WRITE> to C<POLLOUT \| POLLERR \| POLLHUP>.	412	C<EV_WRITE> to C<POLLOUT \| POLLERR \| POLLHUP>.
397		413
398	=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).
399		418
400	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,
401	but it scales phenomenally better. While poll and select usually scale	420	but it scales phenomenally better. While poll and select usually scale
402	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),
403	epoll scales either O(1) or O(active_fds).	422	epoll scales either O(1) or O(active_fds).
…		…
518		537
519	It is definitely not recommended to use this flag.	538	It is definitely not recommended to use this flag.
520		539
521	=back	540	=back
522		541
523	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,
524	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
525	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.
526		546
527	Example: This is the most typical usage.	547	Example: This is the most typical usage.
528		548
529	if (!ev_default_loop (0))	549	if (!ev_default_loop (0))
530	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");	550	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
…		…
573	as signal and child watchers) would need to be stopped manually.	593	as signal and child watchers) would need to be stopped manually.
574		594
575	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
576	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
577	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
578	C<ev_loop_new> and C<ev_loop_destroy>).	598	C<ev_loop_new> and C<ev_loop_destroy>.
579		599
580	=item ev_loop_destroy (loop)	600	=item ev_loop_destroy (loop)
581		601
582	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
583	earlier call to C<ev_loop_new>.	603	earlier call to C<ev_loop_new>.
…		…
621		641
622	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
623	"ticks" the number of loop iterations), as it roughly corresponds with	643	"ticks" the number of loop iterations), as it roughly corresponds with
624	C<ev_prepare> and C<ev_check> calls.	644	C<ev_prepare> and C<ev_check> calls.
625		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
626	=item unsigned int ev_backend (loop)	658	=item unsigned int ev_backend (loop)
627		659
628	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
629	use.	661	use.
630		662
…		…
675	event loop time (see C<ev_now_update>).	707	event loop time (see C<ev_now_update>).
676		708
677	=item ev_loop (loop, int flags)	709	=item ev_loop (loop, int flags)
678		710
679	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
680	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
681	events.	713	handling events.
682		714
683	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
684	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.
685		717
686	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
…		…
844	more often than 100 times per second:	876	more often than 100 times per second:
845		877
846	ev_set_timeout_collect_interval (EV_DEFAULT_UC_ 0.1);	878	ev_set_timeout_collect_interval (EV_DEFAULT_UC_ 0.1);
847	ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01);	879	ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01);
848		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.
		945
849	=item ev_loop_verify (loop)	946	=item ev_loop_verify (loop)
850		947
851	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
852	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
853	through all internal structures and checks them for validity. If anything	950	through all internal structures and checks them for validity. If anything
…		…
1480		1577
1481	The callback is guaranteed to be invoked only I<after> its timeout has	1578	The callback is guaranteed to be invoked only I<after> its timeout has
1482	passed (not I<at>, so on systems with very low-resolution clocks this	1579	passed (not I<at>, so on systems with very low-resolution clocks this
1483	might introduce a small delay). If multiple timers become ready during the	1580	might introduce a small delay). If multiple timers become ready during the
1484	same loop iteration then the ones with earlier time-out values are invoked	1581	same loop iteration then the ones with earlier time-out values are invoked
1485	before ones with later time-out values (but this is no longer true when a	1582	before ones of the same priority with later time-out values (but this is
1486	callback calls C<ev_loop> recursively).	1583	no longer true when a callback calls C<ev_loop> recursively).
1487		1584
1488	=head3 Be smart about timeouts	1585	=head3 Be smart about timeouts
1489		1586
1490	Many real-world problems involve some kind of timeout, usually for error	1587	Many real-world problems involve some kind of timeout, usually for error
1491	recovery. A typical example is an HTTP request - if the other side hangs,	1588	recovery. A typical example is an HTTP request - if the other side hangs,
…		…
1678		1775
1679	If the event loop is suspended for a long time, you can also force an	1776	If the event loop is suspended for a long time, you can also force an
1680	update of the time returned by C<ev_now ()> by calling C<ev_now_update	1777	update of the time returned by C<ev_now ()> by calling C<ev_now_update
1681	()>.	1778	()>.
1682		1779
		1780	=head3 The special problems of suspended animation
		1781
		1782	When you leave the server world it is quite customary to hit machines that
		1783	can suspend/hibernate - what happens to the clocks during such a suspend?
		1784
		1785	Some quick tests made with a Linux 2.6.28 indicate that a suspend freezes
		1786	all processes, while the clocks (C<times>, C<CLOCK_MONOTONIC>) continue
		1787	to run until the system is suspended, but they will not advance while the
		1788	system is suspended. That means, on resume, it will be as if the program
		1789	was frozen for a few seconds, but the suspend time will not be counted
		1790	towards C<ev_timer> when a monotonic clock source is used. The real time
		1791	clock advanced as expected, but if it is used as sole clocksource, then a
		1792	long suspend would be detected as a time jump by libev, and timers would
		1793	be adjusted accordingly.
		1794
		1795	I would not be surprised to see different behaviour in different between
		1796	operating systems, OS versions or even different hardware.
		1797
		1798	The other form of suspend (job control, or sending a SIGSTOP) will see a
		1799	time jump in the monotonic clocks and the realtime clock. If the program
		1800	is suspended for a very long time, and monotonic clock sources are in use,
		1801	then you can expect C<ev_timer>s to expire as the full suspension time
		1802	will be counted towards the timers. When no monotonic clock source is in
		1803	use, then libev will again assume a timejump and adjust accordingly.
		1804
		1805	It might be beneficial for this latter case to call C<ev_suspend>
		1806	and C<ev_resume> in code that handles C<SIGTSTP>, to at least get
		1807	deterministic behaviour in this case (you can do nothing against
		1808	C<SIGSTOP>).
		1809
1683	=head3 Watcher-Specific Functions and Data Members	1810	=head3 Watcher-Specific Functions and Data Members
1684		1811
1685	=over 4	1812	=over 4
1686		1813
1687	=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)	1814	=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
…		…
1712	If the timer is repeating, either start it if necessary (with the	1839	If the timer is repeating, either start it if necessary (with the
1713	C<repeat> value), or reset the running timer to the C<repeat> value.	1840	C<repeat> value), or reset the running timer to the C<repeat> value.
1714		1841
1715	This sounds a bit complicated, see L<Be smart about timeouts>, above, for a	1842	This sounds a bit complicated, see L<Be smart about timeouts>, above, for a
1716	usage example.	1843	usage example.
		1844
		1845	=item ev_timer_remaining (loop, ev_timer *)
		1846
		1847	Returns the remaining time until a timer fires. If the timer is active,
		1848	then this time is relative to the current event loop time, otherwise it's
		1849	the timeout value currently configured.
		1850
		1851	That is, after an C<ev_timer_set (w, 5, 7)>, C<ev_timer_remaining> returns
		1852	C<5>. When the timer is started and one second passes, C<ev_timer_remain>
		1853	will return C<4>. When the timer expires and is restarted, it will return
		1854	roughly C<7> (likely slightly less as callback invocation takes some time,
		1855	too), and so on.
1717		1856
1718	=item ev_tstamp repeat [read-write]	1857	=item ev_tstamp repeat [read-write]
1719		1858
1720	The current C<repeat> value. Will be used each time the watcher times out	1859	The current C<repeat> value. Will be used each time the watcher times out
1721	or C<ev_timer_again> is called, and determines the next timeout (if any),	1860	or C<ev_timer_again> is called, and determines the next timeout (if any),
…		…
1957	Signal watchers will trigger an event when the process receives a specific	2096	Signal watchers will trigger an event when the process receives a specific
1958	signal one or more times. Even though signals are very asynchronous, libev	2097	signal one or more times. Even though signals are very asynchronous, libev
1959	will try it's best to deliver signals synchronously, i.e. as part of the	2098	will try it's best to deliver signals synchronously, i.e. as part of the
1960	normal event processing, like any other event.	2099	normal event processing, like any other event.
1961		2100
1962	If you want signals asynchronously, just use C<sigaction> as you would	2101	If you want signals to be delivered truly asynchronously, just use
1963	do without libev and forget about sharing the signal. You can even use	2102	C<sigaction> as you would do without libev and forget about sharing
1964	C<ev_async> from a signal handler to synchronously wake up an event loop.	2103	the signal. You can even use C<ev_async> from a signal handler to
		2104	synchronously wake up an event loop.
1965		2105
1966	You can configure as many watchers as you like per signal. Only when the	2106	You can configure as many watchers as you like for the same signal, but
		2107	only within the same loop, i.e. you can watch for C<SIGINT> in your
		2108	default loop and for C<SIGIO> in another loop, but you cannot watch for
		2109	C<SIGINT> in both the default loop and another loop at the same time. At
		2110	the moment, C<SIGCHLD> is permanently tied to the default loop.
		2111
1967	first watcher gets started will libev actually register a signal handler	2112	When the first watcher gets started will libev actually register something
1968	with the kernel (thus it coexists with your own signal handlers as long as	2113	with the kernel (thus it coexists with your own signal handlers as long as
1969	you don't register any with libev for the same signal). Similarly, when	2114	you don't register any with libev for the same signal).
1970	the last signal watcher for a signal is stopped, libev will reset the
1971	signal handler to SIG_DFL (regardless of what it was set to before).
1972		2115
1973	If possible and supported, libev will install its handlers with	2116	If possible and supported, libev will install its handlers with
1974	C<SA_RESTART> behaviour enabled, so system calls should not be unduly	2117	C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should
1975	interrupted. If you have a problem with system calls getting interrupted by	2118	not be unduly interrupted. If you have a problem with system calls getting
1976	signals you can block all signals in an C<ev_check> watcher and unblock	2119	interrupted by signals you can block all signals in an C<ev_check> watcher
1977	them in an C<ev_prepare> watcher.	2120	and unblock them in an C<ev_prepare> watcher.
		2121
		2122	=head3 The special problem of inheritance over execve
		2123
		2124	Both the signal mask (C<sigprocmask>) and the signal disposition
		2125	(C<sigaction>) are unspecified after starting a signal watcher (and after
		2126	stopping it again), that is, libev might or might not block the signal,
		2127	and might or might not set or restore the installed signal handler.
		2128
		2129	While this does not matter for the signal disposition (libev never
		2130	sets signals to C<SIG_IGN>, so handlers will be reset to C<SIG_DFL> on
		2131	C<execve>), this matters for the signal mask: many programs do not expect
		2132	certain signals to be blocked.
		2133
		2134	This means that before calling C<exec> (from the child) you should reset
		2135	the signal mask to whatever "default" you expect (all clear is a good
		2136	choice usually).
		2137
		2138	The simplest way to ensure that the signal mask is reset in the child is
		2139	to install a fork handler with C<pthread_atfork> that resets it. That will
		2140	catch fork calls done by libraries (such as the libc) as well.
		2141
		2142	In current versions of libev, you can also ensure that the signal mask is
		2143	not blocking any signals (except temporarily, so thread users watch out)
		2144	by specifying the C<EVFLAG_NOSIGFD> when creating the event loop. This
		2145	is not guaranteed for future versions, however.
1978		2146
1979	=head3 Watcher-Specific Functions and Data Members	2147	=head3 Watcher-Specific Functions and Data Members
1980		2148
1981	=over 4	2149	=over 4
1982		2150
…		…
2020	in the next callback invocation is not.	2188	in the next callback invocation is not.
2021		2189
2022	Only the default event loop is capable of handling signals, and therefore	2190	Only the default event loop is capable of handling signals, and therefore
2023	you can only register child watchers in the default event loop.	2191	you can only register child watchers in the default event loop.
2024		2192
		2193	Due to some design glitches inside libev, child watchers will always be
		2194	handled at maximum priority (their priority is set to C<EV_MAXPRI> by
		2195	libev)
		2196
2025	=head3 Process Interaction	2197	=head3 Process Interaction
2026		2198
2027	Libev grabs C<SIGCHLD> as soon as the default event loop is	2199	Libev grabs C<SIGCHLD> as soon as the default event loop is
2028	initialised. This is necessary to guarantee proper behaviour even if	2200	initialised. This is necessary to guarantee proper behaviour even if the
2029	the first child watcher is started after the child exits. The occurrence	2201	first child watcher is started after the child exits. The occurrence
2030	of C<SIGCHLD> is recorded asynchronously, but child reaping is done	2202	of C<SIGCHLD> is recorded asynchronously, but child reaping is done
2031	synchronously as part of the event loop processing. Libev always reaps all	2203	synchronously as part of the event loop processing. Libev always reaps all
2032	children, even ones not watched.	2204	children, even ones not watched.
2033		2205
2034	=head3 Overriding the Built-In Processing	2206	=head3 Overriding the Built-In Processing
…		…
2044	=head3 Stopping the Child Watcher	2216	=head3 Stopping the Child Watcher
2045		2217
2046	Currently, the child watcher never gets stopped, even when the	2218	Currently, the child watcher never gets stopped, even when the
2047	child terminates, so normally one needs to stop the watcher in the	2219	child terminates, so normally one needs to stop the watcher in the
2048	callback. Future versions of libev might stop the watcher automatically	2220	callback. Future versions of libev might stop the watcher automatically
2049	when a child exit is detected.	2221	when a child exit is detected (calling C<ev_child_stop> twice is not a
		2222	problem).
2050		2223
2051	=head3 Watcher-Specific Functions and Data Members	2224	=head3 Watcher-Specific Functions and Data Members
2052		2225
2053	=over 4	2226	=over 4
2054		2227
…		…
3257	=item Ocaml	3430	=item Ocaml
3258		3431
3259	Erkki Seppala has written Ocaml bindings for libev, to be found at	3432	Erkki Seppala has written Ocaml bindings for libev, to be found at
3260	L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.	3433	L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.
3261		3434
		3435	=item Lua
		3436
		3437	Brian Maher has written a partial interface to libev
		3438	for lua (only C<ev_io> and C<ev_timer>), to be found at
		3439	L<http://github.com/brimworks/lua-ev>.
		3440
3262	=back	3441	=back
3263		3442
3264		3443
3265	=head1 MACRO MAGIC	3444	=head1 MACRO MAGIC
3266		3445
…		…
3432	keeps libev from including F<config.h>, and it also defines dummy	3611	keeps libev from including F<config.h>, and it also defines dummy
3433	implementations for some libevent functions (such as logging, which is not	3612	implementations for some libevent functions (such as logging, which is not
3434	supported). It will also not define any of the structs usually found in	3613	supported). It will also not define any of the structs usually found in
3435	F<event.h> that are not directly supported by the libev core alone.	3614	F<event.h> that are not directly supported by the libev core alone.
3436		3615
3437	In stanbdalone mode, libev will still try to automatically deduce the	3616	In standalone mode, libev will still try to automatically deduce the
3438	configuration, but has to be more conservative.	3617	configuration, but has to be more conservative.
3439		3618
3440	=item EV_USE_MONOTONIC	3619	=item EV_USE_MONOTONIC
3441		3620
3442	If defined to be C<1>, libev will try to detect the availability of the	3621	If defined to be C<1>, libev will try to detect the availability of the
…		…
3507	be used is the winsock select). This means that it will call	3686	be used is the winsock select). This means that it will call
3508	C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise,	3687	C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise,
3509	it is assumed that all these functions actually work on fds, even	3688	it is assumed that all these functions actually work on fds, even
3510	on win32. Should not be defined on non-win32 platforms.	3689	on win32. Should not be defined on non-win32 platforms.
3511		3690
3512	=item EV_FD_TO_WIN32_HANDLE	3691	=item EV_FD_TO_WIN32_HANDLE(fd)
3513		3692
3514	If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map	3693	If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map
3515	file descriptors to socket handles. When not defining this symbol (the	3694	file descriptors to socket handles. When not defining this symbol (the
3516	default), then libev will call C<_get_osfhandle>, which is usually	3695	default), then libev will call C<_get_osfhandle>, which is usually
3517	correct. In some cases, programs use their own file descriptor management,	3696	correct. In some cases, programs use their own file descriptor management,
3518	in which case they can provide this function to map fds to socket handles.	3697	in which case they can provide this function to map fds to socket handles.
		3698
		3699	=item EV_WIN32_HANDLE_TO_FD(handle)
		3700
		3701	If C<EV_SELECT_IS_WINSOCKET> then libev maps handles to file descriptors
		3702	using the standard C<_open_osfhandle> function. For programs implementing
		3703	their own fd to handle mapping, overwriting this function makes it easier
		3704	to do so. This can be done by defining this macro to an appropriate value.
		3705
		3706	=item EV_WIN32_CLOSE_FD(fd)
		3707
		3708	If programs implement their own fd to handle mapping on win32, then this
		3709	macro can be used to override the C<close> function, useful to unregister
		3710	file descriptors again. Note that the replacement function has to close
		3711	the underlying OS handle.
3519		3712
3520	=item EV_USE_POLL	3713	=item EV_USE_POLL
3521		3714
3522	If defined to be C<1>, libev will compile in support for the C<poll>(2)	3715	If defined to be C<1>, libev will compile in support for the C<poll>(2)
3523	backend. Otherwise it will be enabled on non-win32 platforms. It	3716	backend. Otherwise it will be enabled on non-win32 platforms. It
…		…
3655	defined to be C<0>, then they are not.	3848	defined to be C<0>, then they are not.
3656		3849
3657	=item EV_MINIMAL	3850	=item EV_MINIMAL
3658		3851
3659	If you need to shave off some kilobytes of code at the expense of some	3852	If you need to shave off some kilobytes of code at the expense of some
3660	speed, define this symbol to C<1>. Currently this is used to override some	3853	speed (but with the full API), define this symbol to C<1>. Currently this
3661	inlining decisions, saves roughly 30% code size on amd64. It also selects a	3854	is used to override some inlining decisions, saves roughly 30% code size
3662	much smaller 2-heap for timer management over the default 4-heap.	3855	on amd64. It also selects a much smaller 2-heap for timer management over
		3856	the default 4-heap.
		3857
		3858	You can save even more by disabling watcher types you do not need
		3859	and setting C<EV_MAXPRI> == C<EV_MINPRI>. Also, disabling C<assert>
		3860	(C<-DNDEBUG>) will usually reduce code size a lot.
		3861
		3862	Defining C<EV_MINIMAL> to C<2> will additionally reduce the core API to
		3863	provide a bare-bones event library. See C<ev.h> for details on what parts
		3864	of the API are still available, and do not complain if this subset changes
		3865	over time.
		3866
		3867	=item EV_NSIG
		3868
		3869	The highest supported signal number, +1 (or, the number of
		3870	signals): Normally, libev tries to deduce the maximum number of signals
		3871	automatically, but sometimes this fails, in which case it can be
		3872	specified. Also, using a lower number than detected (C<32> should be
		3873	good for about any system in existance) can save some memory, as libev
		3874	statically allocates some 12-24 bytes per signal number.
3663		3875
3664	=item EV_PID_HASHSIZE	3876	=item EV_PID_HASHSIZE
3665		3877
3666	C<ev_child> watchers use a small hash table to distribute workload by	3878	C<ev_child> watchers use a small hash table to distribute workload by
3667	pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more	3879	pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more
…		…
3853	default loop and triggering an C<ev_async> watcher from the default loop	4065	default loop and triggering an C<ev_async> watcher from the default loop
3854	watcher callback into the event loop interested in the signal.	4066	watcher callback into the event loop interested in the signal.
3855		4067
3856	=back	4068	=back
3857		4069
		4070	=head4 THREAD LOCKING EXAMPLE
		4071
		4072	Here is a fictitious example of how to run an event loop in a different
		4073	thread than where callbacks are being invoked and watchers are
		4074	created/added/removed.
		4075
		4076	For a real-world example, see the C<EV::Loop::Async> perl module,
		4077	which uses exactly this technique (which is suited for many high-level
		4078	languages).
		4079
		4080	The example uses a pthread mutex to protect the loop data, a condition
		4081	variable to wait for callback invocations, an async watcher to notify the
		4082	event loop thread and an unspecified mechanism to wake up the main thread.
		4083
		4084	First, you need to associate some data with the event loop:
		4085
		4086	typedef struct {
		4087	mutex_t lock; /* global loop lock */
		4088	ev_async async_w;
		4089	thread_t tid;
		4090	cond_t invoke_cv;
		4091	} userdata;
		4092
		4093	void prepare_loop (EV_P)
		4094	{
		4095	// for simplicity, we use a static userdata struct.
		4096	static userdata u;
		4097
		4098	ev_async_init (&u->async_w, async_cb);
		4099	ev_async_start (EV_A_ &u->async_w);
		4100
		4101	pthread_mutex_init (&u->lock, 0);
		4102	pthread_cond_init (&u->invoke_cv, 0);
		4103
		4104	// now associate this with the loop
		4105	ev_set_userdata (EV_A_ u);
		4106	ev_set_invoke_pending_cb (EV_A_ l_invoke);
		4107	ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
		4108
		4109	// then create the thread running ev_loop
		4110	pthread_create (&u->tid, 0, l_run, EV_A);
		4111	}
		4112
		4113	The callback for the C<ev_async> watcher does nothing: the watcher is used
		4114	solely to wake up the event loop so it takes notice of any new watchers
		4115	that might have been added:
		4116
		4117	static void
		4118	async_cb (EV_P_ ev_async *w, int revents)
		4119	{
		4120	// just used for the side effects
		4121	}
		4122
		4123	The C<l_release> and C<l_acquire> callbacks simply unlock/lock the mutex
		4124	protecting the loop data, respectively.
		4125
		4126	static void
		4127	l_release (EV_P)
		4128	{
		4129	userdata *u = ev_userdata (EV_A);
		4130	pthread_mutex_unlock (&u->lock);
		4131	}
		4132
		4133	static void
		4134	l_acquire (EV_P)
		4135	{
		4136	userdata *u = ev_userdata (EV_A);
		4137	pthread_mutex_lock (&u->lock);
		4138	}
		4139
		4140	The event loop thread first acquires the mutex, and then jumps straight
		4141	into C<ev_loop>:
		4142
		4143	void *
		4144	l_run (void *thr_arg)
		4145	{
		4146	struct ev_loop loop = (struct ev_loop )thr_arg;
		4147
		4148	l_acquire (EV_A);
		4149	pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
		4150	ev_loop (EV_A_ 0);
		4151	l_release (EV_A);
		4152
		4153	return 0;
		4154	}
		4155
		4156	Instead of invoking all pending watchers, the C<l_invoke> callback will
		4157	signal the main thread via some unspecified mechanism (signals? pipe
		4158	writes? C<Async::Interrupt>?) and then waits until all pending watchers
		4159	have been called (in a while loop because a) spurious wakeups are possible
		4160	and b) skipping inter-thread-communication when there are no pending
		4161	watchers is very beneficial):
		4162
		4163	static void
		4164	l_invoke (EV_P)
		4165	{
		4166	userdata *u = ev_userdata (EV_A);
		4167
		4168	while (ev_pending_count (EV_A))
		4169	{
		4170	wake_up_other_thread_in_some_magic_or_not_so_magic_way ();
		4171	pthread_cond_wait (&u->invoke_cv, &u->lock);
		4172	}
		4173	}
		4174
		4175	Now, whenever the main thread gets told to invoke pending watchers, it
		4176	will grab the lock, call C<ev_invoke_pending> and then signal the loop
		4177	thread to continue:
		4178
		4179	static void
		4180	real_invoke_pending (EV_P)
		4181	{
		4182	userdata *u = ev_userdata (EV_A);
		4183
		4184	pthread_mutex_lock (&u->lock);
		4185	ev_invoke_pending (EV_A);
		4186	pthread_cond_signal (&u->invoke_cv);
		4187	pthread_mutex_unlock (&u->lock);
		4188	}
		4189
		4190	Whenever you want to start/stop a watcher or do other modifications to an
		4191	event loop, you will now have to lock:
		4192
		4193	ev_timer timeout_watcher;
		4194	userdata *u = ev_userdata (EV_A);
		4195
		4196	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
		4197
		4198	pthread_mutex_lock (&u->lock);
		4199	ev_timer_start (EV_A_ &timeout_watcher);
		4200	ev_async_send (EV_A_ &u->async_w);
		4201	pthread_mutex_unlock (&u->lock);
		4202
		4203	Note that sending the C<ev_async> watcher is required because otherwise
		4204	an event loop currently blocking in the kernel will have no knowledge
		4205	about the newly added timer. By waking up the loop it will pick up any new
		4206	watchers in the next event loop iteration.
		4207
3858	=head3 COROUTINES	4208	=head3 COROUTINES
3859		4209
3860	Libev is very accommodating to coroutines ("cooperative threads"):	4210	Libev is very accommodating to coroutines ("cooperative threads"):
3861	libev fully supports nesting calls to its functions from different	4211	libev fully supports nesting calls to its functions from different
3862	coroutines (e.g. you can call C<ev_loop> on the same loop from two	4212	coroutines (e.g. you can call C<ev_loop> on the same loop from two
3863	different coroutines, and switch freely between both coroutines running the	4213	different coroutines, and switch freely between both coroutines running
3864	loop, as long as you don't confuse yourself). The only exception is that	4214	the loop, as long as you don't confuse yourself). The only exception is
3865	you must not do this from C<ev_periodic> reschedule callbacks.	4215	that you must not do this from C<ev_periodic> reschedule callbacks.
3866		4216
3867	Care has been taken to ensure that libev does not keep local state inside	4217	Care has been taken to ensure that libev does not keep local state inside
3868	C<ev_loop>, and other calls do not usually allow for coroutine switches as	4218	C<ev_loop>, and other calls do not usually allow for coroutine switches as
3869	they do not call any callbacks.	4219	they do not call any callbacks.
3870		4220
…		…
4077	=item C<double> must hold a time value in seconds with enough accuracy	4427	=item C<double> must hold a time value in seconds with enough accuracy
4078		4428
4079	The type C<double> is used to represent timestamps. It is required to	4429	The type C<double> is used to represent timestamps. It is required to
4080	have at least 51 bits of mantissa (and 9 bits of exponent), which is good	4430	have at least 51 bits of mantissa (and 9 bits of exponent), which is good
4081	enough for at least into the year 4000. This requirement is fulfilled by	4431	enough for at least into the year 4000. This requirement is fulfilled by
4082	implementations implementing IEEE 754 (basically all existing ones).	4432	implementations implementing IEEE 754, which is basically all existing
		4433	ones. With IEEE 754 doubles, you get microsecond accuracy until at least
		4434	2200.
4083		4435
4084	=back	4436	=back
4085		4437
4086	If you know of other additional requirements drop me a note.	4438	If you know of other additional requirements drop me a note.
4087		4439

Diff Legend

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

Comparing libev/ev.pod (file contents): Revision 1.245 by root, Tue Jun 30 06:24:38 2009 UTC vs. Revision 1.272 by root, Tue Nov 24 06:39:28 2009 UTC

Diff Legend

Comparing libev/ev.pod (file contents):
Revision 1.245 by root, Tue Jun 30 06:24:38 2009 UTC vs.
Revision 1.272 by root, Tue Nov 24 06:39:28 2009 UTC