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

Comparing libev/ev.pod (file contents):
Revision 1.257 by root, Wed Jul 15 16:08:24 2009 UTC vs.
Revision 1.260 by root, Sun Jul 19 21:18:03 2009 UTC

…		…
362	flag.	362	flag.
363		363
364	This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS>	364	This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS>
365	environment variable.	365	environment variable.
366		366
		367	=item C<EVFLAG_NOINOTIFY>
		368
		369	When this flag is specified, then libev will not attempt to use the
		370	I<inotify> API for it's C<ev_stat> watchers. Apart from debugging and
		371	testing, this flag can be useful to conserve inotify file descriptors, as
		372	otherwise each loop using C<ev_stat> watchers consumes one inotify handle.
		373
		374	=item C<EVFLAG_NOSIGNALFD>
		375
		376	When this flag is specified, then libev will not attempt to use the
		377	I<signalfd> API for it's C<ev_signal> (and C<ev_child>) watchers. This is
		378	probably only useful to work around any bugs in libev. Consequently, this
		379	flag might go away once the signalfd functionality is considered stable,
		380	so it's useful mostly in environment variables and not in program code.
		381
367	=item C<EVBACKEND_SELECT> (value 1, portable select backend)	382	=item C<EVBACKEND_SELECT> (value 1, portable select backend)
368		383
369	This is your standard select(2) backend. Not I<completely> standard, as	384	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,	385	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	386	but if that fails, expect a fairly low limit on the number of fds when
…		…
518		533
519	It is definitely not recommended to use this flag.	534	It is definitely not recommended to use this flag.
520		535
521	=back	536	=back
522		537
523	If one or more of these are or'ed into the flags value, then only these	538	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	539	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.	540	here). If none are specified, all backends in C<ev_recommended_backends
		541	()> will be tried.
526		542
527	Example: This is the most typical usage.	543	Example: This is the most typical usage.
528		544
529	if (!ev_default_loop (0))	545	if (!ev_default_loop (0))
530	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");	546	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
…		…
1820	C<repeat> value), or reset the running timer to the C<repeat> value.	1836	C<repeat> value), or reset the running timer to the C<repeat> value.
1821		1837
1822	This sounds a bit complicated, see L<Be smart about timeouts>, above, for a	1838	This sounds a bit complicated, see L<Be smart about timeouts>, above, for a
1823	usage example.	1839	usage example.
1824		1840
		1841	=item ev_timer_remaining (loop, ev_timer *)
		1842
		1843	Returns the remaining time until a timer fires. If the timer is active,
		1844	then this time is relative to the current event loop time, otherwise it's
		1845	the timeout value currently configured.
		1846
		1847	That is, after an C<ev_timer_set (w, 5, 7)>, C<ev_timer_remaining> returns
		1848	C<5>. When the timer is started and one second passes, C<ev_timer_remain>
		1849	will return C<4>. When the timer expires and is restarted, it will return
		1850	roughly C<7> (likely slightly less as callback invocation takes some time,
		1851	too), and so on.
		1852
1825	=item ev_tstamp repeat [read-write]	1853	=item ev_tstamp repeat [read-write]
1826		1854
1827	The current C<repeat> value. Will be used each time the watcher times out	1855	The current C<repeat> value. Will be used each time the watcher times out
1828	or C<ev_timer_again> is called, and determines the next timeout (if any),	1856	or C<ev_timer_again> is called, and determines the next timeout (if any),
1829	which is also when any modifications are taken into account.	1857	which is also when any modifications are taken into account.
…		…
2064	Signal watchers will trigger an event when the process receives a specific	2092	Signal watchers will trigger an event when the process receives a specific
2065	signal one or more times. Even though signals are very asynchronous, libev	2093	signal one or more times. Even though signals are very asynchronous, libev
2066	will try it's best to deliver signals synchronously, i.e. as part of the	2094	will try it's best to deliver signals synchronously, i.e. as part of the
2067	normal event processing, like any other event.	2095	normal event processing, like any other event.
2068		2096
2069	If you want signals asynchronously, just use C<sigaction> as you would	2097	If you want signals to be delivered truly asynchronously, just use
2070	do without libev and forget about sharing the signal. You can even use	2098	C<sigaction> as you would do without libev and forget about sharing
2071	C<ev_async> from a signal handler to synchronously wake up an event loop.	2099	the signal. You can even use C<ev_async> from a signal handler to
		2100	synchronously wake up an event loop.
2072		2101
2073	You can configure as many watchers as you like per signal. Only when the	2102	You can configure as many watchers as you like for the same signal, but
		2103	only within the same loop, i.e. you can watch for C<SIGINT> in your
		2104	default loop and for C<SIGIO> in another loop, but you cannot watch for
		2105	C<SIGINT> in both the default loop and another loop at the same time. At
		2106	the moment, C<SIGCHLD> is permanently tied to the default loop.
		2107
2074	first watcher gets started will libev actually register a signal handler	2108	When the first watcher gets started will libev actually register something
2075	with the kernel (thus it coexists with your own signal handlers as long as	2109	with the kernel (thus it coexists with your own signal handlers as long as
2076	you don't register any with libev for the same signal). Similarly, when	2110	you don't register any with libev for the same signal).
2077	the last signal watcher for a signal is stopped, libev will reset the	2111
2078	signal handler to SIG_DFL (regardless of what it was set to before).	2112	Both the signal mask state (C<sigprocmask>) and the signal handler state
		2113	(C<sigaction>) are unspecified after starting a signal watcher (and after
		2114	sotpping it again), that is, libev might or might not block the signal,
		2115	and might or might not set or restore the installed signal handler.
2079		2116
2080	If possible and supported, libev will install its handlers with	2117	If possible and supported, libev will install its handlers with
2081	C<SA_RESTART> behaviour enabled, so system calls should not be unduly	2118	C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should
2082	interrupted. If you have a problem with system calls getting interrupted by	2119	not be unduly interrupted. If you have a problem with system calls getting
2083	signals you can block all signals in an C<ev_check> watcher and unblock	2120	interrupted by signals you can block all signals in an C<ev_check> watcher
2084	them in an C<ev_prepare> watcher.	2121	and unblock them in an C<ev_prepare> watcher.
2085		2122
2086	=head3 Watcher-Specific Functions and Data Members	2123	=head3 Watcher-Specific Functions and Data Members
2087		2124
2088	=over 4	2125	=over 4
2089		2126
…		…
2134	libev)	2171	libev)
2135		2172
2136	=head3 Process Interaction	2173	=head3 Process Interaction
2137		2174
2138	Libev grabs C<SIGCHLD> as soon as the default event loop is	2175	Libev grabs C<SIGCHLD> as soon as the default event loop is
2139	initialised. This is necessary to guarantee proper behaviour even if	2176	initialised. This is necessary to guarantee proper behaviour even if the
2140	the first child watcher is started after the child exits. The occurrence	2177	first child watcher is started after the child exits. The occurrence
2141	of C<SIGCHLD> is recorded asynchronously, but child reaping is done	2178	of C<SIGCHLD> is recorded asynchronously, but child reaping is done
2142	synchronously as part of the event loop processing. Libev always reaps all	2179	synchronously as part of the event loop processing. Libev always reaps all
2143	children, even ones not watched.	2180	children, even ones not watched.
2144		2181
2145	=head3 Overriding the Built-In Processing	2182	=head3 Overriding the Built-In Processing
…		…
2155	=head3 Stopping the Child Watcher	2192	=head3 Stopping the Child Watcher
2156		2193
2157	Currently, the child watcher never gets stopped, even when the	2194	Currently, the child watcher never gets stopped, even when the
2158	child terminates, so normally one needs to stop the watcher in the	2195	child terminates, so normally one needs to stop the watcher in the
2159	callback. Future versions of libev might stop the watcher automatically	2196	callback. Future versions of libev might stop the watcher automatically
2160	when a child exit is detected.	2197	when a child exit is detected (calling C<ev_child_stop> twice is not a
		2198	problem).
2161		2199
2162	=head3 Watcher-Specific Functions and Data Members	2200	=head3 Watcher-Specific Functions and Data Members
2163		2201
2164	=over 4	2202	=over 4
2165		2203
…		…
3780	Defining C<EV_MINIMAL> to C<2> will additionally reduce the core API to	3818	Defining C<EV_MINIMAL> to C<2> will additionally reduce the core API to
3781	provide a bare-bones event library. See C<ev.h> for details on what parts	3819	provide a bare-bones event library. See C<ev.h> for details on what parts
3782	of the API are still available, and do not complain if this subset changes	3820	of the API are still available, and do not complain if this subset changes
3783	over time.	3821	over time.
3784		3822
		3823	=item EV_NSIG
		3824
		3825	The highest supported signal number, +1 (or, the number of
		3826	signals): Normally, libev tries to deduce the maximum number of signals
		3827	automatically, but sometimes this fails, in which case it can be
		3828	specified. Also, using a lower number than detected (C<32> should be
		3829	good for about any system in existance) can save some memory, as libev
		3830	statically allocates some 12-24 bytes per signal number.
		3831
3785	=item EV_PID_HASHSIZE	3832	=item EV_PID_HASHSIZE
3786		3833
3787	C<ev_child> watchers use a small hash table to distribute workload by	3834	C<ev_child> watchers use a small hash table to distribute workload by
3788	pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more	3835	pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more
3789	than enough. If you need to manage thousands of children you might want to	3836	than enough. If you need to manage thousands of children you might want to

Diff Legend

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

Comparing libev/ev.pod (file contents): Revision 1.257 by root, Wed Jul 15 16:08:24 2009 UTC vs. Revision 1.260 by root, Sun Jul 19 21:18:03 2009 UTC

Diff Legend

Comparing libev/ev.pod (file contents):
Revision 1.257 by root, Wed Jul 15 16:08:24 2009 UTC vs.
Revision 1.260 by root, Sun Jul 19 21:18:03 2009 UTC