ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libev/ev.pod
(Generate patch)

Comparing libev/ev.pod (file contents):
Revision 1.257 by root, Wed Jul 15 16:08:24 2009 UTC vs.
Revision 1.259 by root, Sun Jul 19 01:36:34 2009 UTC

1820C<repeat> value), or reset the running timer to the C<repeat> value. 1820C<repeat> value), or reset the running timer to the C<repeat> value.
1821 1821
1822This sounds a bit complicated, see L<Be smart about timeouts>, above, for a 1822This sounds a bit complicated, see L<Be smart about timeouts>, above, for a
1823usage example. 1823usage example.
1824 1824
1825=item ev_timer_remaining (loop, ev_timer *)
1826
1827Returns the remaining time until a timer fires. If the timer is active,
1828then this time is relative to the current event loop time, otherwise it's
1829the timeout value currently configured.
1830
1831That is, after an C<ev_timer_set (w, 5, 7)>, C<ev_timer_remaining> returns
1832C<5>. When the timer is started and one second passes, C<ev_timer_remain>
1833will return C<4>. When the timer expires and is restarted, it will return
1834roughly C<7> (likely slightly less as callback invocation takes some time,
1835too), and so on.
1836
1825=item ev_tstamp repeat [read-write] 1837=item ev_tstamp repeat [read-write]
1826 1838
1827The current C<repeat> value. Will be used each time the watcher times out 1839The current C<repeat> value. Will be used each time the watcher times out
1828or C<ev_timer_again> is called, and determines the next timeout (if any), 1840or C<ev_timer_again> is called, and determines the next timeout (if any),
1829which is also when any modifications are taken into account. 1841which is also when any modifications are taken into account.
2064Signal watchers will trigger an event when the process receives a specific 2076Signal watchers will trigger an event when the process receives a specific
2065signal one or more times. Even though signals are very asynchronous, libev 2077signal one or more times. Even though signals are very asynchronous, libev
2066will try it's best to deliver signals synchronously, i.e. as part of the 2078will try it's best to deliver signals synchronously, i.e. as part of the
2067normal event processing, like any other event. 2079normal event processing, like any other event.
2068 2080
2081Note that only the default loop supports registering signal watchers
2082currently.
2083
2069If you want signals asynchronously, just use C<sigaction> as you would 2084If you want signals asynchronously, just use C<sigaction> as you would
2070do without libev and forget about sharing the signal. You can even use 2085do without libev and forget about sharing the signal. You can even use
2071C<ev_async> from a signal handler to synchronously wake up an event loop. 2086C<ev_async> from a signal handler to synchronously wake up an event loop.
2072 2087
2073You can configure as many watchers as you like per signal. Only when the 2088You can configure as many watchers as you like per signal. Only when the
2074first watcher gets started will libev actually register a signal handler 2089first watcher gets started will libev actually register something with
2075with the kernel (thus it coexists with your own signal handlers as long as 2090the kernel (thus it coexists with your own signal handlers as long as you
2076you don't register any with libev for the same signal). Similarly, when 2091don't register any with libev for the same signal).
2077the last signal watcher for a signal is stopped, libev will reset the 2092
2078signal handler to SIG_DFL (regardless of what it was set to before). 2093Both the signal mask state (C<sigprocmask>) and the signal handler state
2094(C<sigaction>) are unspecified after starting a signal watcher (and after
2095sotpping it again), that is, libev might or might not block the signal,
2096and might or might not set or restore the installed signal handler.
2079 2097
2080If possible and supported, libev will install its handlers with 2098If possible and supported, libev will install its handlers with
2081C<SA_RESTART> behaviour enabled, so system calls should not be unduly 2099C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should
2082interrupted. If you have a problem with system calls getting interrupted by 2100not be unduly interrupted. If you have a problem with system calls getting
2083signals you can block all signals in an C<ev_check> watcher and unblock 2101interrupted by signals you can block all signals in an C<ev_check> watcher
2084them in an C<ev_prepare> watcher. 2102and unblock them in an C<ev_prepare> watcher.
2085 2103
2086=head3 Watcher-Specific Functions and Data Members 2104=head3 Watcher-Specific Functions and Data Members
2087 2105
2088=over 4 2106=over 4
2089 2107
2134libev) 2152libev)
2135 2153
2136=head3 Process Interaction 2154=head3 Process Interaction
2137 2155
2138Libev grabs C<SIGCHLD> as soon as the default event loop is 2156Libev grabs C<SIGCHLD> as soon as the default event loop is
2139initialised. This is necessary to guarantee proper behaviour even if 2157initialised. This is necessary to guarantee proper behaviour even if the
2140the first child watcher is started after the child exits. The occurrence 2158first child watcher is started after the child exits. The occurrence
2141of C<SIGCHLD> is recorded asynchronously, but child reaping is done 2159of C<SIGCHLD> is recorded asynchronously, but child reaping is done
2142synchronously as part of the event loop processing. Libev always reaps all 2160synchronously as part of the event loop processing. Libev always reaps all
2143children, even ones not watched. 2161children, even ones not watched.
2144 2162
2145=head3 Overriding the Built-In Processing 2163=head3 Overriding the Built-In Processing
2155=head3 Stopping the Child Watcher 2173=head3 Stopping the Child Watcher
2156 2174
2157Currently, the child watcher never gets stopped, even when the 2175Currently, the child watcher never gets stopped, even when the
2158child terminates, so normally one needs to stop the watcher in the 2176child terminates, so normally one needs to stop the watcher in the
2159callback. Future versions of libev might stop the watcher automatically 2177callback. Future versions of libev might stop the watcher automatically
2160when a child exit is detected. 2178when a child exit is detected (calling C<ev_child_stop> twice is not a
2179problem).
2161 2180
2162=head3 Watcher-Specific Functions and Data Members 2181=head3 Watcher-Specific Functions and Data Members
2163 2182
2164=over 4 2183=over 4
2165 2184

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines