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

Comparing libev/ev.pod (file contents):
Revision 1.62 by root, Thu Nov 29 17:28:13 2007 UTC vs.
Revision 1.67 by root, Fri Dec 7 16:44:12 2007 UTC

…		…
274	a fork, you can also make libev check for a fork in each iteration by	274	a fork, you can also make libev check for a fork in each iteration by
275	enabling this flag.	275	enabling this flag.
276		276
277	This works by calling C<getpid ()> on every iteration of the loop,	277	This works by calling C<getpid ()> on every iteration of the loop,
278	and thus this might slow down your event loop if you do a lot of loop	278	and thus this might slow down your event loop if you do a lot of loop
279	iterations and little real work, but is usually not noticable (on my	279	iterations and little real work, but is usually not noticeable (on my
280	Linux system for example, C<getpid> is actually a simple 5-insn sequence	280	Linux system for example, C<getpid> is actually a simple 5-insn sequence
281	without a syscall and thus I<very> fast, but my Linux system also has	281	without a syscall and thus I<very> fast, but my Linux system also has
282	C<pthread_atfork> which is even faster).	282	C<pthread_atfork> which is even faster).
283		283
284	The big advantage of this flag is that you can forget about fork (and	284	The big advantage of this flag is that you can forget about fork (and
…		…
429	=item ev_loop_fork (loop)	429	=item ev_loop_fork (loop)
430		430
431	Like C<ev_default_fork>, but acts on an event loop created by	431	Like C<ev_default_fork>, but acts on an event loop created by
432	C<ev_loop_new>. Yes, you have to call this on every allocated event loop	432	C<ev_loop_new>. Yes, you have to call this on every allocated event loop
433	after fork, and how you do this is entirely your own problem.	433	after fork, and how you do this is entirely your own problem.
		434
		435	=item unsigned int ev_loop_count (loop)
		436
		437	Returns the count of loop iterations for the loop, which is identical to
		438	the number of times libev did poll for new events. It starts at C<0> and
		439	happily wraps around with enough iterations.
		440
		441	This value can sometimes be useful as a generation counter of sorts (it
		442	"ticks" the number of loop iterations), as it roughly corresponds with
		443	C<ev_prepare> and C<ev_check> calls.
434		444
435	=item unsigned int ev_backend (loop)	445	=item unsigned int ev_backend (loop)
436		446
437	Returns one of the C<EVBACKEND_*> flags indicating the event backend in	447	Returns one of the C<EVBACKEND_*> flags indicating the event backend in
438	use.	448	use.
…		…
734	=item ev_cb_set (ev_TYPE *watcher, callback)	744	=item ev_cb_set (ev_TYPE *watcher, callback)
735		745
736	Change the callback. You can change the callback at virtually any time	746	Change the callback. You can change the callback at virtually any time
737	(modulo threads).	747	(modulo threads).
738		748
		749	=item ev_set_priority (ev_TYPE *watcher, priority)
		750
		751	=item int ev_priority (ev_TYPE *watcher)
		752
		753	Set and query the priority of the watcher. The priority is a small
		754	integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>
		755	(default: C<-2>). Pending watchers with higher priority will be invoked
		756	before watchers with lower priority, but priority will not keep watchers
		757	from being executed (except for C<ev_idle> watchers).
		758
		759	This means that priorities are I<only> used for ordering callback
		760	invocation after new events have been received. This is useful, for
		761	example, to reduce latency after idling, or more often, to bind two
		762	watchers on the same event and make sure one is called first.
		763
		764	If you need to suppress invocation when higher priority events are pending
		765	you need to look at C<ev_idle> watchers, which provide this functionality.
		766
		767	The default priority used by watchers when no priority has been set is
		768	always C<0>, which is supposed to not be too high and not be too low :).
		769
		770	Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is
		771	fine, as long as you do not mind that the priority value you query might
		772	or might not have been adjusted to be within valid range.
		773
739	=back	774	=back
740		775
741		776
742	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER	777	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
743		778
…		…
1341	ev_stat_start (loop, &passwd);	1376	ev_stat_start (loop, &passwd);
1342		1377
1343		1378
1344	=head2 C<ev_idle> - when you've got nothing better to do...	1379	=head2 C<ev_idle> - when you've got nothing better to do...
1345		1380
1346	Idle watchers trigger events when there are no other events are pending	1381	Idle watchers trigger events when no other events of the same or higher
1347	(prepare, check and other idle watchers do not count). That is, as long	1382	priority are pending (prepare, check and other idle watchers do not
1348	as your process is busy handling sockets or timeouts (or even signals,	1383	count).
1349	imagine) it will not be triggered. But when your process is idle all idle	1384
1350	watchers are being called again and again, once per event loop iteration -	1385	That is, as long as your process is busy handling sockets or timeouts
		1386	(or even signals, imagine) of the same or higher priority it will not be
		1387	triggered. But when your process is idle (or only lower-priority watchers
		1388	are pending), the idle watchers are being called once per event loop
1351	until stopped, that is, or your process receives more events and becomes	1389	iteration - until stopped, that is, or your process receives more events
1352	busy.	1390	and becomes busy again with higher priority stuff.
1353		1391
1354	The most noteworthy effect is that as long as any idle watchers are	1392	The most noteworthy effect is that as long as any idle watchers are
1355	active, the process will not block when waiting for new events.	1393	active, the process will not block when waiting for new events.
1356		1394
1357	Apart from keeping your process non-blocking (which is a useful	1395	Apart from keeping your process non-blocking (which is a useful
…		…
1457		1495
1458	// create io watchers for each fd and a timer before blocking	1496	// create io watchers for each fd and a timer before blocking
1459	static void	1497	static void
1460	adns_prepare_cb (ev_loop loop, ev_prepare w, int revents)	1498	adns_prepare_cb (ev_loop loop, ev_prepare w, int revents)
1461	{	1499	{
1462	int timeout = 3600000;truct pollfd fds [nfd];	1500	int timeout = 3600000;
		1501	struct pollfd fds [nfd];
1463	// actual code will need to loop here and realloc etc.	1502	// actual code will need to loop here and realloc etc.
1464	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));	1503	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
1465		1504
1466	/* the callback is illegal, but won't be called as we stop during check */	1505	/* the callback is illegal, but won't be called as we stop during check */
1467	ev_timer_init (&tw, 0, timeout * 1e-3);	1506	ev_timer_init (&tw, 0, timeout * 1e-3);
…		…
1848	Similar to the other two macros, this gives you the value of the default	1887	Similar to the other two macros, this gives you the value of the default
1849	loop, if multiple loops are supported ("ev loop default").	1888	loop, if multiple loops are supported ("ev loop default").
1850		1889
1851	=back	1890	=back
1852		1891
1853	Example: Declare and initialise a check watcher, working regardless of	1892	Example: Declare and initialise a check watcher, utilising the above
1854	wether multiple loops are supported or not.	1893	macros so it will work regardless of wether multiple loops are supported
		1894	or not.
1855		1895
1856	static void	1896	static void
1857	check_cb (EV_P_ ev_timer *w, int revents)	1897	check_cb (EV_P_ ev_timer *w, int revents)
1858	{	1898	{
1859	ev_check_stop (EV_A_ w);	1899	ev_check_stop (EV_A_ w);
…		…
1861		1901
1862	ev_check check;	1902	ev_check check;
1863	ev_check_init (&check, check_cb);	1903	ev_check_init (&check, check_cb);
1864	ev_check_start (EV_DEFAULT_ &check);	1904	ev_check_start (EV_DEFAULT_ &check);
1865	ev_loop (EV_DEFAULT_ 0);	1905	ev_loop (EV_DEFAULT_ 0);
1866
1867		1906
1868	=head1 EMBEDDING	1907	=head1 EMBEDDING
1869		1908
1870	Libev can (and often is) directly embedded into host	1909	Libev can (and often is) directly embedded into host
1871	applications. Examples of applications that embed it include the Deliantra	1910	applications. Examples of applications that embed it include the Deliantra
…		…
1911	ev_vars.h	1950	ev_vars.h
1912	ev_wrap.h	1951	ev_wrap.h
1913		1952
1914	ev_win32.c required on win32 platforms only	1953	ev_win32.c required on win32 platforms only
1915		1954
1916	ev_select.c only when select backend is enabled (which is by default)	1955	ev_select.c only when select backend is enabled (which is enabled by default)
1917	ev_poll.c only when poll backend is enabled (disabled by default)	1956	ev_poll.c only when poll backend is enabled (disabled by default)
1918	ev_epoll.c only when the epoll backend is enabled (disabled by default)	1957	ev_epoll.c only when the epoll backend is enabled (disabled by default)
1919	ev_kqueue.c only when the kqueue backend is enabled (disabled by default)	1958	ev_kqueue.c only when the kqueue backend is enabled (disabled by default)
1920	ev_port.c only when the solaris port backend is enabled (disabled by default)	1959	ev_port.c only when the solaris port backend is enabled (disabled by default)
1921		1960
…		…
2090		2129
2091	If undefined or defined to be C<1>, then periodic timers are supported. If	2130	If undefined or defined to be C<1>, then periodic timers are supported. If
2092	defined to be C<0>, then they are not. Disabling them saves a few kB of	2131	defined to be C<0>, then they are not. Disabling them saves a few kB of
2093	code.	2132	code.
2094		2133
		2134	=item EV_IDLE_ENABLE
		2135
		2136	If undefined or defined to be C<1>, then idle watchers are supported. If
		2137	defined to be C<0>, then they are not. Disabling them saves a few kB of
		2138	code.
		2139
2095	=item EV_EMBED_ENABLE	2140	=item EV_EMBED_ENABLE
2096		2141
2097	If undefined or defined to be C<1>, then embed watchers are supported. If	2142	If undefined or defined to be C<1>, then embed watchers are supported. If
2098	defined to be C<0>, then they are not.	2143	defined to be C<0>, then they are not.
2099		2144
…		…
2163	interface) and F<EV.xs> (implementation) files. Only the F<EV.xs> file	2208	interface) and F<EV.xs> (implementation) files. Only the F<EV.xs> file
2164	will be compiled. It is pretty complex because it provides its own header	2209	will be compiled. It is pretty complex because it provides its own header
2165	file.	2210	file.
2166		2211
2167	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file	2212	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file
2168	that everybody includes and which overrides some autoconf choices:	2213	that everybody includes and which overrides some configure choices:
2169		2214
		2215	#define EV_MINIMAL 1
2170	#define EV_USE_POLL 0	2216	#define EV_USE_POLL 0
2171	#define EV_MULTIPLICITY 0	2217	#define EV_MULTIPLICITY 0
2172	#define EV_PERIODICS 0	2218	#define EV_PERIODIC_ENABLE 0
		2219	#define EV_STAT_ENABLE 0
		2220	#define EV_FORK_ENABLE 0
2173	#define EV_CONFIG_H <config.h>	2221	#define EV_CONFIG_H <config.h>
		2222	#define EV_MINPRI 0
		2223	#define EV_MAXPRI 0
2174		2224
2175	#include "ev++.h"	2225	#include "ev++.h"
2176		2226
2177	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:	2227	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
2178		2228

Diff Legend

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

Comparing libev/ev.pod (file contents): Revision 1.62 by root, Thu Nov 29 17:28:13 2007 UTC vs. Revision 1.67 by root, Fri Dec 7 16:44:12 2007 UTC

Diff Legend

Comparing libev/ev.pod (file contents):
Revision 1.62 by root, Thu Nov 29 17:28:13 2007 UTC vs.
Revision 1.67 by root, Fri Dec 7 16:44:12 2007 UTC