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

Comparing libev/ev.pod (file contents):
Revision 1.239 by root, Tue Apr 21 14:14:19 2009 UTC vs.
Revision 1.259 by root, Sun Jul 19 01:36:34 2009 UTC

…		…
620	happily wraps around with enough iterations.	620	happily wraps around with enough iterations.
621		621
622	This value can sometimes be useful as a generation counter of sorts (it	622	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	623	"ticks" the number of loop iterations), as it roughly corresponds with
624	C<ev_prepare> and C<ev_check> calls.	624	C<ev_prepare> and C<ev_check> calls.
		625
		626	=item unsigned int ev_loop_depth (loop)
		627
		628	Returns the number of times C<ev_loop> was entered minus the number of
		629	times C<ev_loop> was exited, in other words, the recursion depth.
		630
		631	Outside C<ev_loop>, this number is zero. In a callback, this number is
		632	C<1>, unless C<ev_loop> was invoked recursively (or from another thread),
		633	in which case it is higher.
		634
		635	Leaving C<ev_loop> abnormally (setjmp/longjmp, cancelling the thread
		636	etc.), doesn't count as exit.
625		637
626	=item unsigned int ev_backend (loop)	638	=item unsigned int ev_backend (loop)
627		639
628	Returns one of the C<EVBACKEND_*> flags indicating the event backend in	640	Returns one of the C<EVBACKEND_*> flags indicating the event backend in
629	use.	641	use.
…		…
811		823
812	By setting a higher I<io collect interval> you allow libev to spend more	824	By setting a higher I<io collect interval> you allow libev to spend more
813	time collecting I/O events, so you can handle more events per iteration,	825	time collecting I/O events, so you can handle more events per iteration,
814	at the cost of increasing latency. Timeouts (both C<ev_periodic> and	826	at the cost of increasing latency. Timeouts (both C<ev_periodic> and
815	C<ev_timer>) will be not affected. Setting this to a non-null value will	827	C<ev_timer>) will be not affected. Setting this to a non-null value will
816	introduce an additional C<ev_sleep ()> call into most loop iterations.	828	introduce an additional C<ev_sleep ()> call into most loop iterations. The
		829	sleep time ensures that libev will not poll for I/O events more often then
		830	once per this interval, on average.
817		831
818	Likewise, by setting a higher I<timeout collect interval> you allow libev	832	Likewise, by setting a higher I<timeout collect interval> you allow libev
819	to spend more time collecting timeouts, at the expense of increased	833	to spend more time collecting timeouts, at the expense of increased
820	latency/jitter/inexactness (the watcher callback will be called	834	latency/jitter/inexactness (the watcher callback will be called
821	later). C<ev_io> watchers will not be affected. Setting this to a non-null	835	later). C<ev_io> watchers will not be affected. Setting this to a non-null
…		…
823		837
824	Many (busy) programs can usually benefit by setting the I/O collect	838	Many (busy) programs can usually benefit by setting the I/O collect
825	interval to a value near C<0.1> or so, which is often enough for	839	interval to a value near C<0.1> or so, which is often enough for
826	interactive servers (of course not for games), likewise for timeouts. It	840	interactive servers (of course not for games), likewise for timeouts. It
827	usually doesn't make much sense to set it to a lower value than C<0.01>,	841	usually doesn't make much sense to set it to a lower value than C<0.01>,
828	as this approaches the timing granularity of most systems.	842	as this approaches the timing granularity of most systems. Note that if
		843	you do transactions with the outside world and you can't increase the
		844	parallelity, then this setting will limit your transaction rate (if you
		845	need to poll once per transaction and the I/O collect interval is 0.01,
		846	then you can't do more than 100 transations per second).
829		847
830	Setting the I<timeout collect interval> can improve the opportunity for	848	Setting the I<timeout collect interval> can improve the opportunity for
831	saving power, as the program will "bundle" timer callback invocations that	849	saving power, as the program will "bundle" timer callback invocations that
832	are "near" in time together, by delaying some, thus reducing the number of	850	are "near" in time together, by delaying some, thus reducing the number of
833	times the process sleeps and wakes up again. Another useful technique to	851	times the process sleeps and wakes up again. Another useful technique to
834	reduce iterations/wake-ups is to use C<ev_periodic> watchers and make sure	852	reduce iterations/wake-ups is to use C<ev_periodic> watchers and make sure
835	they fire on, say, one-second boundaries only.	853	they fire on, say, one-second boundaries only.
		854
		855	Example: we only need 0.1s timeout granularity, and we wish not to poll
		856	more often than 100 times per second:
		857
		858	ev_set_timeout_collect_interval (EV_DEFAULT_UC_ 0.1);
		859	ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01);
		860
		861	=item ev_invoke_pending (loop)
		862
		863	This call will simply invoke all pending watchers while resetting their
		864	pending state. Normally, C<ev_loop> does this automatically when required,
		865	but when overriding the invoke callback this call comes handy.
		866
		867	=item int ev_pending_count (loop)
		868
		869	Returns the number of pending watchers - zero indicates that no watchers
		870	are pending.
		871
		872	=item ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P))
		873
		874	This overrides the invoke pending functionality of the loop: Instead of
		875	invoking all pending watchers when there are any, C<ev_loop> will call
		876	this callback instead. This is useful, for example, when you want to
		877	invoke the actual watchers inside another context (another thread etc.).
		878
		879	If you want to reset the callback, use C<ev_invoke_pending> as new
		880	callback.
		881
		882	=item ev_set_loop_release_cb (loop, void (release)(EV_P), void (acquire)(EV_P))
		883
		884	Sometimes you want to share the same loop between multiple threads. This
		885	can be done relatively simply by putting mutex_lock/unlock calls around
		886	each call to a libev function.
		887
		888	However, C<ev_loop> can run an indefinite time, so it is not feasible to
		889	wait for it to return. One way around this is to wake up the loop via
		890	C<ev_unloop> and C<av_async_send>, another way is to set these I<release>
		891	and I<acquire> callbacks on the loop.
		892
		893	When set, then C<release> will be called just before the thread is
		894	suspended waiting for new events, and C<acquire> is called just
		895	afterwards.
		896
		897	Ideally, C<release> will just call your mutex_unlock function, and
		898	C<acquire> will just call the mutex_lock function again.
		899
		900	While event loop modifications are allowed between invocations of
		901	C<release> and C<acquire> (that's their only purpose after all), no
		902	modifications done will affect the event loop, i.e. adding watchers will
		903	have no effect on the set of file descriptors being watched, or the time
		904	waited. USe an C<ev_async> watcher to wake up C<ev_loop> when you want it
		905	to take note of any changes you made.
		906
		907	In theory, threads executing C<ev_loop> will be async-cancel safe between
		908	invocations of C<release> and C<acquire>.
		909
		910	See also the locking example in the C<THREADS> section later in this
		911	document.
		912
		913	=item ev_set_userdata (loop, void *data)
		914
		915	=item ev_userdata (loop)
		916
		917	Set and retrieve a single C<void *> associated with a loop. When
		918	C<ev_set_userdata> has never been called, then C<ev_userdata> returns
		919	C<0.>
		920
		921	These two functions can be used to associate arbitrary data with a loop,
		922	and are intended solely for the C<invoke_pending_cb>, C<release> and
		923	C<acquire> callbacks described above, but of course can be (ab-)used for
		924	any other purpose as well.
836		925
837	=item ev_loop_verify (loop)	926	=item ev_loop_verify (loop)
838		927
839	This function only does something when C<EV_VERIFY> support has been	928	This function only does something when C<EV_VERIFY> support has been
840	compiled in, which is the default for non-minimal builds. It tries to go	929	compiled in, which is the default for non-minimal builds. It tries to go
…		…
1184	#include <stddef.h>	1273	#include <stddef.h>
1185		1274
1186	static void	1275	static void
1187	t1_cb (EV_P_ ev_timer *w, int revents)	1276	t1_cb (EV_P_ ev_timer *w, int revents)
1188	{	1277	{
1189	struct my_biggy big = (struct my_biggy *	1278	struct my_biggy big = (struct my_biggy *)
1190	(((char *)w) - offsetof (struct my_biggy, t1));	1279	(((char *)w) - offsetof (struct my_biggy, t1));
1191	}	1280	}
1192		1281
1193	static void	1282	static void
1194	t2_cb (EV_P_ ev_timer *w, int revents)	1283	t2_cb (EV_P_ ev_timer *w, int revents)
1195	{	1284	{
1196	struct my_biggy big = (struct my_biggy *	1285	struct my_biggy big = (struct my_biggy *)
1197	(((char *)w) - offsetof (struct my_biggy, t2));	1286	(((char *)w) - offsetof (struct my_biggy, t2));
1198	}	1287	}
1199		1288
1200	=head2 WATCHER PRIORITY MODELS	1289	=head2 WATCHER PRIORITY MODELS
1201		1290
…		…
1277	// with the default priority are receiving events.	1366	// with the default priority are receiving events.
1278	ev_idle_start (EV_A_ &idle);	1367	ev_idle_start (EV_A_ &idle);
1279	}	1368	}
1280		1369
1281	static void	1370	static void
1282	idle-cb (EV_P_ ev_idle *w, int revents)	1371	idle_cb (EV_P_ ev_idle *w, int revents)
1283	{	1372	{
1284	// actual processing	1373	// actual processing
1285	read (STDIN_FILENO, ...);	1374	read (STDIN_FILENO, ...);
1286		1375
1287	// have to start the I/O watcher again, as	1376	// have to start the I/O watcher again, as
…		…
1465	year, it will still time out after (roughly) one hour. "Roughly" because	1554	year, it will still time out after (roughly) one hour. "Roughly" because
1466	detecting time jumps is hard, and some inaccuracies are unavoidable (the	1555	detecting time jumps is hard, and some inaccuracies are unavoidable (the
1467	monotonic clock option helps a lot here).	1556	monotonic clock option helps a lot here).
1468		1557
1469	The callback is guaranteed to be invoked only I<after> its timeout has	1558	The callback is guaranteed to be invoked only I<after> its timeout has
1470	passed. If multiple timers become ready during the same loop iteration	1559	passed (not I<at>, so on systems with very low-resolution clocks this
1471	then the ones with earlier time-out values are invoked before ones with	1560	might introduce a small delay). If multiple timers become ready during the
1472	later time-out values (but this is no longer true when a callback calls	1561	same loop iteration then the ones with earlier time-out values are invoked
1473	C<ev_loop> recursively).	1562	before ones of the same priority with later time-out values (but this is
		1563	no longer true when a callback calls C<ev_loop> recursively).
1474		1564
1475	=head3 Be smart about timeouts	1565	=head3 Be smart about timeouts
1476		1566
1477	Many real-world problems involve some kind of timeout, usually for error	1567	Many real-world problems involve some kind of timeout, usually for error
1478	recovery. A typical example is an HTTP request - if the other side hangs,	1568	recovery. A typical example is an HTTP request - if the other side hangs,
…		…
1522	C<after> argument to C<ev_timer_set>, and only ever use the C<repeat>	1612	C<after> argument to C<ev_timer_set>, and only ever use the C<repeat>
1523	member and C<ev_timer_again>.	1613	member and C<ev_timer_again>.
1524		1614
1525	At start:	1615	At start:
1526		1616
1527	ev_timer_init (timer, callback);	1617	ev_init (timer, callback);
1528	timer->repeat = 60.;	1618	timer->repeat = 60.;
1529	ev_timer_again (loop, timer);	1619	ev_timer_again (loop, timer);
1530		1620
1531	Each time there is some activity:	1621	Each time there is some activity:
1532		1622
…		…
1594		1684
1595	To start the timer, simply initialise the watcher and set C<last_activity>	1685	To start the timer, simply initialise the watcher and set C<last_activity>
1596	to the current time (meaning we just have some activity :), then call the	1686	to the current time (meaning we just have some activity :), then call the
1597	callback, which will "do the right thing" and start the timer:	1687	callback, which will "do the right thing" and start the timer:
1598		1688
1599	ev_timer_init (timer, callback);	1689	ev_init (timer, callback);
1600	last_activity = ev_now (loop);	1690	last_activity = ev_now (loop);
1601	callback (loop, timer, EV_TIMEOUT);	1691	callback (loop, timer, EV_TIMEOUT);
1602		1692
1603	And when there is some activity, simply store the current time in	1693	And when there is some activity, simply store the current time in
1604	C<last_activity>, no libev calls at all:	1694	C<last_activity>, no libev calls at all:
…		…
1665		1755
1666	If the event loop is suspended for a long time, you can also force an	1756	If the event loop is suspended for a long time, you can also force an
1667	update of the time returned by C<ev_now ()> by calling C<ev_now_update	1757	update of the time returned by C<ev_now ()> by calling C<ev_now_update
1668	()>.	1758	()>.
1669		1759
		1760	=head3 The special problems of suspended animation
		1761
		1762	When you leave the server world it is quite customary to hit machines that
		1763	can suspend/hibernate - what happens to the clocks during such a suspend?
		1764
		1765	Some quick tests made with a Linux 2.6.28 indicate that a suspend freezes
		1766	all processes, while the clocks (C<times>, C<CLOCK_MONOTONIC>) continue
		1767	to run until the system is suspended, but they will not advance while the
		1768	system is suspended. That means, on resume, it will be as if the program
		1769	was frozen for a few seconds, but the suspend time will not be counted
		1770	towards C<ev_timer> when a monotonic clock source is used. The real time
		1771	clock advanced as expected, but if it is used as sole clocksource, then a
		1772	long suspend would be detected as a time jump by libev, and timers would
		1773	be adjusted accordingly.
		1774
		1775	I would not be surprised to see different behaviour in different between
		1776	operating systems, OS versions or even different hardware.
		1777
		1778	The other form of suspend (job control, or sending a SIGSTOP) will see a
		1779	time jump in the monotonic clocks and the realtime clock. If the program
		1780	is suspended for a very long time, and monotonic clock sources are in use,
		1781	then you can expect C<ev_timer>s to expire as the full suspension time
		1782	will be counted towards the timers. When no monotonic clock source is in
		1783	use, then libev will again assume a timejump and adjust accordingly.
		1784
		1785	It might be beneficial for this latter case to call C<ev_suspend>
		1786	and C<ev_resume> in code that handles C<SIGTSTP>, to at least get
		1787	deterministic behaviour in this case (you can do nothing against
		1788	C<SIGSTOP>).
		1789
1670	=head3 Watcher-Specific Functions and Data Members	1790	=head3 Watcher-Specific Functions and Data Members
1671		1791
1672	=over 4	1792	=over 4
1673		1793
1674	=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)	1794	=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
…		…
1699	If the timer is repeating, either start it if necessary (with the	1819	If the timer is repeating, either start it if necessary (with the
1700	C<repeat> value), or reset the running timer to the C<repeat> value.	1820	C<repeat> value), or reset the running timer to the C<repeat> value.
1701		1821
1702	This sounds a bit complicated, see L<Be smart about timeouts>, above, for a	1822	This sounds a bit complicated, see L<Be smart about timeouts>, above, for a
1703	usage example.	1823	usage example.
		1824
		1825	=item ev_timer_remaining (loop, ev_timer *)
		1826
		1827	Returns the remaining time until a timer fires. If the timer is active,
		1828	then this time is relative to the current event loop time, otherwise it's
		1829	the timeout value currently configured.
		1830
		1831	That is, after an C<ev_timer_set (w, 5, 7)>, C<ev_timer_remaining> returns
		1832	C<5>. When the timer is started and one second passes, C<ev_timer_remain>
		1833	will return C<4>. When the timer expires and is restarted, it will return
		1834	roughly C<7> (likely slightly less as callback invocation takes some time,
		1835	too), and so on.
1704		1836
1705	=item ev_tstamp repeat [read-write]	1837	=item ev_tstamp repeat [read-write]
1706		1838
1707	The current C<repeat> value. Will be used each time the watcher times out	1839	The current C<repeat> value. Will be used each time the watcher times out
1708	or C<ev_timer_again> is called, and determines the next timeout (if any),	1840	or C<ev_timer_again> is called, and determines the next timeout (if any),
…		…
1944	Signal watchers will trigger an event when the process receives a specific	2076	Signal watchers will trigger an event when the process receives a specific
1945	signal one or more times. Even though signals are very asynchronous, libev	2077	signal one or more times. Even though signals are very asynchronous, libev
1946	will try it's best to deliver signals synchronously, i.e. as part of the	2078	will try it's best to deliver signals synchronously, i.e. as part of the
1947	normal event processing, like any other event.	2079	normal event processing, like any other event.
1948		2080
		2081	Note that only the default loop supports registering signal watchers
		2082	currently.
		2083
1949	If you want signals asynchronously, just use C<sigaction> as you would	2084	If you want signals asynchronously, just use C<sigaction> as you would
1950	do without libev and forget about sharing the signal. You can even use	2085	do without libev and forget about sharing the signal. You can even use
1951	C<ev_async> from a signal handler to synchronously wake up an event loop.	2086	C<ev_async> from a signal handler to synchronously wake up an event loop.
1952		2087
1953	You can configure as many watchers as you like per signal. Only when the	2088	You can configure as many watchers as you like per signal. Only when the
1954	first watcher gets started will libev actually register a signal handler	2089	first watcher gets started will libev actually register something with
1955	with the kernel (thus it coexists with your own signal handlers as long as	2090	the kernel (thus it coexists with your own signal handlers as long as you
1956	you don't register any with libev for the same signal). Similarly, when	2091	don't register any with libev for the same signal).
1957	the last signal watcher for a signal is stopped, libev will reset the	2092
1958	signal handler to SIG_DFL (regardless of what it was set to before).	2093	Both the signal mask state (C<sigprocmask>) and the signal handler state
		2094	(C<sigaction>) are unspecified after starting a signal watcher (and after
		2095	sotpping it again), that is, libev might or might not block the signal,
		2096	and might or might not set or restore the installed signal handler.
1959		2097
1960	If possible and supported, libev will install its handlers with	2098	If possible and supported, libev will install its handlers with
1961	C<SA_RESTART> behaviour enabled, so system calls should not be unduly	2099	C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should
1962	interrupted. If you have a problem with system calls getting interrupted by	2100	not be unduly interrupted. If you have a problem with system calls getting
1963	signals you can block all signals in an C<ev_check> watcher and unblock	2101	interrupted by signals you can block all signals in an C<ev_check> watcher
1964	them in an C<ev_prepare> watcher.	2102	and unblock them in an C<ev_prepare> watcher.
1965		2103
1966	=head3 Watcher-Specific Functions and Data Members	2104	=head3 Watcher-Specific Functions and Data Members
1967		2105
1968	=over 4	2106	=over 4
1969		2107
…		…
2001	some child status changes (most typically when a child of yours dies or	2139	some child status changes (most typically when a child of yours dies or
2002	exits). It is permissible to install a child watcher I<after> the child	2140	exits). It is permissible to install a child watcher I<after> the child
2003	has been forked (which implies it might have already exited), as long	2141	has been forked (which implies it might have already exited), as long
2004	as the event loop isn't entered (or is continued from a watcher), i.e.,	2142	as the event loop isn't entered (or is continued from a watcher), i.e.,
2005	forking and then immediately registering a watcher for the child is fine,	2143	forking and then immediately registering a watcher for the child is fine,
2006	but forking and registering a watcher a few event loop iterations later is	2144	but forking and registering a watcher a few event loop iterations later or
2007	not.	2145	in the next callback invocation is not.
2008		2146
2009	Only the default event loop is capable of handling signals, and therefore	2147	Only the default event loop is capable of handling signals, and therefore
2010	you can only register child watchers in the default event loop.	2148	you can only register child watchers in the default event loop.
2011		2149
		2150	Due to some design glitches inside libev, child watchers will always be
		2151	handled at maximum priority (their priority is set to C<EV_MAXPRI> by
		2152	libev)
		2153
2012	=head3 Process Interaction	2154	=head3 Process Interaction
2013		2155
2014	Libev grabs C<SIGCHLD> as soon as the default event loop is	2156	Libev grabs C<SIGCHLD> as soon as the default event loop is
2015	initialised. This is necessary to guarantee proper behaviour even if	2157	initialised. This is necessary to guarantee proper behaviour even if the
2016	the first child watcher is started after the child exits. The occurrence	2158	first child watcher is started after the child exits. The occurrence
2017	of C<SIGCHLD> is recorded asynchronously, but child reaping is done	2159	of C<SIGCHLD> is recorded asynchronously, but child reaping is done
2018	synchronously as part of the event loop processing. Libev always reaps all	2160	synchronously as part of the event loop processing. Libev always reaps all
2019	children, even ones not watched.	2161	children, even ones not watched.
2020		2162
2021	=head3 Overriding the Built-In Processing	2163	=head3 Overriding the Built-In Processing
…		…
2031	=head3 Stopping the Child Watcher	2173	=head3 Stopping the Child Watcher
2032		2174
2033	Currently, the child watcher never gets stopped, even when the	2175	Currently, the child watcher never gets stopped, even when the
2034	child terminates, so normally one needs to stop the watcher in the	2176	child terminates, so normally one needs to stop the watcher in the
2035	callback. Future versions of libev might stop the watcher automatically	2177	callback. Future versions of libev might stop the watcher automatically
2036	when a child exit is detected.	2178	when a child exit is detected (calling C<ev_child_stop> twice is not a
		2179	problem).
2037		2180
2038	=head3 Watcher-Specific Functions and Data Members	2181	=head3 Watcher-Specific Functions and Data Members
2039		2182
2040	=over 4	2183	=over 4
2041		2184
…		…
2367	// no longer anything immediate to do.	2510	// no longer anything immediate to do.
2368	}	2511	}
2369		2512
2370	ev_idle *idle_watcher = malloc (sizeof (ev_idle));	2513	ev_idle *idle_watcher = malloc (sizeof (ev_idle));
2371	ev_idle_init (idle_watcher, idle_cb);	2514	ev_idle_init (idle_watcher, idle_cb);
2372	ev_idle_start (loop, idle_cb);	2515	ev_idle_start (loop, idle_watcher);
2373		2516
2374		2517
2375	=head2 C<ev_prepare> and C<ev_check> - customise your event loop!	2518	=head2 C<ev_prepare> and C<ev_check> - customise your event loop!
2376		2519
2377	Prepare and check watchers are usually (but not always) used in pairs:	2520	Prepare and check watchers are usually (but not always) used in pairs:
…		…
2470	struct pollfd fds [nfd];	2613	struct pollfd fds [nfd];
2471	// actual code will need to loop here and realloc etc.	2614	// actual code will need to loop here and realloc etc.
2472	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));	2615	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
2473		2616
2474	/* the callback is illegal, but won't be called as we stop during check */	2617	/* the callback is illegal, but won't be called as we stop during check */
2475	ev_timer_init (&tw, 0, timeout * 1e-3);	2618	ev_timer_init (&tw, 0, timeout * 1e-3, 0.);
2476	ev_timer_start (loop, &tw);	2619	ev_timer_start (loop, &tw);
2477		2620
2478	// create one ev_io per pollfd	2621	// create one ev_io per pollfd
2479	for (int i = 0; i < nfd; ++i)	2622	for (int i = 0; i < nfd; ++i)
2480	{	2623	{
…		…
3642	defined to be C<0>, then they are not.	3785	defined to be C<0>, then they are not.
3643		3786
3644	=item EV_MINIMAL	3787	=item EV_MINIMAL
3645		3788
3646	If you need to shave off some kilobytes of code at the expense of some	3789	If you need to shave off some kilobytes of code at the expense of some
3647	speed, define this symbol to C<1>. Currently this is used to override some	3790	speed (but with the full API), define this symbol to C<1>. Currently this
3648	inlining decisions, saves roughly 30% code size on amd64. It also selects a	3791	is used to override some inlining decisions, saves roughly 30% code size
3649	much smaller 2-heap for timer management over the default 4-heap.	3792	on amd64. It also selects a much smaller 2-heap for timer management over
		3793	the default 4-heap.
		3794
		3795	You can save even more by disabling watcher types you do not need
		3796	and setting C<EV_MAXPRI> == C<EV_MINPRI>. Also, disabling C<assert>
		3797	(C<-DNDEBUG>) will usually reduce code size a lot.
		3798
		3799	Defining C<EV_MINIMAL> to C<2> will additionally reduce the core API to
		3800	provide a bare-bones event library. See C<ev.h> for details on what parts
		3801	of the API are still available, and do not complain if this subset changes
		3802	over time.
3650		3803
3651	=item EV_PID_HASHSIZE	3804	=item EV_PID_HASHSIZE
3652		3805
3653	C<ev_child> watchers use a small hash table to distribute workload by	3806	C<ev_child> watchers use a small hash table to distribute workload by
3654	pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more	3807	pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more
…		…
3840	default loop and triggering an C<ev_async> watcher from the default loop	3993	default loop and triggering an C<ev_async> watcher from the default loop
3841	watcher callback into the event loop interested in the signal.	3994	watcher callback into the event loop interested in the signal.
3842		3995
3843	=back	3996	=back
3844		3997
		3998	=head4 THREAD LOCKING EXAMPLE
		3999
		4000	Here is a fictitious example of how to run an event loop in a different
		4001	thread than where callbacks are being invoked and watchers are
		4002	created/added/removed.
		4003
		4004	For a real-world example, see the C<EV::Loop::Async> perl module,
		4005	which uses exactly this technique (which is suited for many high-level
		4006	languages).
		4007
		4008	The example uses a pthread mutex to protect the loop data, a condition
		4009	variable to wait for callback invocations, an async watcher to notify the
		4010	event loop thread and an unspecified mechanism to wake up the main thread.
		4011
		4012	First, you need to associate some data with the event loop:
		4013
		4014	typedef struct {
		4015	mutex_t lock; /* global loop lock */
		4016	ev_async async_w;
		4017	thread_t tid;
		4018	cond_t invoke_cv;
		4019	} userdata;
		4020
		4021	void prepare_loop (EV_P)
		4022	{
		4023	// for simplicity, we use a static userdata struct.
		4024	static userdata u;
		4025
		4026	ev_async_init (&u->async_w, async_cb);
		4027	ev_async_start (EV_A_ &u->async_w);
		4028
		4029	pthread_mutex_init (&u->lock, 0);
		4030	pthread_cond_init (&u->invoke_cv, 0);
		4031
		4032	// now associate this with the loop
		4033	ev_set_userdata (EV_A_ u);
		4034	ev_set_invoke_pending_cb (EV_A_ l_invoke);
		4035	ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
		4036
		4037	// then create the thread running ev_loop
		4038	pthread_create (&u->tid, 0, l_run, EV_A);
		4039	}
		4040
		4041	The callback for the C<ev_async> watcher does nothing: the watcher is used
		4042	solely to wake up the event loop so it takes notice of any new watchers
		4043	that might have been added:
		4044
		4045	static void
		4046	async_cb (EV_P_ ev_async *w, int revents)
		4047	{
		4048	// just used for the side effects
		4049	}
		4050
		4051	The C<l_release> and C<l_acquire> callbacks simply unlock/lock the mutex
		4052	protecting the loop data, respectively.
		4053
		4054	static void
		4055	l_release (EV_P)
		4056	{
		4057	userdata *u = ev_userdata (EV_A);
		4058	pthread_mutex_unlock (&u->lock);
		4059	}
		4060
		4061	static void
		4062	l_acquire (EV_P)
		4063	{
		4064	userdata *u = ev_userdata (EV_A);
		4065	pthread_mutex_lock (&u->lock);
		4066	}
		4067
		4068	The event loop thread first acquires the mutex, and then jumps straight
		4069	into C<ev_loop>:
		4070
		4071	void *
		4072	l_run (void *thr_arg)
		4073	{
		4074	struct ev_loop loop = (struct ev_loop )thr_arg;
		4075
		4076	l_acquire (EV_A);
		4077	pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
		4078	ev_loop (EV_A_ 0);
		4079	l_release (EV_A);
		4080
		4081	return 0;
		4082	}
		4083
		4084	Instead of invoking all pending watchers, the C<l_invoke> callback will
		4085	signal the main thread via some unspecified mechanism (signals? pipe
		4086	writes? C<Async::Interrupt>?) and then waits until all pending watchers
		4087	have been called (in a while loop because a) spurious wakeups are possible
		4088	and b) skipping inter-thread-communication when there are no pending
		4089	watchers is very beneficial):
		4090
		4091	static void
		4092	l_invoke (EV_P)
		4093	{
		4094	userdata *u = ev_userdata (EV_A);
		4095
		4096	while (ev_pending_count (EV_A))
		4097	{
		4098	wake_up_other_thread_in_some_magic_or_not_so_magic_way ();
		4099	pthread_cond_wait (&u->invoke_cv, &u->lock);
		4100	}
		4101	}
		4102
		4103	Now, whenever the main thread gets told to invoke pending watchers, it
		4104	will grab the lock, call C<ev_invoke_pending> and then signal the loop
		4105	thread to continue:
		4106
		4107	static void
		4108	real_invoke_pending (EV_P)
		4109	{
		4110	userdata *u = ev_userdata (EV_A);
		4111
		4112	pthread_mutex_lock (&u->lock);
		4113	ev_invoke_pending (EV_A);
		4114	pthread_cond_signal (&u->invoke_cv);
		4115	pthread_mutex_unlock (&u->lock);
		4116	}
		4117
		4118	Whenever you want to start/stop a watcher or do other modifications to an
		4119	event loop, you will now have to lock:
		4120
		4121	ev_timer timeout_watcher;
		4122	userdata *u = ev_userdata (EV_A);
		4123
		4124	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
		4125
		4126	pthread_mutex_lock (&u->lock);
		4127	ev_timer_start (EV_A_ &timeout_watcher);
		4128	ev_async_send (EV_A_ &u->async_w);
		4129	pthread_mutex_unlock (&u->lock);
		4130
		4131	Note that sending the C<ev_async> watcher is required because otherwise
		4132	an event loop currently blocking in the kernel will have no knowledge
		4133	about the newly added timer. By waking up the loop it will pick up any new
		4134	watchers in the next event loop iteration.
		4135
3845	=head3 COROUTINES	4136	=head3 COROUTINES
3846		4137
3847	Libev is very accommodating to coroutines ("cooperative threads"):	4138	Libev is very accommodating to coroutines ("cooperative threads"):
3848	libev fully supports nesting calls to its functions from different	4139	libev fully supports nesting calls to its functions from different
3849	coroutines (e.g. you can call C<ev_loop> on the same loop from two	4140	coroutines (e.g. you can call C<ev_loop> on the same loop from two
3850	different coroutines, and switch freely between both coroutines running the	4141	different coroutines, and switch freely between both coroutines running
3851	loop, as long as you don't confuse yourself). The only exception is that	4142	the loop, as long as you don't confuse yourself). The only exception is
3852	you must not do this from C<ev_periodic> reschedule callbacks.	4143	that you must not do this from C<ev_periodic> reschedule callbacks.
3853		4144
3854	Care has been taken to ensure that libev does not keep local state inside	4145	Care has been taken to ensure that libev does not keep local state inside
3855	C<ev_loop>, and other calls do not usually allow for coroutine switches as	4146	C<ev_loop>, and other calls do not usually allow for coroutine switches as
3856	they do not call any callbacks.	4147	they do not call any callbacks.
3857		4148
…		…
3934	way (note also that glib is the slowest event library known to man).	4225	way (note also that glib is the slowest event library known to man).
3935		4226
3936	There is no supported compilation method available on windows except	4227	There is no supported compilation method available on windows except
3937	embedding it into other applications.	4228	embedding it into other applications.
3938		4229
		4230	Sensible signal handling is officially unsupported by Microsoft - libev
		4231	tries its best, but under most conditions, signals will simply not work.
		4232
3939	Not a libev limitation but worth mentioning: windows apparently doesn't	4233	Not a libev limitation but worth mentioning: windows apparently doesn't
3940	accept large writes: instead of resulting in a partial write, windows will	4234	accept large writes: instead of resulting in a partial write, windows will
3941	either accept everything or return C<ENOBUFS> if the buffer is too large,	4235	either accept everything or return C<ENOBUFS> if the buffer is too large,
3942	so make sure you only write small amounts into your sockets (less than a	4236	so make sure you only write small amounts into your sockets (less than a
3943	megabyte seems safe, but this apparently depends on the amount of memory	4237	megabyte seems safe, but this apparently depends on the amount of memory
…		…
3947	the abysmal performance of winsockets, using a large number of sockets	4241	the abysmal performance of winsockets, using a large number of sockets
3948	is not recommended (and not reasonable). If your program needs to use	4242	is not recommended (and not reasonable). If your program needs to use
3949	more than a hundred or so sockets, then likely it needs to use a totally	4243	more than a hundred or so sockets, then likely it needs to use a totally
3950	different implementation for windows, as libev offers the POSIX readiness	4244	different implementation for windows, as libev offers the POSIX readiness
3951	notification model, which cannot be implemented efficiently on windows	4245	notification model, which cannot be implemented efficiently on windows
3952	(Microsoft monopoly games).	4246	(due to Microsoft monopoly games).
3953		4247
3954	A typical way to use libev under windows is to embed it (see the embedding	4248	A typical way to use libev under windows is to embed it (see the embedding
3955	section for details) and use the following F<evwrap.h> header file instead	4249	section for details) and use the following F<evwrap.h> header file instead
3956	of F<ev.h>:	4250	of F<ev.h>:
3957		4251
…		…
3993		4287
3994	Early versions of winsocket's select only supported waiting for a maximum	4288	Early versions of winsocket's select only supported waiting for a maximum
3995	of C<64> handles (probably owning to the fact that all windows kernels	4289	of C<64> handles (probably owning to the fact that all windows kernels
3996	can only wait for C<64> things at the same time internally; Microsoft	4290	can only wait for C<64> things at the same time internally; Microsoft
3997	recommends spawning a chain of threads and wait for 63 handles and the	4291	recommends spawning a chain of threads and wait for 63 handles and the
3998	previous thread in each. Great).	4292	previous thread in each. Sounds great!).
3999		4293
4000	Newer versions support more handles, but you need to define C<FD_SETSIZE>	4294	Newer versions support more handles, but you need to define C<FD_SETSIZE>
4001	to some high number (e.g. C<2048>) before compiling the winsocket select	4295	to some high number (e.g. C<2048>) before compiling the winsocket select
4002	call (which might be in libev or elsewhere, for example, perl does its own	4296	call (which might be in libev or elsewhere, for example, perl and many
4003	select emulation on windows).	4297	other interpreters do their own select emulation on windows).
4004		4298
4005	Another limit is the number of file descriptors in the Microsoft runtime	4299	Another limit is the number of file descriptors in the Microsoft runtime
4006	libraries, which by default is C<64> (there must be a hidden I<64> fetish	4300	libraries, which by default is C<64> (there must be a hidden I<64>
4007	or something like this inside Microsoft). You can increase this by calling	4301	fetish or something like this inside Microsoft). You can increase this
4008	C<_setmaxstdio>, which can increase this limit to C<2048> (another	4302	by calling C<_setmaxstdio>, which can increase this limit to C<2048>
4009	arbitrary limit), but is broken in many versions of the Microsoft runtime	4303	(another arbitrary limit), but is broken in many versions of the Microsoft
4010	libraries.
4011
4012	This might get you to about C<512> or C<2048> sockets (depending on	4304	runtime libraries. This might get you to about C<512> or C<2048> sockets
4013	windows version and/or the phase of the moon). To get more, you need to	4305	(depending on windows version and/or the phase of the moon). To get more,
4014	wrap all I/O functions and provide your own fd management, but the cost of	4306	you need to wrap all I/O functions and provide your own fd management, but
4015	calling select (O(n²)) will likely make this unworkable.	4307	the cost of calling select (O(n²)) will likely make this unworkable.
4016		4308
4017	=back	4309	=back
4018		4310
4019	=head2 PORTABILITY REQUIREMENTS	4311	=head2 PORTABILITY REQUIREMENTS
4020		4312
…		…
4063	=item C<double> must hold a time value in seconds with enough accuracy	4355	=item C<double> must hold a time value in seconds with enough accuracy
4064		4356
4065	The type C<double> is used to represent timestamps. It is required to	4357	The type C<double> is used to represent timestamps. It is required to
4066	have at least 51 bits of mantissa (and 9 bits of exponent), which is good	4358	have at least 51 bits of mantissa (and 9 bits of exponent), which is good
4067	enough for at least into the year 4000. This requirement is fulfilled by	4359	enough for at least into the year 4000. This requirement is fulfilled by
4068	implementations implementing IEEE 754 (basically all existing ones).	4360	implementations implementing IEEE 754, which is basically all existing
		4361	ones. With IEEE 754 doubles, you get microsecond accuracy until at least
		4362	2200.
4069		4363
4070	=back	4364	=back
4071		4365
4072	If you know of other additional requirements drop me a note.	4366	If you know of other additional requirements drop me a note.
4073		4367

Diff Legend

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

Comparing libev/ev.pod (file contents): Revision 1.239 by root, Tue Apr 21 14:14:19 2009 UTC vs. Revision 1.259 by root, Sun Jul 19 01:36:34 2009 UTC

Diff Legend

Comparing libev/ev.pod (file contents):
Revision 1.239 by root, Tue Apr 21 14:14:19 2009 UTC vs.
Revision 1.259 by root, Sun Jul 19 01:36:34 2009 UTC