… | |
… | |
4 | <head> |
4 | <head> |
5 | <title>libev</title> |
5 | <title>libev</title> |
6 | <meta name="description" content="Pod documentation for libev" /> |
6 | <meta name="description" content="Pod documentation for libev" /> |
7 | <meta name="inputfile" content="<standard input>" /> |
7 | <meta name="inputfile" content="<standard input>" /> |
8 | <meta name="outputfile" content="<standard output>" /> |
8 | <meta name="outputfile" content="<standard output>" /> |
9 | <meta name="created" content="Mon Nov 12 09:16:01 2007" /> |
9 | <meta name="created" content="Mon Nov 12 09:58:24 2007" /> |
10 | <meta name="generator" content="Pod::Xhtml 1.57" /> |
10 | <meta name="generator" content="Pod::Xhtml 1.57" /> |
11 | <link rel="stylesheet" href="http://res.tst.eu/pod.css"/></head> |
11 | <link rel="stylesheet" href="http://res.tst.eu/pod.css"/></head> |
12 | <body> |
12 | <body> |
13 | <div class="pod"> |
13 | <div class="pod"> |
14 | <!-- INDEX START --> |
14 | <!-- INDEX START --> |
… | |
… | |
17 | <ul><li><a href="#NAME">NAME</a></li> |
17 | <ul><li><a href="#NAME">NAME</a></li> |
18 | <li><a href="#SYNOPSIS">SYNOPSIS</a></li> |
18 | <li><a href="#SYNOPSIS">SYNOPSIS</a></li> |
19 | <li><a href="#DESCRIPTION">DESCRIPTION</a></li> |
19 | <li><a href="#DESCRIPTION">DESCRIPTION</a></li> |
20 | <li><a href="#FEATURES">FEATURES</a></li> |
20 | <li><a href="#FEATURES">FEATURES</a></li> |
21 | <li><a href="#CONVENTIONS">CONVENTIONS</a></li> |
21 | <li><a href="#CONVENTIONS">CONVENTIONS</a></li> |
|
|
22 | <li><a href="#TIME_REPRESENTATION">TIME REPRESENTATION</a></li> |
22 | <li><a href="#TIME_AND_OTHER_GLOBAL_FUNCTIONS">TIME AND OTHER GLOBAL FUNCTIONS</a></li> |
23 | <li><a href="#GLOBAL_FUNCTIONS">GLOBAL FUNCTIONS</a></li> |
23 | <li><a href="#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP">FUNCTIONS CONTROLLING THE EVENT LOOP</a></li> |
24 | <li><a href="#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP">FUNCTIONS CONTROLLING THE EVENT LOOP</a></li> |
24 | <li><a href="#ANATOMY_OF_A_WATCHER">ANATOMY OF A WATCHER</a> |
25 | <li><a href="#ANATOMY_OF_A_WATCHER">ANATOMY OF A WATCHER</a> |
25 | <ul><li><a href="#ASSOCIATING_CUSTOM_DATA_WITH_A_WATCH">ASSOCIATING CUSTOM DATA WITH A WATCHER</a></li> |
26 | <ul><li><a href="#ASSOCIATING_CUSTOM_DATA_WITH_A_WATCH">ASSOCIATING CUSTOM DATA WITH A WATCHER</a></li> |
26 | </ul> |
27 | </ul> |
27 | </li> |
28 | </li> |
28 | <li><a href="#WATCHER_TYPES">WATCHER TYPES</a> |
29 | <li><a href="#WATCHER_TYPES">WATCHER TYPES</a> |
29 | <ul><li><a href="#struct_ev_io_is_my_file_descriptor_r">struct ev_io - is my file descriptor readable or writable</a></li> |
30 | <ul><li><a href="#code_ev_io_code_is_this_file_descrip"><code>ev_io</code> - is this file descriptor readable or writable</a></li> |
30 | <li><a href="#struct_ev_timer_relative_and_optiona">struct ev_timer - relative and optionally recurring timeouts</a></li> |
31 | <li><a href="#code_ev_timer_code_relative_and_opti"><code>ev_timer</code> - relative and optionally recurring timeouts</a></li> |
31 | <li><a href="#ev_periodic_to_cron_or_not_to_cron_i">ev_periodic - to cron or not to cron it</a></li> |
32 | <li><a href="#code_ev_periodic_code_to_cron_or_not"><code>ev_periodic</code> - to cron or not to cron</a></li> |
32 | <li><a href="#ev_signal_signal_me_when_a_signal_ge">ev_signal - signal me when a signal gets signalled</a></li> |
33 | <li><a href="#code_ev_signal_code_signal_me_when_a"><code>ev_signal</code> - signal me when a signal gets signalled</a></li> |
33 | <li><a href="#ev_child_wait_for_pid_status_changes">ev_child - wait for pid status changes</a></li> |
34 | <li><a href="#code_ev_child_code_wait_for_pid_stat"><code>ev_child</code> - wait for pid status changes</a></li> |
34 | <li><a href="#ev_idle_when_you_ve_got_nothing_bett">ev_idle - when you've got nothing better to do</a></li> |
35 | <li><a href="#code_ev_idle_code_when_you_ve_got_no"><code>ev_idle</code> - when you've got nothing better to do</a></li> |
35 | <li><a href="#prepare_and_check_your_hooks_into_th">prepare and check - your hooks into the event loop</a></li> |
36 | <li><a href="#code_ev_prepare_code_and_code_ev_che"><code>ev_prepare</code> and <code>ev_check</code> - customise your event loop</a></li> |
36 | </ul> |
37 | </ul> |
37 | </li> |
38 | </li> |
38 | <li><a href="#OTHER_FUNCTIONS">OTHER FUNCTIONS</a></li> |
39 | <li><a href="#OTHER_FUNCTIONS">OTHER FUNCTIONS</a></li> |
39 | <li><a href="#AUTHOR">AUTHOR</a> |
40 | <li><a href="#AUTHOR">AUTHOR</a> |
40 | </li> |
41 | </li> |
… | |
… | |
87 | support for multiple event loops, then all functions taking an initial |
88 | support for multiple event loops, then all functions taking an initial |
88 | argument of name <code>loop</code> (which is always of type <code>struct ev_loop *</code>) |
89 | argument of name <code>loop</code> (which is always of type <code>struct ev_loop *</code>) |
89 | will not have this argument.</p> |
90 | will not have this argument.</p> |
90 | |
91 | |
91 | </div> |
92 | </div> |
92 | <h1 id="TIME_AND_OTHER_GLOBAL_FUNCTIONS">TIME AND OTHER GLOBAL FUNCTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p> |
93 | <h1 id="TIME_REPRESENTATION">TIME REPRESENTATION</h1><p><a href="#TOP" class="toplink">Top</a></p> |
93 | <div id="TIME_AND_OTHER_GLOBAL_FUNCTIONS_CONT"> |
94 | <div id="TIME_REPRESENTATION_CONTENT"> |
94 | <p>Libev represents time as a single floating point number, representing the |
95 | <p>Libev represents time as a single floating point number, representing the |
95 | (fractional) number of seconds since the (POSIX) epoch (somewhere near |
96 | (fractional) number of seconds since the (POSIX) epoch (somewhere near |
96 | the beginning of 1970, details are complicated, don't ask). This type is |
97 | the beginning of 1970, details are complicated, don't ask). This type is |
97 | called <code>ev_tstamp</code>, which is what you should use too. It usually aliases |
98 | called <code>ev_tstamp</code>, which is what you should use too. It usually aliases |
98 | to the double type in C.</p> |
99 | to the double type in C.</p> |
|
|
100 | |
|
|
101 | </div> |
|
|
102 | <h1 id="GLOBAL_FUNCTIONS">GLOBAL FUNCTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p> |
|
|
103 | <div id="GLOBAL_FUNCTIONS_CONTENT"> |
99 | <dl> |
104 | <dl> |
100 | <dt>ev_tstamp ev_time ()</dt> |
105 | <dt>ev_tstamp ev_time ()</dt> |
101 | <dd> |
106 | <dd> |
102 | <p>Returns the current time as libev would use it.</p> |
107 | <p>Returns the current time as libev would use it.</p> |
103 | </dd> |
108 | </dd> |
… | |
… | |
107 | <p>You can find out the major and minor version numbers of the library |
112 | <p>You can find out the major and minor version numbers of the library |
108 | you linked against by calling the functions <code>ev_version_major</code> and |
113 | you linked against by calling the functions <code>ev_version_major</code> and |
109 | <code>ev_version_minor</code>. If you want, you can compare against the global |
114 | <code>ev_version_minor</code>. If you want, you can compare against the global |
110 | symbols <code>EV_VERSION_MAJOR</code> and <code>EV_VERSION_MINOR</code>, which specify the |
115 | symbols <code>EV_VERSION_MAJOR</code> and <code>EV_VERSION_MINOR</code>, which specify the |
111 | version of the library your program was compiled against.</p> |
116 | version of the library your program was compiled against.</p> |
112 | <p>Usually, its a good idea to terminate if the major versions mismatch, |
117 | <p>Usually, it's a good idea to terminate if the major versions mismatch, |
113 | as this indicates an incompatible change. Minor versions are usually |
118 | as this indicates an incompatible change. Minor versions are usually |
114 | compatible to older versions, so a larger minor version alone is usually |
119 | compatible to older versions, so a larger minor version alone is usually |
115 | not a problem.</p> |
120 | not a problem.</p> |
116 | </dd> |
121 | </dd> |
117 | <dt>ev_set_allocator (void *(*cb)(void *ptr, long size))</dt> |
122 | <dt>ev_set_allocator (void *(*cb)(void *ptr, long size))</dt> |
… | |
… | |
142 | <div id="FUNCTIONS_CONTROLLING_THE_EVENT_LOOP-2"> |
147 | <div id="FUNCTIONS_CONTROLLING_THE_EVENT_LOOP-2"> |
143 | <p>An event loop is described by a <code>struct ev_loop *</code>. The library knows two |
148 | <p>An event loop is described by a <code>struct ev_loop *</code>. The library knows two |
144 | types of such loops, the <i>default</i> loop, which supports signals and child |
149 | types of such loops, the <i>default</i> loop, which supports signals and child |
145 | events, and dynamically created loops which do not.</p> |
150 | events, and dynamically created loops which do not.</p> |
146 | <p>If you use threads, a common model is to run the default event loop |
151 | <p>If you use threads, a common model is to run the default event loop |
147 | in your main thread (or in a separate thrad) and for each thread you |
152 | in your main thread (or in a separate thread) and for each thread you |
148 | create, you also create another event loop. Libev itself does no locking |
153 | create, you also create another event loop. Libev itself does no locking |
149 | whatsoever, so if you mix calls to the same event loop in different |
154 | whatsoever, so if you mix calls to the same event loop in different |
150 | threads, make sure you lock (this is usually a bad idea, though, even if |
155 | threads, make sure you lock (this is usually a bad idea, though, even if |
151 | done correctly, because its hideous and inefficient).</p> |
156 | done correctly, because it's hideous and inefficient).</p> |
152 | <dl> |
157 | <dl> |
153 | <dt>struct ev_loop *ev_default_loop (unsigned int flags)</dt> |
158 | <dt>struct ev_loop *ev_default_loop (unsigned int flags)</dt> |
154 | <dd> |
159 | <dd> |
155 | <p>This will initialise the default event loop if it hasn't been initialised |
160 | <p>This will initialise the default event loop if it hasn't been initialised |
156 | yet and return it. If the default loop could not be initialised, returns |
161 | yet and return it. If the default loop could not be initialised, returns |
157 | false. If it already was initialised it simply returns it (and ignores the |
162 | false. If it already was initialised it simply returns it (and ignores the |
158 | flags).</p> |
163 | flags).</p> |
159 | <p>If you don't know what event loop to use, use the one returned from this |
164 | <p>If you don't know what event loop to use, use the one returned from this |
160 | function.</p> |
165 | function.</p> |
161 | <p>The flags argument can be used to specify special behaviour or specific |
166 | <p>The flags argument can be used to specify special behaviour or specific |
162 | backends to use, and is usually specified as 0 (or EVFLAG_AUTO)</p> |
167 | backends to use, and is usually specified as 0 (or EVFLAG_AUTO).</p> |
163 | <p>It supports the following flags:</p> |
168 | <p>It supports the following flags:</p> |
164 | <p> |
169 | <p> |
165 | <dl> |
170 | <dl> |
166 | <dt>EVFLAG_AUTO</dt> |
171 | <dt><code>EVFLAG_AUTO</code></dt> |
167 | <dd> |
172 | <dd> |
168 | <p>The default flags value. Use this if you have no clue (its the right |
173 | <p>The default flags value. Use this if you have no clue (it's the right |
169 | thing, believe me).</p> |
174 | thing, believe me).</p> |
170 | </dd> |
175 | </dd> |
171 | <dt>EVFLAG_NOENV</dt> |
176 | <dt><code>EVFLAG_NOENV</code></dt> |
172 | <dd> |
177 | <dd> |
173 | <p>If this flag bit is ored into the flag value then libev will <i>not</i> look |
178 | <p>If this flag bit is ored into the flag value (or the program runs setuid |
174 | at the environment variable <code>LIBEV_FLAGS</code>. Otherwise (the default), this |
179 | or setgid) then libev will <i>not</i> look at the environment variable |
175 | environment variable will override the flags completely. This is useful |
180 | <code>LIBEV_FLAGS</code>. Otherwise (the default), this environment variable will |
|
|
181 | override the flags completely if it is found in the environment. This is |
176 | to try out specific backends to tets their performance, or to work around |
182 | useful to try out specific backends to test their performance, or to work |
177 | bugs.</p> |
183 | around bugs.</p> |
178 | </dd> |
184 | </dd> |
179 | <dt>EVMETHOD_SELECT portable select backend</dt> |
185 | <dt><code>EVMETHOD_SELECT</code> (portable select backend)</dt> |
180 | <dt>EVMETHOD_POLL poll backend (everywhere except windows)</dt> |
186 | <dt><code>EVMETHOD_POLL</code> (poll backend, available everywhere except on windows)</dt> |
181 | <dt>EVMETHOD_EPOLL linux only</dt> |
187 | <dt><code>EVMETHOD_EPOLL</code> (linux only)</dt> |
182 | <dt>EVMETHOD_KQUEUE some bsds only</dt> |
188 | <dt><code>EVMETHOD_KQUEUE</code> (some bsds only)</dt> |
183 | <dt>EVMETHOD_DEVPOLL solaris 8 only</dt> |
189 | <dt><code>EVMETHOD_DEVPOLL</code> (solaris 8 only)</dt> |
184 | <dt>EVMETHOD_PORT solaris 10 only</dt> |
190 | <dt><code>EVMETHOD_PORT</code> (solaris 10 only)</dt> |
185 | <dd> |
191 | <dd> |
186 | <p>If one or more of these are ored into the flags value, then only these |
192 | <p>If one or more of these are ored into the flags value, then only these |
187 | backends will be tried (in the reverse order as given here). If one are |
193 | backends will be tried (in the reverse order as given here). If one are |
188 | specified, any backend will do.</p> |
194 | specified, any backend will do.</p> |
189 | </dd> |
195 | </dd> |
… | |
… | |
199 | </dd> |
205 | </dd> |
200 | <dt>ev_default_destroy ()</dt> |
206 | <dt>ev_default_destroy ()</dt> |
201 | <dd> |
207 | <dd> |
202 | <p>Destroys the default loop again (frees all memory and kernel state |
208 | <p>Destroys the default loop again (frees all memory and kernel state |
203 | etc.). This stops all registered event watchers (by not touching them in |
209 | etc.). This stops all registered event watchers (by not touching them in |
204 | any way whatsoever, although you cnanot rely on this :).</p> |
210 | any way whatsoever, although you cannot rely on this :).</p> |
205 | </dd> |
211 | </dd> |
206 | <dt>ev_loop_destroy (loop)</dt> |
212 | <dt>ev_loop_destroy (loop)</dt> |
207 | <dd> |
213 | <dd> |
208 | <p>Like <code>ev_default_destroy</code>, but destroys an event loop created by an |
214 | <p>Like <code>ev_default_destroy</code>, but destroys an event loop created by an |
209 | earlier call to <code>ev_loop_new</code>.</p> |
215 | earlier call to <code>ev_loop_new</code>.</p> |
… | |
… | |
215 | after forking, in either the parent or child process (or both, but that |
221 | after forking, in either the parent or child process (or both, but that |
216 | again makes little sense).</p> |
222 | again makes little sense).</p> |
217 | <p>You <i>must</i> call this function after forking if and only if you want to |
223 | <p>You <i>must</i> call this function after forking if and only if you want to |
218 | use the event library in both processes. If you just fork+exec, you don't |
224 | use the event library in both processes. If you just fork+exec, you don't |
219 | have to call it.</p> |
225 | have to call it.</p> |
220 | <p>The function itself is quite fast and its usually not a problem to call |
226 | <p>The function itself is quite fast and it's usually not a problem to call |
221 | it just in case after a fork. To make this easy, the function will fit in |
227 | it just in case after a fork. To make this easy, the function will fit in |
222 | quite nicely into a call to <code>pthread_atfork</code>:</p> |
228 | quite nicely into a call to <code>pthread_atfork</code>:</p> |
223 | <pre> pthread_atfork (0, 0, ev_default_fork); |
229 | <pre> pthread_atfork (0, 0, ev_default_fork); |
224 | |
230 | |
225 | </pre> |
231 | </pre> |
… | |
… | |
233 | <dt>unsigned int ev_method (loop)</dt> |
239 | <dt>unsigned int ev_method (loop)</dt> |
234 | <dd> |
240 | <dd> |
235 | <p>Returns one of the <code>EVMETHOD_*</code> flags indicating the event backend in |
241 | <p>Returns one of the <code>EVMETHOD_*</code> flags indicating the event backend in |
236 | use.</p> |
242 | use.</p> |
237 | </dd> |
243 | </dd> |
238 | <dt>ev_tstamp = ev_now (loop)</dt> |
244 | <dt>ev_tstamp ev_now (loop)</dt> |
239 | <dd> |
245 | <dd> |
240 | <p>Returns the current "event loop time", which is the time the event loop |
246 | <p>Returns the current "event loop time", which is the time the event loop |
241 | got events and started processing them. This timestamp does not change |
247 | got events and started processing them. This timestamp does not change |
242 | as long as callbacks are being processed, and this is also the base time |
248 | as long as callbacks are being processed, and this is also the base time |
243 | used for relative timers. You can treat it as the timestamp of the event |
249 | used for relative timers. You can treat it as the timestamp of the event |
… | |
… | |
250 | events.</p> |
256 | events.</p> |
251 | <p>If the flags argument is specified as 0, it will not return until either |
257 | <p>If the flags argument is specified as 0, it will not return until either |
252 | no event watchers are active anymore or <code>ev_unloop</code> was called.</p> |
258 | no event watchers are active anymore or <code>ev_unloop</code> was called.</p> |
253 | <p>A flags value of <code>EVLOOP_NONBLOCK</code> will look for new events, will handle |
259 | <p>A flags value of <code>EVLOOP_NONBLOCK</code> will look for new events, will handle |
254 | those events and any outstanding ones, but will not block your process in |
260 | those events and any outstanding ones, but will not block your process in |
255 | case there are no events.</p> |
261 | case there are no events and will return after one iteration of the loop.</p> |
256 | <p>A flags value of <code>EVLOOP_ONESHOT</code> will look for new events (waiting if |
262 | <p>A flags value of <code>EVLOOP_ONESHOT</code> will look for new events (waiting if |
257 | neccessary) and will handle those and any outstanding ones. It will block |
263 | neccessary) and will handle those and any outstanding ones. It will block |
258 | your process until at least one new event arrives.</p> |
264 | your process until at least one new event arrives, and will return after |
|
|
265 | one iteration of the loop.</p> |
259 | <p>This flags value could be used to implement alternative looping |
266 | <p>This flags value could be used to implement alternative looping |
260 | constructs, but the <code>prepare</code> and <code>check</code> watchers provide a better and |
267 | constructs, but the <code>prepare</code> and <code>check</code> watchers provide a better and |
261 | more generic mechanism.</p> |
268 | more generic mechanism.</p> |
262 | </dd> |
269 | </dd> |
263 | <dt>ev_unloop (loop, how)</dt> |
270 | <dt>ev_unloop (loop, how)</dt> |
264 | <dd> |
271 | <dd> |
265 | <p>Can be used to make a call to <code>ev_loop</code> return early. The <code>how</code> argument |
272 | <p>Can be used to make a call to <code>ev_loop</code> return early (but only after it |
|
|
273 | has processed all outstanding events). The <code>how</code> argument must be either |
266 | must be either <code>EVUNLOOP_ONCE</code>, which will make the innermost <code>ev_loop</code> |
274 | <code>EVUNLOOP_ONCE</code>, which will make the innermost <code>ev_loop</code> call return, or |
267 | call return, or <code>EVUNLOOP_ALL</code>, which will make all nested <code>ev_loop</code> |
275 | <code>EVUNLOOP_ALL</code>, which will make all nested <code>ev_loop</code> calls return.</p> |
268 | calls return.</p> |
|
|
269 | </dd> |
276 | </dd> |
270 | <dt>ev_ref (loop)</dt> |
277 | <dt>ev_ref (loop)</dt> |
271 | <dt>ev_unref (loop)</dt> |
278 | <dt>ev_unref (loop)</dt> |
272 | <dd> |
279 | <dd> |
273 | <p>Ref/unref can be used to add or remove a refcount on the event loop: Every |
280 | <p>Ref/unref can be used to add or remove a reference count on the event |
274 | watcher keeps one reference. If you have a long-runing watcher you never |
281 | loop: Every watcher keeps one reference, and as long as the reference |
275 | unregister that should not keep ev_loop from running, ev_unref() after |
282 | count is nonzero, <code>ev_loop</code> will not return on its own. If you have |
276 | starting, and ev_ref() before stopping it. Libev itself uses this for |
283 | a watcher you never unregister that should not keep <code>ev_loop</code> from |
277 | example for its internal signal pipe: It is not visible to you as a user |
284 | returning, ev_unref() after starting, and ev_ref() before stopping it. For |
278 | and should not keep <code>ev_loop</code> from exiting if the work is done. It is |
285 | example, libev itself uses this for its internal signal pipe: It is not |
279 | also an excellent way to do this for generic recurring timers or from |
286 | visible to the libev user and should not keep <code>ev_loop</code> from exiting if |
280 | within third-party libraries. Just remember to unref after start and ref |
287 | no event watchers registered by it are active. It is also an excellent |
281 | before stop.</p> |
288 | way to do this for generic recurring timers or from within third-party |
|
|
289 | libraries. Just remember to <i>unref after start</i> and <i>ref before stop</i>.</p> |
282 | </dd> |
290 | </dd> |
283 | </dl> |
291 | </dl> |
284 | |
292 | |
285 | </div> |
293 | </div> |
286 | <h1 id="ANATOMY_OF_A_WATCHER">ANATOMY OF A WATCHER</h1><p><a href="#TOP" class="toplink">Top</a></p> |
294 | <h1 id="ANATOMY_OF_A_WATCHER">ANATOMY OF A WATCHER</h1><p><a href="#TOP" class="toplink">Top</a></p> |
287 | <div id="ANATOMY_OF_A_WATCHER_CONTENT"> |
295 | <div id="ANATOMY_OF_A_WATCHER_CONTENT"> |
288 | <p>A watcher is a structure that you create and register to record your |
296 | <p>A watcher is a structure that you create and register to record your |
289 | interest in some event. For instance, if you want to wait for STDIN to |
297 | interest in some event. For instance, if you want to wait for STDIN to |
290 | become readable, you would create an ev_io watcher for that:</p> |
298 | become readable, you would create an <code>ev_io</code> watcher for that:</p> |
291 | <pre> static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents) |
299 | <pre> static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents) |
292 | { |
300 | { |
293 | ev_io_stop (w); |
301 | ev_io_stop (w); |
294 | ev_unloop (loop, EVUNLOOP_ALL); |
302 | ev_unloop (loop, EVUNLOOP_ALL); |
295 | } |
303 | } |
… | |
… | |
319 | *)</code>), and you can stop watching for events at any time by calling the |
327 | *)</code>), and you can stop watching for events at any time by calling the |
320 | corresponding stop function (<code>ev_<type>_stop (loop, watcher *)</code>.</p> |
328 | corresponding stop function (<code>ev_<type>_stop (loop, watcher *)</code>.</p> |
321 | <p>As long as your watcher is active (has been started but not stopped) you |
329 | <p>As long as your watcher is active (has been started but not stopped) you |
322 | must not touch the values stored in it. Most specifically you must never |
330 | must not touch the values stored in it. Most specifically you must never |
323 | reinitialise it or call its set method.</p> |
331 | reinitialise it or call its set method.</p> |
324 | <p>You cna check whether an event is active by calling the <code>ev_is_active |
332 | <p>You can check whether an event is active by calling the <code>ev_is_active |
325 | (watcher *)</code> macro. To see whether an event is outstanding (but the |
333 | (watcher *)</code> macro. To see whether an event is outstanding (but the |
326 | callback for it has not been called yet) you cna use the <code>ev_is_pending |
334 | callback for it has not been called yet) you can use the <code>ev_is_pending |
327 | (watcher *)</code> macro.</p> |
335 | (watcher *)</code> macro.</p> |
328 | <p>Each and every callback receives the event loop pointer as first, the |
336 | <p>Each and every callback receives the event loop pointer as first, the |
329 | registered watcher structure as second, and a bitset of received events as |
337 | registered watcher structure as second, and a bitset of received events as |
330 | third argument.</p> |
338 | third argument.</p> |
331 | <p>The rceeived events usually include a single bit per event type received |
339 | <p>The received events usually include a single bit per event type received |
332 | (you can receive multiple events at the same time). The possible bit masks |
340 | (you can receive multiple events at the same time). The possible bit masks |
333 | are:</p> |
341 | are:</p> |
334 | <dl> |
342 | <dl> |
335 | <dt>EV_READ</dt> |
343 | <dt><code>EV_READ</code></dt> |
336 | <dt>EV_WRITE</dt> |
344 | <dt><code>EV_WRITE</code></dt> |
337 | <dd> |
345 | <dd> |
338 | <p>The file descriptor in the ev_io watcher has become readable and/or |
346 | <p>The file descriptor in the <code>ev_io</code> watcher has become readable and/or |
339 | writable.</p> |
347 | writable.</p> |
340 | </dd> |
348 | </dd> |
341 | <dt>EV_TIMEOUT</dt> |
349 | <dt><code>EV_TIMEOUT</code></dt> |
342 | <dd> |
|
|
343 | <p>The ev_timer watcher has timed out.</p> |
|
|
344 | </dd> |
350 | <dd> |
345 | <dt>EV_PERIODIC</dt> |
351 | <p>The <code>ev_timer</code> watcher has timed out.</p> |
346 | <dd> |
352 | </dd> |
347 | <p>The ev_periodic watcher has timed out.</p> |
353 | <dt><code>EV_PERIODIC</code></dt> |
348 | </dd> |
354 | <dd> |
349 | <dt>EV_SIGNAL</dt> |
355 | <p>The <code>ev_periodic</code> watcher has timed out.</p> |
350 | <dd> |
356 | </dd> |
|
|
357 | <dt><code>EV_SIGNAL</code></dt> |
|
|
358 | <dd> |
351 | <p>The signal specified in the ev_signal watcher has been received by a thread.</p> |
359 | <p>The signal specified in the <code>ev_signal</code> watcher has been received by a thread.</p> |
352 | </dd> |
|
|
353 | <dt>EV_CHILD</dt> |
|
|
354 | <dd> |
360 | </dd> |
|
|
361 | <dt><code>EV_CHILD</code></dt> |
|
|
362 | <dd> |
355 | <p>The pid specified in the ev_child watcher has received a status change.</p> |
363 | <p>The pid specified in the <code>ev_child</code> watcher has received a status change.</p> |
356 | </dd> |
|
|
357 | <dt>EV_IDLE</dt> |
|
|
358 | <dd> |
364 | </dd> |
|
|
365 | <dt><code>EV_IDLE</code></dt> |
|
|
366 | <dd> |
359 | <p>The ev_idle watcher has determined that you have nothing better to do.</p> |
367 | <p>The <code>ev_idle</code> watcher has determined that you have nothing better to do.</p> |
360 | </dd> |
|
|
361 | <dt>EV_PREPARE</dt> |
|
|
362 | <dt>EV_CHECK</dt> |
|
|
363 | <dd> |
368 | </dd> |
|
|
369 | <dt><code>EV_PREPARE</code></dt> |
|
|
370 | <dt><code>EV_CHECK</code></dt> |
|
|
371 | <dd> |
364 | <p>All ev_prepare watchers are invoked just <i>before</i> <code>ev_loop</code> starts |
372 | <p>All <code>ev_prepare</code> watchers are invoked just <i>before</i> <code>ev_loop</code> starts |
365 | to gather new events, and all ev_check watchers are invoked just after |
373 | to gather new events, and all <code>ev_check</code> watchers are invoked just after |
366 | <code>ev_loop</code> has gathered them, but before it invokes any callbacks for any |
374 | <code>ev_loop</code> has gathered them, but before it invokes any callbacks for any |
367 | received events. Callbacks of both watcher types can start and stop as |
375 | received events. Callbacks of both watcher types can start and stop as |
368 | many watchers as they want, and all of them will be taken into account |
376 | many watchers as they want, and all of them will be taken into account |
369 | (for example, a ev_prepare watcher might start an idle watcher to keep |
377 | (for example, a <code>ev_prepare</code> watcher might start an idle watcher to keep |
370 | <code>ev_loop</code> from blocking).</p> |
378 | <code>ev_loop</code> from blocking).</p> |
371 | </dd> |
379 | </dd> |
372 | <dt>EV_ERROR</dt> |
380 | <dt><code>EV_ERROR</code></dt> |
373 | <dd> |
381 | <dd> |
374 | <p>An unspecified error has occured, the watcher has been stopped. This might |
382 | <p>An unspecified error has occured, the watcher has been stopped. This might |
375 | happen because the watcher could not be properly started because libev |
383 | happen because the watcher could not be properly started because libev |
376 | ran out of memory, a file descriptor was found to be closed or any other |
384 | ran out of memory, a file descriptor was found to be closed or any other |
377 | problem. You best act on it by reporting the problem and somehow coping |
385 | problem. You best act on it by reporting the problem and somehow coping |
… | |
… | |
386 | |
394 | |
387 | </div> |
395 | </div> |
388 | <h2 id="ASSOCIATING_CUSTOM_DATA_WITH_A_WATCH">ASSOCIATING CUSTOM DATA WITH A WATCHER</h2> |
396 | <h2 id="ASSOCIATING_CUSTOM_DATA_WITH_A_WATCH">ASSOCIATING CUSTOM DATA WITH A WATCHER</h2> |
389 | <div id="ASSOCIATING_CUSTOM_DATA_WITH_A_WATCH-2"> |
397 | <div id="ASSOCIATING_CUSTOM_DATA_WITH_A_WATCH-2"> |
390 | <p>Each watcher has, by default, a member <code>void *data</code> that you can change |
398 | <p>Each watcher has, by default, a member <code>void *data</code> that you can change |
391 | and read at any time, libev will completely ignore it. This cna be used |
399 | and read at any time, libev will completely ignore it. This can be used |
392 | to associate arbitrary data with your watcher. If you need more data and |
400 | to associate arbitrary data with your watcher. If you need more data and |
393 | don't want to allocate memory and store a pointer to it in that data |
401 | don't want to allocate memory and store a pointer to it in that data |
394 | member, you can also "subclass" the watcher type and provide your own |
402 | member, you can also "subclass" the watcher type and provide your own |
395 | data:</p> |
403 | data:</p> |
396 | <pre> struct my_io |
404 | <pre> struct my_io |
… | |
… | |
423 | <div id="WATCHER_TYPES_CONTENT"> |
431 | <div id="WATCHER_TYPES_CONTENT"> |
424 | <p>This section describes each watcher in detail, but will not repeat |
432 | <p>This section describes each watcher in detail, but will not repeat |
425 | information given in the last section.</p> |
433 | information given in the last section.</p> |
426 | |
434 | |
427 | </div> |
435 | </div> |
428 | <h2 id="struct_ev_io_is_my_file_descriptor_r">struct ev_io - is my file descriptor readable or writable</h2> |
436 | <h2 id="code_ev_io_code_is_this_file_descrip"><code>ev_io</code> - is this file descriptor readable or writable</h2> |
429 | <div id="struct_ev_io_is_my_file_descriptor_r-2"> |
437 | <div id="code_ev_io_code_is_this_file_descrip-2"> |
430 | <p>I/O watchers check whether a file descriptor is readable or writable |
438 | <p>I/O watchers check whether a file descriptor is readable or writable |
431 | in each iteration of the event loop (This behaviour is called |
439 | in each iteration of the event loop (This behaviour is called |
432 | level-triggering because you keep receiving events as long as the |
440 | level-triggering because you keep receiving events as long as the |
433 | condition persists. Remember you cna stop the watcher if you don't want to |
441 | condition persists. Remember you can stop the watcher if you don't want to |
434 | act on the event and neither want to receive future events).</p> |
442 | act on the event and neither want to receive future events).</p> |
|
|
443 | <p>In general you can register as many read and/or write event watchers oer |
|
|
444 | fd as you want (as long as you don't confuse yourself). Setting all file |
|
|
445 | descriptors to non-blocking mode is also usually a good idea (but not |
|
|
446 | required if you know what you are doing).</p> |
|
|
447 | <p>You have to be careful with dup'ed file descriptors, though. Some backends |
|
|
448 | (the linux epoll backend is a notable example) cannot handle dup'ed file |
|
|
449 | descriptors correctly if you register interest in two or more fds pointing |
|
|
450 | to the same file/socket etc. description.</p> |
|
|
451 | <p>If you must do this, then force the use of a known-to-be-good backend |
|
|
452 | (at the time of this writing, this includes only EVMETHOD_SELECT and |
|
|
453 | EVMETHOD_POLL).</p> |
435 | <dl> |
454 | <dl> |
436 | <dt>ev_io_init (ev_io *, callback, int fd, int events)</dt> |
455 | <dt>ev_io_init (ev_io *, callback, int fd, int events)</dt> |
437 | <dt>ev_io_set (ev_io *, int fd, int events)</dt> |
456 | <dt>ev_io_set (ev_io *, int fd, int events)</dt> |
438 | <dd> |
457 | <dd> |
439 | <p>Configures an ev_io watcher. The fd is the file descriptor to rceeive |
458 | <p>Configures an <code>ev_io</code> watcher. The fd is the file descriptor to rceeive |
440 | events for and events is either <code>EV_READ</code>, <code>EV_WRITE</code> or <code>EV_READ | |
459 | events for and events is either <code>EV_READ</code>, <code>EV_WRITE</code> or <code>EV_READ | |
441 | EV_WRITE</code> to receive the given events.</p> |
460 | EV_WRITE</code> to receive the given events.</p> |
442 | </dd> |
461 | </dd> |
443 | </dl> |
462 | </dl> |
444 | |
463 | |
445 | </div> |
464 | </div> |
446 | <h2 id="struct_ev_timer_relative_and_optiona">struct ev_timer - relative and optionally recurring timeouts</h2> |
465 | <h2 id="code_ev_timer_code_relative_and_opti"><code>ev_timer</code> - relative and optionally recurring timeouts</h2> |
447 | <div id="struct_ev_timer_relative_and_optiona-2"> |
466 | <div id="code_ev_timer_code_relative_and_opti-2"> |
448 | <p>Timer watchers are simple relative timers that generate an event after a |
467 | <p>Timer watchers are simple relative timers that generate an event after a |
449 | given time, and optionally repeating in regular intervals after that.</p> |
468 | given time, and optionally repeating in regular intervals after that.</p> |
450 | <p>The timers are based on real time, that is, if you register an event that |
469 | <p>The timers are based on real time, that is, if you register an event that |
451 | times out after an hour and youreset your system clock to last years |
470 | times out after an hour and youreset your system clock to last years |
452 | time, it will still time out after (roughly) and hour. "Roughly" because |
471 | time, it will still time out after (roughly) and hour. "Roughly" because |
453 | detecting time jumps is hard, and soem inaccuracies are unavoidable (the |
472 | detecting time jumps is hard, and soem inaccuracies are unavoidable (the |
454 | monotonic clock option helps a lot here).</p> |
473 | monotonic clock option helps a lot here).</p> |
|
|
474 | <p>The relative timeouts are calculated relative to the <code>ev_now ()</code> |
|
|
475 | time. This is usually the right thing as this timestamp refers to the time |
|
|
476 | of the event triggering whatever timeout you are modifying/starting. If |
|
|
477 | you suspect event processing to be delayed and you *need* to base the timeout |
|
|
478 | ion the current time, use something like this to adjust for this:</p> |
|
|
479 | <pre> ev_timer_set (&timer, after + ev_now () - ev_time (), 0.); |
|
|
480 | |
|
|
481 | </pre> |
455 | <dl> |
482 | <dl> |
456 | <dt>ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)</dt> |
483 | <dt>ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)</dt> |
457 | <dt>ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)</dt> |
484 | <dt>ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)</dt> |
458 | <dd> |
485 | <dd> |
459 | <p>Configure the timer to trigger after <code>after</code> seconds. If <code>repeat</code> is |
486 | <p>Configure the timer to trigger after <code>after</code> seconds. If <code>repeat</code> is |
… | |
… | |
475 | value), or reset the running timer to the repeat value.</p> |
502 | value), or reset the running timer to the repeat value.</p> |
476 | <p>This sounds a bit complicated, but here is a useful and typical |
503 | <p>This sounds a bit complicated, but here is a useful and typical |
477 | example: Imagine you have a tcp connection and you want a so-called idle |
504 | example: Imagine you have a tcp connection and you want a so-called idle |
478 | timeout, that is, you want to be called when there have been, say, 60 |
505 | timeout, that is, you want to be called when there have been, say, 60 |
479 | seconds of inactivity on the socket. The easiest way to do this is to |
506 | seconds of inactivity on the socket. The easiest way to do this is to |
480 | configure an ev_timer with after=repeat=60 and calling ev_timer_again each |
507 | configure an <code>ev_timer</code> with after=repeat=60 and calling ev_timer_again each |
481 | time you successfully read or write some data. If you go into an idle |
508 | time you successfully read or write some data. If you go into an idle |
482 | state where you do not expect data to travel on the socket, you can stop |
509 | state where you do not expect data to travel on the socket, you can stop |
483 | the timer, and again will automatically restart it if need be.</p> |
510 | the timer, and again will automatically restart it if need be.</p> |
484 | </dd> |
511 | </dd> |
485 | </dl> |
512 | </dl> |
486 | |
513 | |
487 | </div> |
514 | </div> |
488 | <h2 id="ev_periodic_to_cron_or_not_to_cron_i">ev_periodic - to cron or not to cron it</h2> |
515 | <h2 id="code_ev_periodic_code_to_cron_or_not"><code>ev_periodic</code> - to cron or not to cron</h2> |
489 | <div id="ev_periodic_to_cron_or_not_to_cron_i-2"> |
516 | <div id="code_ev_periodic_code_to_cron_or_not-2"> |
490 | <p>Periodic watchers are also timers of a kind, but they are very versatile |
517 | <p>Periodic watchers are also timers of a kind, but they are very versatile |
491 | (and unfortunately a bit complex).</p> |
518 | (and unfortunately a bit complex).</p> |
492 | <p>Unlike ev_timer's, they are not based on real time (or relative time) |
519 | <p>Unlike <code>ev_timer</code>'s, they are not based on real time (or relative time) |
493 | but on wallclock time (absolute time). You can tell a periodic watcher |
520 | but on wallclock time (absolute time). You can tell a periodic watcher |
494 | to trigger "at" some specific point in time. For example, if you tell a |
521 | to trigger "at" some specific point in time. For example, if you tell a |
495 | periodic watcher to trigger in 10 seconds (by specifiying e.g. c<ev_now () |
522 | periodic watcher to trigger in 10 seconds (by specifiying e.g. c<ev_now () |
496 | + 10.>) and then reset your system clock to the last year, then it will |
523 | + 10.>) and then reset your system clock to the last year, then it will |
497 | take a year to trigger the event (unlike an ev_timer, which would trigger |
524 | take a year to trigger the event (unlike an <code>ev_timer</code>, which would trigger |
498 | roughly 10 seconds later and of course not if you reset your system time |
525 | roughly 10 seconds later and of course not if you reset your system time |
499 | again).</p> |
526 | again).</p> |
500 | <p>They can also be used to implement vastly more complex timers, such as |
527 | <p>They can also be used to implement vastly more complex timers, such as |
501 | triggering an event on eahc midnight, local time.</p> |
528 | triggering an event on eahc midnight, local time.</p> |
502 | <dl> |
529 | <dl> |
… | |
… | |
528 | <pre> ev_periodic_set (&periodic, 0., 3600., 0); |
555 | <pre> ev_periodic_set (&periodic, 0., 3600., 0); |
529 | |
556 | |
530 | </pre> |
557 | </pre> |
531 | <p>This doesn't mean there will always be 3600 seconds in between triggers, |
558 | <p>This doesn't mean there will always be 3600 seconds in between triggers, |
532 | but only that the the callback will be called when the system time shows a |
559 | but only that the the callback will be called when the system time shows a |
533 | full hour (UTC), or more correct, when the system time is evenly divisible |
560 | full hour (UTC), or more correctly, when the system time is evenly divisible |
534 | by 3600.</p> |
561 | by 3600.</p> |
535 | <p>Another way to think about it (for the mathematically inclined) is that |
562 | <p>Another way to think about it (for the mathematically inclined) is that |
536 | ev_periodic will try to run the callback in this mode at the next possible |
563 | <code>ev_periodic</code> will try to run the callback in this mode at the next possible |
537 | time where <code>time = at (mod interval)</code>, regardless of any time jumps.</p> |
564 | time where <code>time = at (mod interval)</code>, regardless of any time jumps.</p> |
538 | </dd> |
565 | </dd> |
539 | <dt>* manual reschedule mode (reschedule_cb = callback)</dt> |
566 | <dt>* manual reschedule mode (reschedule_cb = callback)</dt> |
540 | <dd> |
567 | <dd> |
541 | <p>In this mode the values for <code>interval</code> and <code>at</code> are both being |
568 | <p>In this mode the values for <code>interval</code> and <code>at</code> are both being |
542 | ignored. Instead, each time the periodic watcher gets scheduled, the |
569 | ignored. Instead, each time the periodic watcher gets scheduled, the |
543 | reschedule callback will be called with the watcher as first, and the |
570 | reschedule callback will be called with the watcher as first, and the |
544 | current time as second argument.</p> |
571 | current time as second argument.</p> |
545 | <p>NOTE: <i>This callback MUST NOT stop or destroy the periodic or any other |
572 | <p>NOTE: <i>This callback MUST NOT stop or destroy the periodic or any other |
546 | periodic watcher, ever, or make any event loop modificstions</i>. If you need |
573 | periodic watcher, ever, or make any event loop modifications</i>. If you need |
547 | to stop it, return 1e30 (or so, fudge fudge) and stop it afterwards.</p> |
574 | to stop it, return <code>now + 1e30</code> (or so, fudge fudge) and stop it afterwards.</p> |
|
|
575 | <p>Also, <i>this callback must always return a time that is later than the |
|
|
576 | passed <code>now</code> value</i>. Not even <code>now</code> itself will be ok.</p> |
548 | <p>Its prototype is c<ev_tstamp (*reschedule_cb)(struct ev_periodic *w, |
577 | <p>Its prototype is <code>ev_tstamp (*reschedule_cb)(struct ev_periodic *w, |
549 | ev_tstamp now)>, e.g.:</p> |
578 | ev_tstamp now)</code>, e.g.:</p> |
550 | <pre> static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now) |
579 | <pre> static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now) |
551 | { |
580 | { |
552 | return now + 60.; |
581 | return now + 60.; |
553 | } |
582 | } |
554 | |
583 | |
… | |
… | |
573 | program when the crontabs have changed).</p> |
602 | program when the crontabs have changed).</p> |
574 | </dd> |
603 | </dd> |
575 | </dl> |
604 | </dl> |
576 | |
605 | |
577 | </div> |
606 | </div> |
578 | <h2 id="ev_signal_signal_me_when_a_signal_ge">ev_signal - signal me when a signal gets signalled</h2> |
607 | <h2 id="code_ev_signal_code_signal_me_when_a"><code>ev_signal</code> - signal me when a signal gets signalled</h2> |
579 | <div id="ev_signal_signal_me_when_a_signal_ge-2"> |
608 | <div id="code_ev_signal_code_signal_me_when_a-2"> |
580 | <p>Signal watchers will trigger an event when the process receives a specific |
609 | <p>Signal watchers will trigger an event when the process receives a specific |
581 | signal one or more times. Even though signals are very asynchronous, libev |
610 | signal one or more times. Even though signals are very asynchronous, libev |
582 | will try its best to deliver signals synchronously, i.e. as part of the |
611 | will try it's best to deliver signals synchronously, i.e. as part of the |
583 | normal event processing, like any other event.</p> |
612 | normal event processing, like any other event.</p> |
584 | <p>You cna configure as many watchers as you like per signal. Only when the |
613 | <p>You can configure as many watchers as you like per signal. Only when the |
585 | first watcher gets started will libev actually register a signal watcher |
614 | first watcher gets started will libev actually register a signal watcher |
586 | with the kernel (thus it coexists with your own signal handlers as long |
615 | with the kernel (thus it coexists with your own signal handlers as long |
587 | as you don't register any with libev). Similarly, when the last signal |
616 | as you don't register any with libev). Similarly, when the last signal |
588 | watcher for a signal is stopped libev will reset the signal handler to |
617 | watcher for a signal is stopped libev will reset the signal handler to |
589 | SIG_DFL (regardless of what it was set to before).</p> |
618 | SIG_DFL (regardless of what it was set to before).</p> |
… | |
… | |
595 | of the <code>SIGxxx</code> constants).</p> |
624 | of the <code>SIGxxx</code> constants).</p> |
596 | </dd> |
625 | </dd> |
597 | </dl> |
626 | </dl> |
598 | |
627 | |
599 | </div> |
628 | </div> |
600 | <h2 id="ev_child_wait_for_pid_status_changes">ev_child - wait for pid status changes</h2> |
629 | <h2 id="code_ev_child_code_wait_for_pid_stat"><code>ev_child</code> - wait for pid status changes</h2> |
601 | <div id="ev_child_wait_for_pid_status_changes-2"> |
630 | <div id="code_ev_child_code_wait_for_pid_stat-2"> |
602 | <p>Child watchers trigger when your process receives a SIGCHLD in response to |
631 | <p>Child watchers trigger when your process receives a SIGCHLD in response to |
603 | some child status changes (most typically when a child of yours dies).</p> |
632 | some child status changes (most typically when a child of yours dies).</p> |
604 | <dl> |
633 | <dl> |
605 | <dt>ev_child_init (ev_child *, callback, int pid)</dt> |
634 | <dt>ev_child_init (ev_child *, callback, int pid)</dt> |
606 | <dt>ev_child_set (ev_child *, int pid)</dt> |
635 | <dt>ev_child_set (ev_child *, int pid)</dt> |
607 | <dd> |
636 | <dd> |
608 | <p>Configures the watcher to wait for status changes of process <code>pid</code> (or |
637 | <p>Configures the watcher to wait for status changes of process <code>pid</code> (or |
609 | <i>any</i> process if <code>pid</code> is specified as <code>0</code>). The callback can look |
638 | <i>any</i> process if <code>pid</code> is specified as <code>0</code>). The callback can look |
610 | at the <code>rstatus</code> member of the <code>ev_child</code> watcher structure to see |
639 | at the <code>rstatus</code> member of the <code>ev_child</code> watcher structure to see |
611 | the status word (use the macros from <code>sys/wait.h</code>). The <code>rpid</code> member |
640 | the status word (use the macros from <code>sys/wait.h</code> and see your systems |
|
|
641 | <code>waitpid</code> documentation). The <code>rpid</code> member contains the pid of the |
612 | contains the pid of the process causing the status change.</p> |
642 | process causing the status change.</p> |
613 | </dd> |
643 | </dd> |
614 | </dl> |
644 | </dl> |
615 | |
645 | |
616 | </div> |
646 | </div> |
617 | <h2 id="ev_idle_when_you_ve_got_nothing_bett">ev_idle - when you've got nothing better to do</h2> |
647 | <h2 id="code_ev_idle_code_when_you_ve_got_no"><code>ev_idle</code> - when you've got nothing better to do</h2> |
618 | <div id="ev_idle_when_you_ve_got_nothing_bett-2"> |
648 | <div id="code_ev_idle_code_when_you_ve_got_no-2"> |
619 | <p>Idle watchers trigger events when there are no other I/O or timer (or |
649 | <p>Idle watchers trigger events when there are no other events are pending |
620 | periodic) events pending. That is, as long as your process is busy |
650 | (prepare, check and other idle watchers do not count). That is, as long |
621 | handling sockets or timeouts it will not be called. But when your process |
651 | as your process is busy handling sockets or timeouts (or even signals, |
622 | is idle all idle watchers are being called again and again - until |
652 | imagine) it will not be triggered. But when your process is idle all idle |
|
|
653 | watchers are being called again and again, once per event loop iteration - |
623 | stopped, that is, or your process receives more events.</p> |
654 | until stopped, that is, or your process receives more events and becomes |
|
|
655 | busy.</p> |
624 | <p>The most noteworthy effect is that as long as any idle watchers are |
656 | <p>The most noteworthy effect is that as long as any idle watchers are |
625 | active, the process will not block when waiting for new events.</p> |
657 | active, the process will not block when waiting for new events.</p> |
626 | <p>Apart from keeping your process non-blocking (which is a useful |
658 | <p>Apart from keeping your process non-blocking (which is a useful |
627 | effect on its own sometimes), idle watchers are a good place to do |
659 | effect on its own sometimes), idle watchers are a good place to do |
628 | "pseudo-background processing", or delay processing stuff to after the |
660 | "pseudo-background processing", or delay processing stuff to after the |
… | |
… | |
635 | believe me.</p> |
667 | believe me.</p> |
636 | </dd> |
668 | </dd> |
637 | </dl> |
669 | </dl> |
638 | |
670 | |
639 | </div> |
671 | </div> |
640 | <h2 id="prepare_and_check_your_hooks_into_th">prepare and check - your hooks into the event loop</h2> |
672 | <h2 id="code_ev_prepare_code_and_code_ev_che"><code>ev_prepare</code> and <code>ev_check</code> - customise your event loop</h2> |
641 | <div id="prepare_and_check_your_hooks_into_th-2"> |
673 | <div id="code_ev_prepare_code_and_code_ev_che-2"> |
642 | <p>Prepare and check watchers usually (but not always) are used in |
674 | <p>Prepare and check watchers are usually (but not always) used in tandem: |
643 | tandom. Prepare watchers get invoked before the process blocks and check |
675 | Prepare watchers get invoked before the process blocks and check watchers |
644 | watchers afterwards.</p> |
676 | afterwards.</p> |
645 | <p>Their main purpose is to integrate other event mechanisms into libev. This |
677 | <p>Their main purpose is to integrate other event mechanisms into libev. This |
646 | could be used, for example, to track variable changes, implement your own |
678 | could be used, for example, to track variable changes, implement your own |
647 | watchers, integrate net-snmp or a coroutine library and lots more.</p> |
679 | watchers, integrate net-snmp or a coroutine library and lots more.</p> |
648 | <p>This is done by examining in each prepare call which file descriptors need |
680 | <p>This is done by examining in each prepare call which file descriptors need |
649 | to be watched by the other library, registering ev_io watchers for them |
681 | to be watched by the other library, registering <code>ev_io</code> watchers for |
650 | and starting an ev_timer watcher for any timeouts (many libraries provide |
682 | them and starting an <code>ev_timer</code> watcher for any timeouts (many libraries |
651 | just this functionality). Then, in the check watcher you check for any |
683 | provide just this functionality). Then, in the check watcher you check for |
652 | events that occured (by making your callbacks set soem flags for example) |
684 | any events that occured (by checking the pending status of all watchers |
653 | and call back into the library.</p> |
685 | and stopping them) and call back into the library. The I/O and timer |
|
|
686 | callbacks will never actually be called (but must be valid neverthelles, |
|
|
687 | because you never know, you know?).</p> |
654 | <p>As another example, the perl Coro module uses these hooks to integrate |
688 | <p>As another example, the Perl Coro module uses these hooks to integrate |
655 | coroutines into libev programs, by yielding to other active coroutines |
689 | coroutines into libev programs, by yielding to other active coroutines |
656 | during each prepare and only letting the process block if no coroutines |
690 | during each prepare and only letting the process block if no coroutines |
657 | are ready to run.</p> |
691 | are ready to run (its actually more complicated, it only runs coroutines |
|
|
692 | with priority higher than the event loop and one lower priority once, |
|
|
693 | using idle watchers to keep the event loop from blocking if lower-priority |
|
|
694 | coroutines exist, thus mapping low-priority coroutines to idle/background |
|
|
695 | tasks).</p> |
658 | <dl> |
696 | <dl> |
659 | <dt>ev_prepare_init (ev_prepare *, callback)</dt> |
697 | <dt>ev_prepare_init (ev_prepare *, callback)</dt> |
660 | <dt>ev_check_init (ev_check *, callback)</dt> |
698 | <dt>ev_check_init (ev_check *, callback)</dt> |
661 | <dd> |
699 | <dd> |
662 | <p>Initialises and configures the prepare or check watcher - they have no |
700 | <p>Initialises and configures the prepare or check watcher - they have no |
663 | parameters of any kind. There are <code>ev_prepare_set</code> and <code>ev_check_set</code> |
701 | parameters of any kind. There are <code>ev_prepare_set</code> and <code>ev_check_set</code> |
664 | macros, but using them is utterly, utterly pointless.</p> |
702 | macros, but using them is utterly, utterly and completely pointless.</p> |
665 | </dd> |
703 | </dd> |
666 | </dl> |
704 | </dl> |
667 | |
705 | |
668 | </div> |
706 | </div> |
669 | <h1 id="OTHER_FUNCTIONS">OTHER FUNCTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p> |
707 | <h1 id="OTHER_FUNCTIONS">OTHER FUNCTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p> |
670 | <div id="OTHER_FUNCTIONS_CONTENT"> |
708 | <div id="OTHER_FUNCTIONS_CONTENT"> |
671 | <p>There are some other fucntions of possible interest. Described. Here. Now.</p> |
709 | <p>There are some other functions of possible interest. Described. Here. Now.</p> |
672 | <dl> |
710 | <dl> |
673 | <dt>ev_once (loop, int fd, int events, ev_tstamp timeout, callback)</dt> |
711 | <dt>ev_once (loop, int fd, int events, ev_tstamp timeout, callback)</dt> |
674 | <dd> |
712 | <dd> |
675 | <p>This function combines a simple timer and an I/O watcher, calls your |
713 | <p>This function combines a simple timer and an I/O watcher, calls your |
676 | callback on whichever event happens first and automatically stop both |
714 | callback on whichever event happens first and automatically stop both |
677 | watchers. This is useful if you want to wait for a single event on an fd |
715 | watchers. This is useful if you want to wait for a single event on an fd |
678 | or timeout without havign to allocate/configure/start/stop/free one or |
716 | or timeout without havign to allocate/configure/start/stop/free one or |
679 | more watchers yourself.</p> |
717 | more watchers yourself.</p> |
680 | <p>If <code>fd</code> is less than 0, then no I/O watcher will be started and events is |
718 | <p>If <code>fd</code> is less than 0, then no I/O watcher will be started and events |
681 | ignored. Otherwise, an ev_io watcher for the given <code>fd</code> and <code>events</code> set |
719 | is being ignored. Otherwise, an <code>ev_io</code> watcher for the given <code>fd</code> and |
682 | will be craeted and started.</p> |
720 | <code>events</code> set will be craeted and started.</p> |
683 | <p>If <code>timeout</code> is less than 0, then no timeout watcher will be |
721 | <p>If <code>timeout</code> is less than 0, then no timeout watcher will be |
684 | started. Otherwise an ev_timer watcher with after = <code>timeout</code> (and repeat |
722 | started. Otherwise an <code>ev_timer</code> watcher with after = <code>timeout</code> (and |
685 | = 0) will be started.</p> |
723 | repeat = 0) will be started. While <code>0</code> is a valid timeout, it is of |
|
|
724 | dubious value.</p> |
686 | <p>The callback has the type <code>void (*cb)(int revents, void *arg)</code> and |
725 | <p>The callback has the type <code>void (*cb)(int revents, void *arg)</code> and gets |
687 | gets passed an events set (normally a combination of EV_ERROR, EV_READ, |
726 | passed an events set like normal event callbacks (with a combination of |
688 | EV_WRITE or EV_TIMEOUT) and the <code>arg</code> value passed to <code>ev_once</code>:</p> |
727 | <code>EV_ERROR</code>, <code>EV_READ</code>, <code>EV_WRITE</code> or <code>EV_TIMEOUT</code>) and the <code>arg</code> |
|
|
728 | value passed to <code>ev_once</code>:</p> |
689 | <pre> static void stdin_ready (int revents, void *arg) |
729 | <pre> static void stdin_ready (int revents, void *arg) |
690 | { |
730 | { |
691 | if (revents & EV_TIMEOUT) |
731 | if (revents & EV_TIMEOUT) |
692 | /* doh, nothing entered */ |
732 | /* doh, nothing entered */; |
693 | else if (revents & EV_READ) |
733 | else if (revents & EV_READ) |
694 | /* stdin might have data for us, joy! */ |
734 | /* stdin might have data for us, joy! */; |
695 | } |
735 | } |
696 | |
736 | |
697 | ev_once (STDIN_FILENO, EV_READm 10., stdin_ready, 0); |
737 | ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); |
698 | |
738 | |
699 | </pre> |
739 | </pre> |
700 | </dd> |
740 | </dd> |
701 | <dt>ev_feed_event (loop, watcher, int events)</dt> |
741 | <dt>ev_feed_event (loop, watcher, int events)</dt> |
702 | <dd> |
742 | <dd> |
703 | <p>Feeds the given event set into the event loop, as if the specified event |
743 | <p>Feeds the given event set into the event loop, as if the specified event |
704 | has happened for the specified watcher (which must be a pointer to an |
744 | had happened for the specified watcher (which must be a pointer to an |
705 | initialised but not necessarily active event watcher).</p> |
745 | initialised but not necessarily started event watcher).</p> |
706 | </dd> |
746 | </dd> |
707 | <dt>ev_feed_fd_event (loop, int fd, int revents)</dt> |
747 | <dt>ev_feed_fd_event (loop, int fd, int revents)</dt> |
708 | <dd> |
748 | <dd> |
709 | <p>Feed an event on the given fd, as if a file descriptor backend detected it.</p> |
749 | <p>Feed an event on the given fd, as if a file descriptor backend detected |
|
|
750 | the given events it.</p> |
710 | </dd> |
751 | </dd> |
711 | <dt>ev_feed_signal_event (loop, int signum)</dt> |
752 | <dt>ev_feed_signal_event (loop, int signum)</dt> |
712 | <dd> |
753 | <dd> |
713 | <p>Feed an event as if the given signal occured (loop must be the default loop!).</p> |
754 | <p>Feed an event as if the given signal occured (loop must be the default loop!).</p> |
714 | </dd> |
755 | </dd> |