… | |
… | |
2 | |
2 | |
3 | libev - a high performance full-featured event loop written in C |
3 | libev - a high performance full-featured event loop written in C |
4 | |
4 | |
5 | =head1 SYNOPSIS |
5 | =head1 SYNOPSIS |
6 | |
6 | |
7 | #include <ev.h> |
7 | #include <ev.h> |
8 | |
8 | |
9 | =head2 EXAMPLE PROGRAM |
9 | =head2 EXAMPLE PROGRAM |
10 | |
10 | |
11 | // a single header file is required |
11 | // a single header file is required |
12 | #include <ev.h> |
12 | #include <ev.h> |
13 | |
13 | |
14 | // every watcher type has its own typedef'd struct |
14 | // every watcher type has its own typedef'd struct |
15 | // with the name ev_<type> |
15 | // with the name ev_<type> |
16 | ev_io stdin_watcher; |
16 | ev_io stdin_watcher; |
17 | ev_timer timeout_watcher; |
17 | ev_timer timeout_watcher; |
18 | |
18 | |
19 | // all watcher callbacks have a similar signature |
19 | // all watcher callbacks have a similar signature |
20 | // this callback is called when data is readable on stdin |
20 | // this callback is called when data is readable on stdin |
21 | static void |
21 | static void |
22 | stdin_cb (EV_P_ struct ev_io *w, int revents) |
22 | stdin_cb (EV_P_ struct ev_io *w, int revents) |
23 | { |
23 | { |
24 | puts ("stdin ready"); |
24 | puts ("stdin ready"); |
25 | // for one-shot events, one must manually stop the watcher |
25 | // for one-shot events, one must manually stop the watcher |
26 | // with its corresponding stop function. |
26 | // with its corresponding stop function. |
27 | ev_io_stop (EV_A_ w); |
27 | ev_io_stop (EV_A_ w); |
28 | |
28 | |
29 | // this causes all nested ev_loop's to stop iterating |
29 | // this causes all nested ev_loop's to stop iterating |
30 | ev_unloop (EV_A_ EVUNLOOP_ALL); |
30 | ev_unloop (EV_A_ EVUNLOOP_ALL); |
31 | } |
31 | } |
32 | |
32 | |
33 | // another callback, this time for a time-out |
33 | // another callback, this time for a time-out |
34 | static void |
34 | static void |
35 | timeout_cb (EV_P_ struct ev_timer *w, int revents) |
35 | timeout_cb (EV_P_ struct ev_timer *w, int revents) |
36 | { |
36 | { |
37 | puts ("timeout"); |
37 | puts ("timeout"); |
38 | // this causes the innermost ev_loop to stop iterating |
38 | // this causes the innermost ev_loop to stop iterating |
39 | ev_unloop (EV_A_ EVUNLOOP_ONE); |
39 | ev_unloop (EV_A_ EVUNLOOP_ONE); |
40 | } |
40 | } |
41 | |
41 | |
42 | int |
42 | int |
43 | main (void) |
43 | main (void) |
44 | { |
44 | { |
45 | // use the default event loop unless you have special needs |
45 | // use the default event loop unless you have special needs |
46 | struct ev_loop *loop = ev_default_loop (0); |
46 | struct ev_loop *loop = ev_default_loop (0); |
47 | |
47 | |
48 | // initialise an io watcher, then start it |
48 | // initialise an io watcher, then start it |
49 | // this one will watch for stdin to become readable |
49 | // this one will watch for stdin to become readable |
50 | ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ); |
50 | ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ); |
51 | ev_io_start (loop, &stdin_watcher); |
51 | ev_io_start (loop, &stdin_watcher); |
52 | |
52 | |
53 | // initialise a timer watcher, then start it |
53 | // initialise a timer watcher, then start it |
54 | // simple non-repeating 5.5 second timeout |
54 | // simple non-repeating 5.5 second timeout |
55 | ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.); |
55 | ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.); |
56 | ev_timer_start (loop, &timeout_watcher); |
56 | ev_timer_start (loop, &timeout_watcher); |
57 | |
57 | |
58 | // now wait for events to arrive |
58 | // now wait for events to arrive |
59 | ev_loop (loop, 0); |
59 | ev_loop (loop, 0); |
60 | |
60 | |
61 | // unloop was called, so exit |
61 | // unloop was called, so exit |
62 | return 0; |
62 | return 0; |
63 | } |
63 | } |
64 | |
64 | |
65 | =head1 DESCRIPTION |
65 | =head1 DESCRIPTION |
66 | |
66 | |
67 | The newest version of this document is also available as an html-formatted |
67 | The newest version of this document is also available as an html-formatted |
68 | web page you might find easier to navigate when reading it for the first |
68 | web page you might find easier to navigate when reading it for the first |
… | |
… | |
113 | Libev represents time as a single floating point number, representing the |
113 | Libev represents time as a single floating point number, representing the |
114 | (fractional) number of seconds since the (POSIX) epoch (somewhere near |
114 | (fractional) number of seconds since the (POSIX) epoch (somewhere near |
115 | the beginning of 1970, details are complicated, don't ask). This type is |
115 | the beginning of 1970, details are complicated, don't ask). This type is |
116 | called C<ev_tstamp>, which is what you should use too. It usually aliases |
116 | called C<ev_tstamp>, which is what you should use too. It usually aliases |
117 | to the C<double> type in C, and when you need to do any calculations on |
117 | to the C<double> type in C, and when you need to do any calculations on |
118 | it, you should treat it as some floatingpoint value. Unlike the name |
118 | it, you should treat it as some floating point value. Unlike the name |
119 | component C<stamp> might indicate, it is also used for time differences |
119 | component C<stamp> might indicate, it is also used for time differences |
120 | throughout libev. |
120 | throughout libev. |
|
|
121 | |
|
|
122 | =head1 ERROR HANDLING |
|
|
123 | |
|
|
124 | Libev knows three classes of errors: operating system errors, usage errors |
|
|
125 | and internal errors (bugs). |
|
|
126 | |
|
|
127 | When libev catches an operating system error it cannot handle (for example |
|
|
128 | a system call indicating a condition libev cannot fix), it calls the callback |
|
|
129 | set via C<ev_set_syserr_cb>, which is supposed to fix the problem or |
|
|
130 | abort. The default is to print a diagnostic message and to call C<abort |
|
|
131 | ()>. |
|
|
132 | |
|
|
133 | When libev detects a usage error such as a negative timer interval, then |
|
|
134 | it will print a diagnostic message and abort (via the C<assert> mechanism, |
|
|
135 | so C<NDEBUG> will disable this checking): these are programming errors in |
|
|
136 | the libev caller and need to be fixed there. |
|
|
137 | |
|
|
138 | Libev also has a few internal error-checking C<assert>ions, and also has |
|
|
139 | extensive consistency checking code. These do not trigger under normal |
|
|
140 | circumstances, as they indicate either a bug in libev or worse. |
|
|
141 | |
121 | |
142 | |
122 | =head1 GLOBAL FUNCTIONS |
143 | =head1 GLOBAL FUNCTIONS |
123 | |
144 | |
124 | These functions can be called anytime, even before initialising the |
145 | These functions can be called anytime, even before initialising the |
125 | library in any way. |
146 | library in any way. |
… | |
… | |
134 | |
155 | |
135 | =item ev_sleep (ev_tstamp interval) |
156 | =item ev_sleep (ev_tstamp interval) |
136 | |
157 | |
137 | Sleep for the given interval: The current thread will be blocked until |
158 | Sleep for the given interval: The current thread will be blocked until |
138 | either it is interrupted or the given time interval has passed. Basically |
159 | either it is interrupted or the given time interval has passed. Basically |
139 | this is a subsecond-resolution C<sleep ()>. |
160 | this is a sub-second-resolution C<sleep ()>. |
140 | |
161 | |
141 | =item int ev_version_major () |
162 | =item int ev_version_major () |
142 | |
163 | |
143 | =item int ev_version_minor () |
164 | =item int ev_version_minor () |
144 | |
165 | |
… | |
… | |
157 | not a problem. |
178 | not a problem. |
158 | |
179 | |
159 | Example: Make sure we haven't accidentally been linked against the wrong |
180 | Example: Make sure we haven't accidentally been linked against the wrong |
160 | version. |
181 | version. |
161 | |
182 | |
162 | assert (("libev version mismatch", |
183 | assert (("libev version mismatch", |
163 | ev_version_major () == EV_VERSION_MAJOR |
184 | ev_version_major () == EV_VERSION_MAJOR |
164 | && ev_version_minor () >= EV_VERSION_MINOR)); |
185 | && ev_version_minor () >= EV_VERSION_MINOR)); |
165 | |
186 | |
166 | =item unsigned int ev_supported_backends () |
187 | =item unsigned int ev_supported_backends () |
167 | |
188 | |
168 | Return the set of all backends (i.e. their corresponding C<EV_BACKEND_*> |
189 | Return the set of all backends (i.e. their corresponding C<EV_BACKEND_*> |
169 | value) compiled into this binary of libev (independent of their |
190 | value) compiled into this binary of libev (independent of their |
… | |
… | |
171 | a description of the set values. |
192 | a description of the set values. |
172 | |
193 | |
173 | Example: make sure we have the epoll method, because yeah this is cool and |
194 | Example: make sure we have the epoll method, because yeah this is cool and |
174 | a must have and can we have a torrent of it please!!!11 |
195 | a must have and can we have a torrent of it please!!!11 |
175 | |
196 | |
176 | assert (("sorry, no epoll, no sex", |
197 | assert (("sorry, no epoll, no sex", |
177 | ev_supported_backends () & EVBACKEND_EPOLL)); |
198 | ev_supported_backends () & EVBACKEND_EPOLL)); |
178 | |
199 | |
179 | =item unsigned int ev_recommended_backends () |
200 | =item unsigned int ev_recommended_backends () |
180 | |
201 | |
181 | Return the set of all backends compiled into this binary of libev and also |
202 | Return the set of all backends compiled into this binary of libev and also |
182 | recommended for this platform. This set is often smaller than the one |
203 | recommended for this platform. This set is often smaller than the one |
183 | returned by C<ev_supported_backends>, as for example kqueue is broken on |
204 | returned by C<ev_supported_backends>, as for example kqueue is broken on |
184 | most BSDs and will not be autodetected unless you explicitly request it |
205 | most BSDs and will not be auto-detected unless you explicitly request it |
185 | (assuming you know what you are doing). This is the set of backends that |
206 | (assuming you know what you are doing). This is the set of backends that |
186 | libev will probe for if you specify no backends explicitly. |
207 | libev will probe for if you specify no backends explicitly. |
187 | |
208 | |
188 | =item unsigned int ev_embeddable_backends () |
209 | =item unsigned int ev_embeddable_backends () |
189 | |
210 | |
… | |
… | |
231 | ... |
252 | ... |
232 | ev_set_allocator (persistent_realloc); |
253 | ev_set_allocator (persistent_realloc); |
233 | |
254 | |
234 | =item ev_set_syserr_cb (void (*cb)(const char *msg)); |
255 | =item ev_set_syserr_cb (void (*cb)(const char *msg)); |
235 | |
256 | |
236 | Set the callback function to call on a retryable syscall error (such |
257 | Set the callback function to call on a retryable system call error (such |
237 | as failed select, poll, epoll_wait). The message is a printable string |
258 | as failed select, poll, epoll_wait). The message is a printable string |
238 | indicating the system call or subsystem causing the problem. If this |
259 | indicating the system call or subsystem causing the problem. If this |
239 | callback is set, then libev will expect it to remedy the sitution, no |
260 | callback is set, then libev will expect it to remedy the situation, no |
240 | matter what, when it returns. That is, libev will generally retry the |
261 | matter what, when it returns. That is, libev will generally retry the |
241 | requested operation, or, if the condition doesn't go away, do bad stuff |
262 | requested operation, or, if the condition doesn't go away, do bad stuff |
242 | (such as abort). |
263 | (such as abort). |
243 | |
264 | |
244 | Example: This is basically the same thing that libev does internally, too. |
265 | Example: This is basically the same thing that libev does internally, too. |
… | |
… | |
277 | from multiple threads, you have to lock (note also that this is unlikely, |
298 | from multiple threads, you have to lock (note also that this is unlikely, |
278 | as loops cannot bes hared easily between threads anyway). |
299 | as loops cannot bes hared easily between threads anyway). |
279 | |
300 | |
280 | The default loop is the only loop that can handle C<ev_signal> and |
301 | The default loop is the only loop that can handle C<ev_signal> and |
281 | C<ev_child> watchers, and to do this, it always registers a handler |
302 | C<ev_child> watchers, and to do this, it always registers a handler |
282 | for C<SIGCHLD>. If this is a problem for your app you can either |
303 | for C<SIGCHLD>. If this is a problem for your application you can either |
283 | create a dynamic loop with C<ev_loop_new> that doesn't do that, or you |
304 | create a dynamic loop with C<ev_loop_new> that doesn't do that, or you |
284 | can simply overwrite the C<SIGCHLD> signal handler I<after> calling |
305 | can simply overwrite the C<SIGCHLD> signal handler I<after> calling |
285 | C<ev_default_init>. |
306 | C<ev_default_init>. |
286 | |
307 | |
287 | The flags argument can be used to specify special behaviour or specific |
308 | The flags argument can be used to specify special behaviour or specific |
… | |
… | |
296 | The default flags value. Use this if you have no clue (it's the right |
317 | The default flags value. Use this if you have no clue (it's the right |
297 | thing, believe me). |
318 | thing, believe me). |
298 | |
319 | |
299 | =item C<EVFLAG_NOENV> |
320 | =item C<EVFLAG_NOENV> |
300 | |
321 | |
301 | If this flag bit is ored into the flag value (or the program runs setuid |
322 | If this flag bit is or'ed into the flag value (or the program runs setuid |
302 | or setgid) then libev will I<not> look at the environment variable |
323 | or setgid) then libev will I<not> look at the environment variable |
303 | C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will |
324 | C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will |
304 | override the flags completely if it is found in the environment. This is |
325 | override the flags completely if it is found in the environment. This is |
305 | useful to try out specific backends to test their performance, or to work |
326 | useful to try out specific backends to test their performance, or to work |
306 | around bugs. |
327 | around bugs. |
… | |
… | |
313 | |
334 | |
314 | This works by calling C<getpid ()> on every iteration of the loop, |
335 | This works by calling C<getpid ()> on every iteration of the loop, |
315 | and thus this might slow down your event loop if you do a lot of loop |
336 | and thus this might slow down your event loop if you do a lot of loop |
316 | iterations and little real work, but is usually not noticeable (on my |
337 | iterations and little real work, but is usually not noticeable (on my |
317 | GNU/Linux system for example, C<getpid> is actually a simple 5-insn sequence |
338 | GNU/Linux system for example, C<getpid> is actually a simple 5-insn sequence |
318 | without a syscall and thus I<very> fast, but my GNU/Linux system also has |
339 | without a system call and thus I<very> fast, but my GNU/Linux system also has |
319 | C<pthread_atfork> which is even faster). |
340 | C<pthread_atfork> which is even faster). |
320 | |
341 | |
321 | The big advantage of this flag is that you can forget about fork (and |
342 | The big advantage of this flag is that you can forget about fork (and |
322 | forget about forgetting to tell libev about forking) when you use this |
343 | forget about forgetting to tell libev about forking) when you use this |
323 | flag. |
344 | flag. |
324 | |
345 | |
325 | This flag setting cannot be overriden or specified in the C<LIBEV_FLAGS> |
346 | This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS> |
326 | environment variable. |
347 | environment variable. |
327 | |
348 | |
328 | =item C<EVBACKEND_SELECT> (value 1, portable select backend) |
349 | =item C<EVBACKEND_SELECT> (value 1, portable select backend) |
329 | |
350 | |
330 | This is your standard select(2) backend. Not I<completely> standard, as |
351 | This is your standard select(2) backend. Not I<completely> standard, as |
… | |
… | |
332 | but if that fails, expect a fairly low limit on the number of fds when |
353 | but if that fails, expect a fairly low limit on the number of fds when |
333 | using this backend. It doesn't scale too well (O(highest_fd)), but its |
354 | using this backend. It doesn't scale too well (O(highest_fd)), but its |
334 | usually the fastest backend for a low number of (low-numbered :) fds. |
355 | usually the fastest backend for a low number of (low-numbered :) fds. |
335 | |
356 | |
336 | To get good performance out of this backend you need a high amount of |
357 | To get good performance out of this backend you need a high amount of |
337 | parallelity (most of the file descriptors should be busy). If you are |
358 | parallelism (most of the file descriptors should be busy). If you are |
338 | writing a server, you should C<accept ()> in a loop to accept as many |
359 | writing a server, you should C<accept ()> in a loop to accept as many |
339 | connections as possible during one iteration. You might also want to have |
360 | connections as possible during one iteration. You might also want to have |
340 | a look at C<ev_set_io_collect_interval ()> to increase the amount of |
361 | a look at C<ev_set_io_collect_interval ()> to increase the amount of |
341 | readyness notifications you get per iteration. |
362 | readiness notifications you get per iteration. |
342 | |
363 | |
343 | =item C<EVBACKEND_POLL> (value 2, poll backend, available everywhere except on windows) |
364 | =item C<EVBACKEND_POLL> (value 2, poll backend, available everywhere except on windows) |
344 | |
365 | |
345 | And this is your standard poll(2) backend. It's more complicated |
366 | And this is your standard poll(2) backend. It's more complicated |
346 | than select, but handles sparse fds better and has no artificial |
367 | than select, but handles sparse fds better and has no artificial |
… | |
… | |
354 | For few fds, this backend is a bit little slower than poll and select, |
375 | For few fds, this backend is a bit little slower than poll and select, |
355 | but it scales phenomenally better. While poll and select usually scale |
376 | but it scales phenomenally better. While poll and select usually scale |
356 | like O(total_fds) where n is the total number of fds (or the highest fd), |
377 | like O(total_fds) where n is the total number of fds (or the highest fd), |
357 | epoll scales either O(1) or O(active_fds). The epoll design has a number |
378 | epoll scales either O(1) or O(active_fds). The epoll design has a number |
358 | of shortcomings, such as silently dropping events in some hard-to-detect |
379 | of shortcomings, such as silently dropping events in some hard-to-detect |
359 | cases and requiring a syscall per fd change, no fork support and bad |
380 | cases and requiring a system call per fd change, no fork support and bad |
360 | support for dup. |
381 | support for dup. |
361 | |
382 | |
362 | While stopping, setting and starting an I/O watcher in the same iteration |
383 | While stopping, setting and starting an I/O watcher in the same iteration |
363 | will result in some caching, there is still a syscall per such incident |
384 | will result in some caching, there is still a system call per such incident |
364 | (because the fd could point to a different file description now), so its |
385 | (because the fd could point to a different file description now), so its |
365 | best to avoid that. Also, C<dup ()>'ed file descriptors might not work |
386 | best to avoid that. Also, C<dup ()>'ed file descriptors might not work |
366 | very well if you register events for both fds. |
387 | very well if you register events for both fds. |
367 | |
388 | |
368 | Please note that epoll sometimes generates spurious notifications, so you |
389 | Please note that epoll sometimes generates spurious notifications, so you |
… | |
… | |
371 | |
392 | |
372 | Best performance from this backend is achieved by not unregistering all |
393 | Best performance from this backend is achieved by not unregistering all |
373 | watchers for a file descriptor until it has been closed, if possible, i.e. |
394 | watchers for a file descriptor until it has been closed, if possible, i.e. |
374 | keep at least one watcher active per fd at all times. |
395 | keep at least one watcher active per fd at all times. |
375 | |
396 | |
376 | While nominally embeddeble in other event loops, this feature is broken in |
397 | While nominally embeddable in other event loops, this feature is broken in |
377 | all kernel versions tested so far. |
398 | all kernel versions tested so far. |
378 | |
399 | |
379 | =item C<EVBACKEND_KQUEUE> (value 8, most BSD clones) |
400 | =item C<EVBACKEND_KQUEUE> (value 8, most BSD clones) |
380 | |
401 | |
381 | Kqueue deserves special mention, as at the time of this writing, it |
402 | Kqueue deserves special mention, as at the time of this writing, it |
382 | was broken on all BSDs except NetBSD (usually it doesn't work reliably |
403 | was broken on all BSDs except NetBSD (usually it doesn't work reliably |
383 | with anything but sockets and pipes, except on Darwin, where of course |
404 | with anything but sockets and pipes, except on Darwin, where of course |
384 | it's completely useless). For this reason it's not being "autodetected" |
405 | it's completely useless). For this reason it's not being "auto-detected" |
385 | unless you explicitly specify it explicitly in the flags (i.e. using |
406 | unless you explicitly specify it explicitly in the flags (i.e. using |
386 | C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough) |
407 | C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough) |
387 | system like NetBSD. |
408 | system like NetBSD. |
388 | |
409 | |
389 | You still can embed kqueue into a normal poll or select backend and use it |
410 | You still can embed kqueue into a normal poll or select backend and use it |
… | |
… | |
391 | the target platform). See C<ev_embed> watchers for more info. |
412 | the target platform). See C<ev_embed> watchers for more info. |
392 | |
413 | |
393 | It scales in the same way as the epoll backend, but the interface to the |
414 | It scales in the same way as the epoll backend, but the interface to the |
394 | kernel is more efficient (which says nothing about its actual speed, of |
415 | kernel is more efficient (which says nothing about its actual speed, of |
395 | course). While stopping, setting and starting an I/O watcher does never |
416 | course). While stopping, setting and starting an I/O watcher does never |
396 | cause an extra syscall as with C<EVBACKEND_EPOLL>, it still adds up to |
417 | cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to |
397 | two event changes per incident, support for C<fork ()> is very bad and it |
418 | two event changes per incident, support for C<fork ()> is very bad and it |
398 | drops fds silently in similarly hard-to-detect cases. |
419 | drops fds silently in similarly hard-to-detect cases. |
399 | |
420 | |
400 | This backend usually performs well under most conditions. |
421 | This backend usually performs well under most conditions. |
401 | |
422 | |
… | |
… | |
416 | =item C<EVBACKEND_PORT> (value 32, Solaris 10) |
437 | =item C<EVBACKEND_PORT> (value 32, Solaris 10) |
417 | |
438 | |
418 | This uses the Solaris 10 event port mechanism. As with everything on Solaris, |
439 | This uses the Solaris 10 event port mechanism. As with everything on Solaris, |
419 | it's really slow, but it still scales very well (O(active_fds)). |
440 | it's really slow, but it still scales very well (O(active_fds)). |
420 | |
441 | |
421 | Please note that solaris event ports can deliver a lot of spurious |
442 | Please note that Solaris event ports can deliver a lot of spurious |
422 | notifications, so you need to use non-blocking I/O or other means to avoid |
443 | notifications, so you need to use non-blocking I/O or other means to avoid |
423 | blocking when no data (or space) is available. |
444 | blocking when no data (or space) is available. |
424 | |
445 | |
425 | While this backend scales well, it requires one system call per active |
446 | While this backend scales well, it requires one system call per active |
426 | file descriptor per loop iteration. For small and medium numbers of file |
447 | file descriptor per loop iteration. For small and medium numbers of file |
427 | descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend |
448 | descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend |
428 | might perform better. |
449 | might perform better. |
429 | |
450 | |
430 | On the positive side, ignoring the spurious readyness notifications, this |
451 | On the positive side, ignoring the spurious readiness notifications, this |
431 | backend actually performed to specification in all tests and is fully |
452 | backend actually performed to specification in all tests and is fully |
432 | embeddable, which is a rare feat among the OS-specific backends. |
453 | embeddable, which is a rare feat among the OS-specific backends. |
433 | |
454 | |
434 | =item C<EVBACKEND_ALL> |
455 | =item C<EVBACKEND_ALL> |
435 | |
456 | |
… | |
… | |
439 | |
460 | |
440 | It is definitely not recommended to use this flag. |
461 | It is definitely not recommended to use this flag. |
441 | |
462 | |
442 | =back |
463 | =back |
443 | |
464 | |
444 | If one or more of these are ored into the flags value, then only these |
465 | If one or more of these are or'ed into the flags value, then only these |
445 | backends will be tried (in the reverse order as listed here). If none are |
466 | backends will be tried (in the reverse order as listed here). If none are |
446 | specified, all backends in C<ev_recommended_backends ()> will be tried. |
467 | specified, all backends in C<ev_recommended_backends ()> will be tried. |
447 | |
468 | |
448 | The most typical usage is like this: |
469 | The most typical usage is like this: |
449 | |
470 | |
450 | if (!ev_default_loop (0)) |
471 | if (!ev_default_loop (0)) |
451 | fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?"); |
472 | fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?"); |
452 | |
473 | |
453 | Restrict libev to the select and poll backends, and do not allow |
474 | Restrict libev to the select and poll backends, and do not allow |
454 | environment settings to be taken into account: |
475 | environment settings to be taken into account: |
455 | |
476 | |
456 | ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV); |
477 | ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV); |
457 | |
478 | |
458 | Use whatever libev has to offer, but make sure that kqueue is used if |
479 | Use whatever libev has to offer, but make sure that kqueue is used if |
459 | available (warning, breaks stuff, best use only with your own private |
480 | available (warning, breaks stuff, best use only with your own private |
460 | event loop and only if you know the OS supports your types of fds): |
481 | event loop and only if you know the OS supports your types of fds): |
461 | |
482 | |
462 | ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE); |
483 | ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE); |
463 | |
484 | |
464 | =item struct ev_loop *ev_loop_new (unsigned int flags) |
485 | =item struct ev_loop *ev_loop_new (unsigned int flags) |
465 | |
486 | |
466 | Similar to C<ev_default_loop>, but always creates a new event loop that is |
487 | Similar to C<ev_default_loop>, but always creates a new event loop that is |
467 | always distinct from the default loop. Unlike the default loop, it cannot |
488 | always distinct from the default loop. Unlike the default loop, it cannot |
… | |
… | |
472 | libev with threads is indeed to create one loop per thread, and using the |
493 | libev with threads is indeed to create one loop per thread, and using the |
473 | default loop in the "main" or "initial" thread. |
494 | default loop in the "main" or "initial" thread. |
474 | |
495 | |
475 | Example: Try to create a event loop that uses epoll and nothing else. |
496 | Example: Try to create a event loop that uses epoll and nothing else. |
476 | |
497 | |
477 | struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV); |
498 | struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV); |
478 | if (!epoller) |
499 | if (!epoller) |
479 | fatal ("no epoll found here, maybe it hides under your chair"); |
500 | fatal ("no epoll found here, maybe it hides under your chair"); |
480 | |
501 | |
481 | =item ev_default_destroy () |
502 | =item ev_default_destroy () |
482 | |
503 | |
483 | Destroys the default loop again (frees all memory and kernel state |
504 | Destroys the default loop again (frees all memory and kernel state |
484 | etc.). None of the active event watchers will be stopped in the normal |
505 | etc.). None of the active event watchers will be stopped in the normal |
485 | sense, so e.g. C<ev_is_active> might still return true. It is your |
506 | sense, so e.g. C<ev_is_active> might still return true. It is your |
486 | responsibility to either stop all watchers cleanly yoursef I<before> |
507 | responsibility to either stop all watchers cleanly yourself I<before> |
487 | calling this function, or cope with the fact afterwards (which is usually |
508 | calling this function, or cope with the fact afterwards (which is usually |
488 | the easiest thing, you can just ignore the watchers and/or C<free ()> them |
509 | the easiest thing, you can just ignore the watchers and/or C<free ()> them |
489 | for example). |
510 | for example). |
490 | |
511 | |
491 | Note that certain global state, such as signal state, will not be freed by |
512 | Note that certain global state, such as signal state, will not be freed by |
… | |
… | |
572 | A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle |
593 | A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle |
573 | those events and any outstanding ones, but will not block your process in |
594 | those events and any outstanding ones, but will not block your process in |
574 | case there are no events and will return after one iteration of the loop. |
595 | case there are no events and will return after one iteration of the loop. |
575 | |
596 | |
576 | A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if |
597 | A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if |
577 | neccessary) and will handle those and any outstanding ones. It will block |
598 | necessary) and will handle those and any outstanding ones. It will block |
578 | your process until at least one new event arrives, and will return after |
599 | your process until at least one new event arrives, and will return after |
579 | one iteration of the loop. This is useful if you are waiting for some |
600 | one iteration of the loop. This is useful if you are waiting for some |
580 | external event in conjunction with something not expressible using other |
601 | external event in conjunction with something not expressible using other |
581 | libev watchers. However, a pair of C<ev_prepare>/C<ev_check> watchers is |
602 | libev watchers. However, a pair of C<ev_prepare>/C<ev_check> watchers is |
582 | usually a better approach for this kind of thing. |
603 | usually a better approach for this kind of thing. |
… | |
… | |
643 | respectively). |
664 | respectively). |
644 | |
665 | |
645 | Example: Create a signal watcher, but keep it from keeping C<ev_loop> |
666 | Example: Create a signal watcher, but keep it from keeping C<ev_loop> |
646 | running when nothing else is active. |
667 | running when nothing else is active. |
647 | |
668 | |
648 | struct ev_signal exitsig; |
669 | struct ev_signal exitsig; |
649 | ev_signal_init (&exitsig, sig_cb, SIGINT); |
670 | ev_signal_init (&exitsig, sig_cb, SIGINT); |
650 | ev_signal_start (loop, &exitsig); |
671 | ev_signal_start (loop, &exitsig); |
651 | evf_unref (loop); |
672 | evf_unref (loop); |
652 | |
673 | |
653 | Example: For some weird reason, unregister the above signal handler again. |
674 | Example: For some weird reason, unregister the above signal handler again. |
654 | |
675 | |
655 | ev_ref (loop); |
676 | ev_ref (loop); |
656 | ev_signal_stop (loop, &exitsig); |
677 | ev_signal_stop (loop, &exitsig); |
657 | |
678 | |
658 | =item ev_set_io_collect_interval (loop, ev_tstamp interval) |
679 | =item ev_set_io_collect_interval (loop, ev_tstamp interval) |
659 | |
680 | |
660 | =item ev_set_timeout_collect_interval (loop, ev_tstamp interval) |
681 | =item ev_set_timeout_collect_interval (loop, ev_tstamp interval) |
661 | |
682 | |
… | |
… | |
683 | to spend more time collecting timeouts, at the expense of increased |
704 | to spend more time collecting timeouts, at the expense of increased |
684 | latency (the watcher callback will be called later). C<ev_io> watchers |
705 | latency (the watcher callback will be called later). C<ev_io> watchers |
685 | will not be affected. Setting this to a non-null value will not introduce |
706 | will not be affected. Setting this to a non-null value will not introduce |
686 | any overhead in libev. |
707 | any overhead in libev. |
687 | |
708 | |
688 | Many (busy) programs can usually benefit by setting the io collect |
709 | Many (busy) programs can usually benefit by setting the I/O collect |
689 | interval to a value near C<0.1> or so, which is often enough for |
710 | interval to a value near C<0.1> or so, which is often enough for |
690 | interactive servers (of course not for games), likewise for timeouts. It |
711 | interactive servers (of course not for games), likewise for timeouts. It |
691 | usually doesn't make much sense to set it to a lower value than C<0.01>, |
712 | usually doesn't make much sense to set it to a lower value than C<0.01>, |
692 | as this approsaches the timing granularity of most systems. |
713 | as this approaches the timing granularity of most systems. |
|
|
714 | |
|
|
715 | =item ev_loop_verify (loop) |
|
|
716 | |
|
|
717 | This function only does something when C<EV_VERIFY> support has been |
|
|
718 | compiled in. It tries to go through all internal structures and checks |
|
|
719 | them for validity. If anything is found to be inconsistent, it will print |
|
|
720 | an error message to standard error and call C<abort ()>. |
|
|
721 | |
|
|
722 | This can be used to catch bugs inside libev itself: under normal |
|
|
723 | circumstances, this function will never abort as of course libev keeps its |
|
|
724 | data structures consistent. |
693 | |
725 | |
694 | =back |
726 | =back |
695 | |
727 | |
696 | |
728 | |
697 | =head1 ANATOMY OF A WATCHER |
729 | =head1 ANATOMY OF A WATCHER |
698 | |
730 | |
699 | A watcher is a structure that you create and register to record your |
731 | A watcher is a structure that you create and register to record your |
700 | interest in some event. For instance, if you want to wait for STDIN to |
732 | interest in some event. For instance, if you want to wait for STDIN to |
701 | become readable, you would create an C<ev_io> watcher for that: |
733 | become readable, you would create an C<ev_io> watcher for that: |
702 | |
734 | |
703 | static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents) |
735 | static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents) |
704 | { |
736 | { |
705 | ev_io_stop (w); |
737 | ev_io_stop (w); |
706 | ev_unloop (loop, EVUNLOOP_ALL); |
738 | ev_unloop (loop, EVUNLOOP_ALL); |
707 | } |
739 | } |
708 | |
740 | |
709 | struct ev_loop *loop = ev_default_loop (0); |
741 | struct ev_loop *loop = ev_default_loop (0); |
710 | struct ev_io stdin_watcher; |
742 | struct ev_io stdin_watcher; |
711 | ev_init (&stdin_watcher, my_cb); |
743 | ev_init (&stdin_watcher, my_cb); |
712 | ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ); |
744 | ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ); |
713 | ev_io_start (loop, &stdin_watcher); |
745 | ev_io_start (loop, &stdin_watcher); |
714 | ev_loop (loop, 0); |
746 | ev_loop (loop, 0); |
715 | |
747 | |
716 | As you can see, you are responsible for allocating the memory for your |
748 | As you can see, you are responsible for allocating the memory for your |
717 | watcher structures (and it is usually a bad idea to do this on the stack, |
749 | watcher structures (and it is usually a bad idea to do this on the stack, |
718 | although this can sometimes be quite valid). |
750 | although this can sometimes be quite valid). |
719 | |
751 | |
720 | Each watcher structure must be initialised by a call to C<ev_init |
752 | Each watcher structure must be initialised by a call to C<ev_init |
721 | (watcher *, callback)>, which expects a callback to be provided. This |
753 | (watcher *, callback)>, which expects a callback to be provided. This |
722 | callback gets invoked each time the event occurs (or, in the case of io |
754 | callback gets invoked each time the event occurs (or, in the case of I/O |
723 | watchers, each time the event loop detects that the file descriptor given |
755 | watchers, each time the event loop detects that the file descriptor given |
724 | is readable and/or writable). |
756 | is readable and/or writable). |
725 | |
757 | |
726 | Each watcher type has its own C<< ev_<type>_set (watcher *, ...) >> macro |
758 | Each watcher type has its own C<< ev_<type>_set (watcher *, ...) >> macro |
727 | with arguments specific to this watcher type. There is also a macro |
759 | with arguments specific to this watcher type. There is also a macro |
… | |
… | |
803 | |
835 | |
804 | The given async watcher has been asynchronously notified (see C<ev_async>). |
836 | The given async watcher has been asynchronously notified (see C<ev_async>). |
805 | |
837 | |
806 | =item C<EV_ERROR> |
838 | =item C<EV_ERROR> |
807 | |
839 | |
808 | An unspecified error has occured, the watcher has been stopped. This might |
840 | An unspecified error has occurred, the watcher has been stopped. This might |
809 | happen because the watcher could not be properly started because libev |
841 | happen because the watcher could not be properly started because libev |
810 | ran out of memory, a file descriptor was found to be closed or any other |
842 | ran out of memory, a file descriptor was found to be closed or any other |
811 | problem. You best act on it by reporting the problem and somehow coping |
843 | problem. You best act on it by reporting the problem and somehow coping |
812 | with the watcher being stopped. |
844 | with the watcher being stopped. |
813 | |
845 | |
814 | Libev will usually signal a few "dummy" events together with an error, |
846 | Libev will usually signal a few "dummy" events together with an error, |
815 | for example it might indicate that a fd is readable or writable, and if |
847 | for example it might indicate that a fd is readable or writable, and if |
816 | your callbacks is well-written it can just attempt the operation and cope |
848 | your callbacks is well-written it can just attempt the operation and cope |
817 | with the error from read() or write(). This will not work in multithreaded |
849 | with the error from read() or write(). This will not work in multi-threaded |
818 | programs, though, so beware. |
850 | programs, though, so beware. |
819 | |
851 | |
820 | =back |
852 | =back |
821 | |
853 | |
822 | =head2 GENERIC WATCHER FUNCTIONS |
854 | =head2 GENERIC WATCHER FUNCTIONS |
… | |
… | |
852 | Although some watcher types do not have type-specific arguments |
884 | Although some watcher types do not have type-specific arguments |
853 | (e.g. C<ev_prepare>) you still need to call its C<set> macro. |
885 | (e.g. C<ev_prepare>) you still need to call its C<set> macro. |
854 | |
886 | |
855 | =item C<ev_TYPE_init> (ev_TYPE *watcher, callback, [args]) |
887 | =item C<ev_TYPE_init> (ev_TYPE *watcher, callback, [args]) |
856 | |
888 | |
857 | This convinience macro rolls both C<ev_init> and C<ev_TYPE_set> macro |
889 | This convenience macro rolls both C<ev_init> and C<ev_TYPE_set> macro |
858 | calls into a single call. This is the most convinient method to initialise |
890 | calls into a single call. This is the most convenient method to initialise |
859 | a watcher. The same limitations apply, of course. |
891 | a watcher. The same limitations apply, of course. |
860 | |
892 | |
861 | =item C<ev_TYPE_start> (loop *, ev_TYPE *watcher) |
893 | =item C<ev_TYPE_start> (loop *, ev_TYPE *watcher) |
862 | |
894 | |
863 | Starts (activates) the given watcher. Only active watchers will receive |
895 | Starts (activates) the given watcher. Only active watchers will receive |
… | |
… | |
946 | to associate arbitrary data with your watcher. If you need more data and |
978 | to associate arbitrary data with your watcher. If you need more data and |
947 | don't want to allocate memory and store a pointer to it in that data |
979 | don't want to allocate memory and store a pointer to it in that data |
948 | member, you can also "subclass" the watcher type and provide your own |
980 | member, you can also "subclass" the watcher type and provide your own |
949 | data: |
981 | data: |
950 | |
982 | |
951 | struct my_io |
983 | struct my_io |
952 | { |
984 | { |
953 | struct ev_io io; |
985 | struct ev_io io; |
954 | int otherfd; |
986 | int otherfd; |
955 | void *somedata; |
987 | void *somedata; |
956 | struct whatever *mostinteresting; |
988 | struct whatever *mostinteresting; |
957 | } |
989 | } |
958 | |
990 | |
959 | And since your callback will be called with a pointer to the watcher, you |
991 | And since your callback will be called with a pointer to the watcher, you |
960 | can cast it back to your own type: |
992 | can cast it back to your own type: |
961 | |
993 | |
962 | static void my_cb (struct ev_loop *loop, struct ev_io *w_, int revents) |
994 | static void my_cb (struct ev_loop *loop, struct ev_io *w_, int revents) |
963 | { |
995 | { |
964 | struct my_io *w = (struct my_io *)w_; |
996 | struct my_io *w = (struct my_io *)w_; |
965 | ... |
997 | ... |
966 | } |
998 | } |
967 | |
999 | |
968 | More interesting and less C-conformant ways of casting your callback type |
1000 | More interesting and less C-conformant ways of casting your callback type |
969 | instead have been omitted. |
1001 | instead have been omitted. |
970 | |
1002 | |
971 | Another common scenario is having some data structure with multiple |
1003 | Another common scenario is having some data structure with multiple |
972 | watchers: |
1004 | watchers: |
973 | |
1005 | |
974 | struct my_biggy |
1006 | struct my_biggy |
975 | { |
1007 | { |
976 | int some_data; |
1008 | int some_data; |
977 | ev_timer t1; |
1009 | ev_timer t1; |
978 | ev_timer t2; |
1010 | ev_timer t2; |
979 | } |
1011 | } |
980 | |
1012 | |
981 | In this case getting the pointer to C<my_biggy> is a bit more complicated, |
1013 | In this case getting the pointer to C<my_biggy> is a bit more complicated, |
982 | you need to use C<offsetof>: |
1014 | you need to use C<offsetof>: |
983 | |
1015 | |
984 | #include <stddef.h> |
1016 | #include <stddef.h> |
985 | |
1017 | |
986 | static void |
1018 | static void |
987 | t1_cb (EV_P_ struct ev_timer *w, int revents) |
1019 | t1_cb (EV_P_ struct ev_timer *w, int revents) |
988 | { |
1020 | { |
989 | struct my_biggy big = (struct my_biggy * |
1021 | struct my_biggy big = (struct my_biggy * |
990 | (((char *)w) - offsetof (struct my_biggy, t1)); |
1022 | (((char *)w) - offsetof (struct my_biggy, t1)); |
991 | } |
1023 | } |
992 | |
1024 | |
993 | static void |
1025 | static void |
994 | t2_cb (EV_P_ struct ev_timer *w, int revents) |
1026 | t2_cb (EV_P_ struct ev_timer *w, int revents) |
995 | { |
1027 | { |
996 | struct my_biggy big = (struct my_biggy * |
1028 | struct my_biggy big = (struct my_biggy * |
997 | (((char *)w) - offsetof (struct my_biggy, t2)); |
1029 | (((char *)w) - offsetof (struct my_biggy, t2)); |
998 | } |
1030 | } |
999 | |
1031 | |
1000 | |
1032 | |
1001 | =head1 WATCHER TYPES |
1033 | =head1 WATCHER TYPES |
1002 | |
1034 | |
1003 | This section describes each watcher in detail, but will not repeat |
1035 | This section describes each watcher in detail, but will not repeat |
… | |
… | |
1032 | If you must do this, then force the use of a known-to-be-good backend |
1064 | If you must do this, then force the use of a known-to-be-good backend |
1033 | (at the time of this writing, this includes only C<EVBACKEND_SELECT> and |
1065 | (at the time of this writing, this includes only C<EVBACKEND_SELECT> and |
1034 | C<EVBACKEND_POLL>). |
1066 | C<EVBACKEND_POLL>). |
1035 | |
1067 | |
1036 | Another thing you have to watch out for is that it is quite easy to |
1068 | Another thing you have to watch out for is that it is quite easy to |
1037 | receive "spurious" readyness notifications, that is your callback might |
1069 | receive "spurious" readiness notifications, that is your callback might |
1038 | be called with C<EV_READ> but a subsequent C<read>(2) will actually block |
1070 | be called with C<EV_READ> but a subsequent C<read>(2) will actually block |
1039 | because there is no data. Not only are some backends known to create a |
1071 | because there is no data. Not only are some backends known to create a |
1040 | lot of those (for example solaris ports), it is very easy to get into |
1072 | lot of those (for example Solaris ports), it is very easy to get into |
1041 | this situation even with a relatively standard program structure. Thus |
1073 | this situation even with a relatively standard program structure. Thus |
1042 | it is best to always use non-blocking I/O: An extra C<read>(2) returning |
1074 | it is best to always use non-blocking I/O: An extra C<read>(2) returning |
1043 | C<EAGAIN> is far preferable to a program hanging until some data arrives. |
1075 | C<EAGAIN> is far preferable to a program hanging until some data arrives. |
1044 | |
1076 | |
1045 | If you cannot run the fd in non-blocking mode (for example you should not |
1077 | If you cannot run the fd in non-blocking mode (for example you should not |
1046 | play around with an Xlib connection), then you have to seperately re-test |
1078 | play around with an Xlib connection), then you have to separately re-test |
1047 | whether a file descriptor is really ready with a known-to-be good interface |
1079 | whether a file descriptor is really ready with a known-to-be good interface |
1048 | such as poll (fortunately in our Xlib example, Xlib already does this on |
1080 | such as poll (fortunately in our Xlib example, Xlib already does this on |
1049 | its own, so its quite safe to use). |
1081 | its own, so its quite safe to use). |
1050 | |
1082 | |
1051 | =head3 The special problem of disappearing file descriptors |
1083 | =head3 The special problem of disappearing file descriptors |
… | |
… | |
1111 | =item ev_io_init (ev_io *, callback, int fd, int events) |
1143 | =item ev_io_init (ev_io *, callback, int fd, int events) |
1112 | |
1144 | |
1113 | =item ev_io_set (ev_io *, int fd, int events) |
1145 | =item ev_io_set (ev_io *, int fd, int events) |
1114 | |
1146 | |
1115 | Configures an C<ev_io> watcher. The C<fd> is the file descriptor to |
1147 | Configures an C<ev_io> watcher. The C<fd> is the file descriptor to |
1116 | rceeive events for and events is either C<EV_READ>, C<EV_WRITE> or |
1148 | receive events for and events is either C<EV_READ>, C<EV_WRITE> or |
1117 | C<EV_READ | EV_WRITE> to receive the given events. |
1149 | C<EV_READ | EV_WRITE> to receive the given events. |
1118 | |
1150 | |
1119 | =item int fd [read-only] |
1151 | =item int fd [read-only] |
1120 | |
1152 | |
1121 | The file descriptor being watched. |
1153 | The file descriptor being watched. |
… | |
… | |
1130 | |
1162 | |
1131 | Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well |
1163 | Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well |
1132 | readable, but only once. Since it is likely line-buffered, you could |
1164 | readable, but only once. Since it is likely line-buffered, you could |
1133 | attempt to read a whole line in the callback. |
1165 | attempt to read a whole line in the callback. |
1134 | |
1166 | |
1135 | static void |
1167 | static void |
1136 | stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents) |
1168 | stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents) |
1137 | { |
1169 | { |
1138 | ev_io_stop (loop, w); |
1170 | ev_io_stop (loop, w); |
1139 | .. read from stdin here (or from w->fd) and haqndle any I/O errors |
1171 | .. read from stdin here (or from w->fd) and haqndle any I/O errors |
1140 | } |
1172 | } |
1141 | |
1173 | |
1142 | ... |
1174 | ... |
1143 | struct ev_loop *loop = ev_default_init (0); |
1175 | struct ev_loop *loop = ev_default_init (0); |
1144 | struct ev_io stdin_readable; |
1176 | struct ev_io stdin_readable; |
1145 | ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ); |
1177 | ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ); |
1146 | ev_io_start (loop, &stdin_readable); |
1178 | ev_io_start (loop, &stdin_readable); |
1147 | ev_loop (loop, 0); |
1179 | ev_loop (loop, 0); |
1148 | |
1180 | |
1149 | |
1181 | |
1150 | =head2 C<ev_timer> - relative and optionally repeating timeouts |
1182 | =head2 C<ev_timer> - relative and optionally repeating timeouts |
1151 | |
1183 | |
1152 | Timer watchers are simple relative timers that generate an event after a |
1184 | Timer watchers are simple relative timers that generate an event after a |
1153 | given time, and optionally repeating in regular intervals after that. |
1185 | given time, and optionally repeating in regular intervals after that. |
1154 | |
1186 | |
1155 | The timers are based on real time, that is, if you register an event that |
1187 | The timers are based on real time, that is, if you register an event that |
1156 | times out after an hour and you reset your system clock to last years |
1188 | times out after an hour and you reset your system clock to January last |
1157 | time, it will still time out after (roughly) and hour. "Roughly" because |
1189 | year, it will still time out after (roughly) and hour. "Roughly" because |
1158 | detecting time jumps is hard, and some inaccuracies are unavoidable (the |
1190 | detecting time jumps is hard, and some inaccuracies are unavoidable (the |
1159 | monotonic clock option helps a lot here). |
1191 | monotonic clock option helps a lot here). |
1160 | |
1192 | |
1161 | The relative timeouts are calculated relative to the C<ev_now ()> |
1193 | The relative timeouts are calculated relative to the C<ev_now ()> |
1162 | time. This is usually the right thing as this timestamp refers to the time |
1194 | time. This is usually the right thing as this timestamp refers to the time |
… | |
… | |
1164 | you suspect event processing to be delayed and you I<need> to base the timeout |
1196 | you suspect event processing to be delayed and you I<need> to base the timeout |
1165 | on the current time, use something like this to adjust for this: |
1197 | on the current time, use something like this to adjust for this: |
1166 | |
1198 | |
1167 | ev_timer_set (&timer, after + ev_now () - ev_time (), 0.); |
1199 | ev_timer_set (&timer, after + ev_now () - ev_time (), 0.); |
1168 | |
1200 | |
1169 | The callback is guarenteed to be invoked only when its timeout has passed, |
1201 | The callback is guaranteed to be invoked only after its timeout has passed, |
1170 | but if multiple timers become ready during the same loop iteration then |
1202 | but if multiple timers become ready during the same loop iteration then |
1171 | order of execution is undefined. |
1203 | order of execution is undefined. |
1172 | |
1204 | |
1173 | =head3 Watcher-Specific Functions and Data Members |
1205 | =head3 Watcher-Specific Functions and Data Members |
1174 | |
1206 | |
… | |
… | |
1176 | |
1208 | |
1177 | =item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat) |
1209 | =item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat) |
1178 | |
1210 | |
1179 | =item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat) |
1211 | =item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat) |
1180 | |
1212 | |
1181 | Configure the timer to trigger after C<after> seconds. If C<repeat> is |
1213 | Configure the timer to trigger after C<after> seconds. If C<repeat> |
1182 | C<0.>, then it will automatically be stopped. If it is positive, then the |
1214 | is C<0.>, then it will automatically be stopped once the timeout is |
1183 | timer will automatically be configured to trigger again C<repeat> seconds |
1215 | reached. If it is positive, then the timer will automatically be |
1184 | later, again, and again, until stopped manually. |
1216 | configured to trigger again C<repeat> seconds later, again, and again, |
|
|
1217 | until stopped manually. |
1185 | |
1218 | |
1186 | The timer itself will do a best-effort at avoiding drift, that is, if you |
1219 | The timer itself will do a best-effort at avoiding drift, that is, if |
1187 | configure a timer to trigger every 10 seconds, then it will trigger at |
1220 | you configure a timer to trigger every 10 seconds, then it will normally |
1188 | exactly 10 second intervals. If, however, your program cannot keep up with |
1221 | trigger at exactly 10 second intervals. If, however, your program cannot |
1189 | the timer (because it takes longer than those 10 seconds to do stuff) the |
1222 | keep up with the timer (because it takes longer than those 10 seconds to |
1190 | timer will not fire more than once per event loop iteration. |
1223 | do stuff) the timer will not fire more than once per event loop iteration. |
1191 | |
1224 | |
1192 | =item ev_timer_again (loop, ev_timer *) |
1225 | =item ev_timer_again (loop, ev_timer *) |
1193 | |
1226 | |
1194 | This will act as if the timer timed out and restart it again if it is |
1227 | This will act as if the timer timed out and restart it again if it is |
1195 | repeating. The exact semantics are: |
1228 | repeating. The exact semantics are: |
1196 | |
1229 | |
1197 | If the timer is pending, its pending status is cleared. |
1230 | If the timer is pending, its pending status is cleared. |
1198 | |
1231 | |
1199 | If the timer is started but nonrepeating, stop it (as if it timed out). |
1232 | If the timer is started but non-repeating, stop it (as if it timed out). |
1200 | |
1233 | |
1201 | If the timer is repeating, either start it if necessary (with the |
1234 | If the timer is repeating, either start it if necessary (with the |
1202 | C<repeat> value), or reset the running timer to the C<repeat> value. |
1235 | C<repeat> value), or reset the running timer to the C<repeat> value. |
1203 | |
1236 | |
1204 | This sounds a bit complicated, but here is a useful and typical |
1237 | This sounds a bit complicated, but here is a useful and typical |
1205 | example: Imagine you have a tcp connection and you want a so-called idle |
1238 | example: Imagine you have a TCP connection and you want a so-called idle |
1206 | timeout, that is, you want to be called when there have been, say, 60 |
1239 | timeout, that is, you want to be called when there have been, say, 60 |
1207 | seconds of inactivity on the socket. The easiest way to do this is to |
1240 | seconds of inactivity on the socket. The easiest way to do this is to |
1208 | configure an C<ev_timer> with a C<repeat> value of C<60> and then call |
1241 | configure an C<ev_timer> with a C<repeat> value of C<60> and then call |
1209 | C<ev_timer_again> each time you successfully read or write some data. If |
1242 | C<ev_timer_again> each time you successfully read or write some data. If |
1210 | you go into an idle state where you do not expect data to travel on the |
1243 | you go into an idle state where you do not expect data to travel on the |
… | |
… | |
1236 | |
1269 | |
1237 | =head3 Examples |
1270 | =head3 Examples |
1238 | |
1271 | |
1239 | Example: Create a timer that fires after 60 seconds. |
1272 | Example: Create a timer that fires after 60 seconds. |
1240 | |
1273 | |
1241 | static void |
1274 | static void |
1242 | one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents) |
1275 | one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents) |
1243 | { |
1276 | { |
1244 | .. one minute over, w is actually stopped right here |
1277 | .. one minute over, w is actually stopped right here |
1245 | } |
1278 | } |
1246 | |
1279 | |
1247 | struct ev_timer mytimer; |
1280 | struct ev_timer mytimer; |
1248 | ev_timer_init (&mytimer, one_minute_cb, 60., 0.); |
1281 | ev_timer_init (&mytimer, one_minute_cb, 60., 0.); |
1249 | ev_timer_start (loop, &mytimer); |
1282 | ev_timer_start (loop, &mytimer); |
1250 | |
1283 | |
1251 | Example: Create a timeout timer that times out after 10 seconds of |
1284 | Example: Create a timeout timer that times out after 10 seconds of |
1252 | inactivity. |
1285 | inactivity. |
1253 | |
1286 | |
1254 | static void |
1287 | static void |
1255 | timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents) |
1288 | timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents) |
1256 | { |
1289 | { |
1257 | .. ten seconds without any activity |
1290 | .. ten seconds without any activity |
1258 | } |
1291 | } |
1259 | |
1292 | |
1260 | struct ev_timer mytimer; |
1293 | struct ev_timer mytimer; |
1261 | ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */ |
1294 | ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */ |
1262 | ev_timer_again (&mytimer); /* start timer */ |
1295 | ev_timer_again (&mytimer); /* start timer */ |
1263 | ev_loop (loop, 0); |
1296 | ev_loop (loop, 0); |
1264 | |
1297 | |
1265 | // and in some piece of code that gets executed on any "activity": |
1298 | // and in some piece of code that gets executed on any "activity": |
1266 | // reset the timeout to start ticking again at 10 seconds |
1299 | // reset the timeout to start ticking again at 10 seconds |
1267 | ev_timer_again (&mytimer); |
1300 | ev_timer_again (&mytimer); |
1268 | |
1301 | |
1269 | |
1302 | |
1270 | =head2 C<ev_periodic> - to cron or not to cron? |
1303 | =head2 C<ev_periodic> - to cron or not to cron? |
1271 | |
1304 | |
1272 | Periodic watchers are also timers of a kind, but they are very versatile |
1305 | Periodic watchers are also timers of a kind, but they are very versatile |
1273 | (and unfortunately a bit complex). |
1306 | (and unfortunately a bit complex). |
1274 | |
1307 | |
1275 | Unlike C<ev_timer>'s, they are not based on real time (or relative time) |
1308 | Unlike C<ev_timer>'s, they are not based on real time (or relative time) |
1276 | but on wallclock time (absolute time). You can tell a periodic watcher |
1309 | but on wall clock time (absolute time). You can tell a periodic watcher |
1277 | to trigger "at" some specific point in time. For example, if you tell a |
1310 | to trigger after some specific point in time. For example, if you tell a |
1278 | periodic watcher to trigger in 10 seconds (by specifiying e.g. C<ev_now () |
1311 | periodic watcher to trigger in 10 seconds (by specifying e.g. C<ev_now () |
1279 | + 10.>) and then reset your system clock to the last year, then it will |
1312 | + 10.>, that is, an absolute time not a delay) and then reset your system |
|
|
1313 | clock to January of the previous year, then it will take more than year |
1280 | take a year to trigger the event (unlike an C<ev_timer>, which would trigger |
1314 | to trigger the event (unlike an C<ev_timer>, which would still trigger |
1281 | roughly 10 seconds later). |
1315 | roughly 10 seconds later as it uses a relative timeout). |
1282 | |
1316 | |
1283 | They can also be used to implement vastly more complex timers, such as |
1317 | C<ev_periodic>s can also be used to implement vastly more complex timers, |
1284 | triggering an event on each midnight, local time or other, complicated, |
1318 | such as triggering an event on each "midnight, local time", or other |
1285 | rules. |
1319 | complicated, rules. |
1286 | |
1320 | |
1287 | As with timers, the callback is guarenteed to be invoked only when the |
1321 | As with timers, the callback is guaranteed to be invoked only when the |
1288 | time (C<at>) has been passed, but if multiple periodic timers become ready |
1322 | time (C<at>) has passed, but if multiple periodic timers become ready |
1289 | during the same loop iteration then order of execution is undefined. |
1323 | during the same loop iteration then order of execution is undefined. |
1290 | |
1324 | |
1291 | =head3 Watcher-Specific Functions and Data Members |
1325 | =head3 Watcher-Specific Functions and Data Members |
1292 | |
1326 | |
1293 | =over 4 |
1327 | =over 4 |
… | |
… | |
1301 | |
1335 | |
1302 | =over 4 |
1336 | =over 4 |
1303 | |
1337 | |
1304 | =item * absolute timer (at = time, interval = reschedule_cb = 0) |
1338 | =item * absolute timer (at = time, interval = reschedule_cb = 0) |
1305 | |
1339 | |
1306 | In this configuration the watcher triggers an event at the wallclock time |
1340 | In this configuration the watcher triggers an event after the wall clock |
1307 | C<at> and doesn't repeat. It will not adjust when a time jump occurs, |
1341 | time C<at> has passed and doesn't repeat. It will not adjust when a time |
1308 | that is, if it is to be run at January 1st 2011 then it will run when the |
1342 | jump occurs, that is, if it is to be run at January 1st 2011 then it will |
1309 | system time reaches or surpasses this time. |
1343 | run when the system time reaches or surpasses this time. |
1310 | |
1344 | |
1311 | =item * repeating interval timer (at = offset, interval > 0, reschedule_cb = 0) |
1345 | =item * repeating interval timer (at = offset, interval > 0, reschedule_cb = 0) |
1312 | |
1346 | |
1313 | In this mode the watcher will always be scheduled to time out at the next |
1347 | In this mode the watcher will always be scheduled to time out at the next |
1314 | C<at + N * interval> time (for some integer N, which can also be negative) |
1348 | C<at + N * interval> time (for some integer N, which can also be negative) |
1315 | and then repeat, regardless of any time jumps. |
1349 | and then repeat, regardless of any time jumps. |
1316 | |
1350 | |
1317 | This can be used to create timers that do not drift with respect to system |
1351 | This can be used to create timers that do not drift with respect to system |
1318 | time: |
1352 | time, for example, here is a C<ev_periodic> that triggers each hour, on |
|
|
1353 | the hour: |
1319 | |
1354 | |
1320 | ev_periodic_set (&periodic, 0., 3600., 0); |
1355 | ev_periodic_set (&periodic, 0., 3600., 0); |
1321 | |
1356 | |
1322 | This doesn't mean there will always be 3600 seconds in between triggers, |
1357 | This doesn't mean there will always be 3600 seconds in between triggers, |
1323 | but only that the the callback will be called when the system time shows a |
1358 | but only that the callback will be called when the system time shows a |
1324 | full hour (UTC), or more correctly, when the system time is evenly divisible |
1359 | full hour (UTC), or more correctly, when the system time is evenly divisible |
1325 | by 3600. |
1360 | by 3600. |
1326 | |
1361 | |
1327 | Another way to think about it (for the mathematically inclined) is that |
1362 | Another way to think about it (for the mathematically inclined) is that |
1328 | C<ev_periodic> will try to run the callback in this mode at the next possible |
1363 | C<ev_periodic> will try to run the callback in this mode at the next possible |
1329 | time where C<time = at (mod interval)>, regardless of any time jumps. |
1364 | time where C<time = at (mod interval)>, regardless of any time jumps. |
1330 | |
1365 | |
1331 | For numerical stability it is preferable that the C<at> value is near |
1366 | For numerical stability it is preferable that the C<at> value is near |
1332 | C<ev_now ()> (the current time), but there is no range requirement for |
1367 | C<ev_now ()> (the current time), but there is no range requirement for |
1333 | this value. |
1368 | this value, and in fact is often specified as zero. |
|
|
1369 | |
|
|
1370 | Note also that there is an upper limit to how often a timer can fire (CPU |
|
|
1371 | speed for example), so if C<interval> is very small then timing stability |
|
|
1372 | will of course deteriorate. Libev itself tries to be exact to be about one |
|
|
1373 | millisecond (if the OS supports it and the machine is fast enough). |
1334 | |
1374 | |
1335 | =item * manual reschedule mode (at and interval ignored, reschedule_cb = callback) |
1375 | =item * manual reschedule mode (at and interval ignored, reschedule_cb = callback) |
1336 | |
1376 | |
1337 | In this mode the values for C<interval> and C<at> are both being |
1377 | In this mode the values for C<interval> and C<at> are both being |
1338 | ignored. Instead, each time the periodic watcher gets scheduled, the |
1378 | ignored. Instead, each time the periodic watcher gets scheduled, the |
1339 | reschedule callback will be called with the watcher as first, and the |
1379 | reschedule callback will be called with the watcher as first, and the |
1340 | current time as second argument. |
1380 | current time as second argument. |
1341 | |
1381 | |
1342 | NOTE: I<This callback MUST NOT stop or destroy any periodic watcher, |
1382 | NOTE: I<This callback MUST NOT stop or destroy any periodic watcher, |
1343 | ever, or make any event loop modifications>. If you need to stop it, |
1383 | ever, or make ANY event loop modifications whatsoever>. |
1344 | return C<now + 1e30> (or so, fudge fudge) and stop it afterwards (e.g. by |
|
|
1345 | starting an C<ev_prepare> watcher, which is legal). |
|
|
1346 | |
1384 | |
|
|
1385 | If you need to stop it, return C<now + 1e30> (or so, fudge fudge) and stop |
|
|
1386 | it afterwards (e.g. by starting an C<ev_prepare> watcher, which is the |
|
|
1387 | only event loop modification you are allowed to do). |
|
|
1388 | |
1347 | Its prototype is C<ev_tstamp (*reschedule_cb)(struct ev_periodic *w, |
1389 | The callback prototype is C<ev_tstamp (*reschedule_cb)(struct ev_periodic |
1348 | ev_tstamp now)>, e.g.: |
1390 | *w, ev_tstamp now)>, e.g.: |
1349 | |
1391 | |
1350 | static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now) |
1392 | static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now) |
1351 | { |
1393 | { |
1352 | return now + 60.; |
1394 | return now + 60.; |
1353 | } |
1395 | } |
… | |
… | |
1355 | It must return the next time to trigger, based on the passed time value |
1397 | It must return the next time to trigger, based on the passed time value |
1356 | (that is, the lowest time value larger than to the second argument). It |
1398 | (that is, the lowest time value larger than to the second argument). It |
1357 | will usually be called just before the callback will be triggered, but |
1399 | will usually be called just before the callback will be triggered, but |
1358 | might be called at other times, too. |
1400 | might be called at other times, too. |
1359 | |
1401 | |
1360 | NOTE: I<< This callback must always return a time that is later than the |
1402 | NOTE: I<< This callback must always return a time that is higher than or |
1361 | passed C<now> value >>. Not even C<now> itself will do, it I<must> be larger. |
1403 | equal to the passed C<now> value >>. |
1362 | |
1404 | |
1363 | This can be used to create very complex timers, such as a timer that |
1405 | This can be used to create very complex timers, such as a timer that |
1364 | triggers on each midnight, local time. To do this, you would calculate the |
1406 | triggers on "next midnight, local time". To do this, you would calculate the |
1365 | next midnight after C<now> and return the timestamp value for this. How |
1407 | next midnight after C<now> and return the timestamp value for this. How |
1366 | you do this is, again, up to you (but it is not trivial, which is the main |
1408 | you do this is, again, up to you (but it is not trivial, which is the main |
1367 | reason I omitted it as an example). |
1409 | reason I omitted it as an example). |
1368 | |
1410 | |
1369 | =back |
1411 | =back |
… | |
… | |
1404 | |
1446 | |
1405 | =head3 Examples |
1447 | =head3 Examples |
1406 | |
1448 | |
1407 | Example: Call a callback every hour, or, more precisely, whenever the |
1449 | Example: Call a callback every hour, or, more precisely, whenever the |
1408 | system clock is divisible by 3600. The callback invocation times have |
1450 | system clock is divisible by 3600. The callback invocation times have |
1409 | potentially a lot of jittering, but good long-term stability. |
1451 | potentially a lot of jitter, but good long-term stability. |
1410 | |
1452 | |
1411 | static void |
1453 | static void |
1412 | clock_cb (struct ev_loop *loop, struct ev_io *w, int revents) |
1454 | clock_cb (struct ev_loop *loop, struct ev_io *w, int revents) |
1413 | { |
1455 | { |
1414 | ... its now a full hour (UTC, or TAI or whatever your clock follows) |
1456 | ... its now a full hour (UTC, or TAI or whatever your clock follows) |
1415 | } |
1457 | } |
1416 | |
1458 | |
1417 | struct ev_periodic hourly_tick; |
1459 | struct ev_periodic hourly_tick; |
1418 | ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0); |
1460 | ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0); |
1419 | ev_periodic_start (loop, &hourly_tick); |
1461 | ev_periodic_start (loop, &hourly_tick); |
1420 | |
1462 | |
1421 | Example: The same as above, but use a reschedule callback to do it: |
1463 | Example: The same as above, but use a reschedule callback to do it: |
1422 | |
1464 | |
1423 | #include <math.h> |
1465 | #include <math.h> |
1424 | |
1466 | |
1425 | static ev_tstamp |
1467 | static ev_tstamp |
1426 | my_scheduler_cb (struct ev_periodic *w, ev_tstamp now) |
1468 | my_scheduler_cb (struct ev_periodic *w, ev_tstamp now) |
1427 | { |
1469 | { |
1428 | return fmod (now, 3600.) + 3600.; |
1470 | return fmod (now, 3600.) + 3600.; |
1429 | } |
1471 | } |
1430 | |
1472 | |
1431 | ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb); |
1473 | ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb); |
1432 | |
1474 | |
1433 | Example: Call a callback every hour, starting now: |
1475 | Example: Call a callback every hour, starting now: |
1434 | |
1476 | |
1435 | struct ev_periodic hourly_tick; |
1477 | struct ev_periodic hourly_tick; |
1436 | ev_periodic_init (&hourly_tick, clock_cb, |
1478 | ev_periodic_init (&hourly_tick, clock_cb, |
1437 | fmod (ev_now (loop), 3600.), 3600., 0); |
1479 | fmod (ev_now (loop), 3600.), 3600., 0); |
1438 | ev_periodic_start (loop, &hourly_tick); |
1480 | ev_periodic_start (loop, &hourly_tick); |
1439 | |
1481 | |
1440 | |
1482 | |
1441 | =head2 C<ev_signal> - signal me when a signal gets signalled! |
1483 | =head2 C<ev_signal> - signal me when a signal gets signalled! |
1442 | |
1484 | |
1443 | Signal watchers will trigger an event when the process receives a specific |
1485 | Signal watchers will trigger an event when the process receives a specific |
… | |
… | |
1451 | as you don't register any with libev). Similarly, when the last signal |
1493 | as you don't register any with libev). Similarly, when the last signal |
1452 | watcher for a signal is stopped libev will reset the signal handler to |
1494 | watcher for a signal is stopped libev will reset the signal handler to |
1453 | SIG_DFL (regardless of what it was set to before). |
1495 | SIG_DFL (regardless of what it was set to before). |
1454 | |
1496 | |
1455 | If possible and supported, libev will install its handlers with |
1497 | If possible and supported, libev will install its handlers with |
1456 | C<SA_RESTART> behaviour enabled, so syscalls should not be unduly |
1498 | C<SA_RESTART> behaviour enabled, so system calls should not be unduly |
1457 | interrupted. If you have a problem with syscalls getting interrupted by |
1499 | interrupted. If you have a problem with system calls getting interrupted by |
1458 | signals you can block all signals in an C<ev_check> watcher and unblock |
1500 | signals you can block all signals in an C<ev_check> watcher and unblock |
1459 | them in an C<ev_prepare> watcher. |
1501 | them in an C<ev_prepare> watcher. |
1460 | |
1502 | |
1461 | =head3 Watcher-Specific Functions and Data Members |
1503 | =head3 Watcher-Specific Functions and Data Members |
1462 | |
1504 | |
… | |
… | |
1477 | |
1519 | |
1478 | =head3 Examples |
1520 | =head3 Examples |
1479 | |
1521 | |
1480 | Example: Try to exit cleanly on SIGINT and SIGTERM. |
1522 | Example: Try to exit cleanly on SIGINT and SIGTERM. |
1481 | |
1523 | |
1482 | static void |
1524 | static void |
1483 | sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents) |
1525 | sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents) |
1484 | { |
1526 | { |
1485 | ev_unloop (loop, EVUNLOOP_ALL); |
1527 | ev_unloop (loop, EVUNLOOP_ALL); |
1486 | } |
1528 | } |
1487 | |
1529 | |
1488 | struct ev_signal signal_watcher; |
1530 | struct ev_signal signal_watcher; |
1489 | ev_signal_init (&signal_watcher, sigint_cb, SIGINT); |
1531 | ev_signal_init (&signal_watcher, sigint_cb, SIGINT); |
1490 | ev_signal_start (loop, &sigint_cb); |
1532 | ev_signal_start (loop, &sigint_cb); |
1491 | |
1533 | |
1492 | |
1534 | |
1493 | =head2 C<ev_child> - watch out for process status changes |
1535 | =head2 C<ev_child> - watch out for process status changes |
1494 | |
1536 | |
1495 | Child watchers trigger when your process receives a SIGCHLD in response to |
1537 | Child watchers trigger when your process receives a SIGCHLD in response to |
… | |
… | |
1497 | is permissible to install a child watcher I<after> the child has been |
1539 | is permissible to install a child watcher I<after> the child has been |
1498 | forked (which implies it might have already exited), as long as the event |
1540 | forked (which implies it might have already exited), as long as the event |
1499 | loop isn't entered (or is continued from a watcher). |
1541 | loop isn't entered (or is continued from a watcher). |
1500 | |
1542 | |
1501 | Only the default event loop is capable of handling signals, and therefore |
1543 | Only the default event loop is capable of handling signals, and therefore |
1502 | you can only rgeister child watchers in the default event loop. |
1544 | you can only register child watchers in the default event loop. |
1503 | |
1545 | |
1504 | =head3 Process Interaction |
1546 | =head3 Process Interaction |
1505 | |
1547 | |
1506 | Libev grabs C<SIGCHLD> as soon as the default event loop is |
1548 | Libev grabs C<SIGCHLD> as soon as the default event loop is |
1507 | initialised. This is necessary to guarantee proper behaviour even if |
1549 | initialised. This is necessary to guarantee proper behaviour even if |
1508 | the first child watcher is started after the child exits. The occurance |
1550 | the first child watcher is started after the child exits. The occurrence |
1509 | of C<SIGCHLD> is recorded asynchronously, but child reaping is done |
1551 | of C<SIGCHLD> is recorded asynchronously, but child reaping is done |
1510 | synchronously as part of the event loop processing. Libev always reaps all |
1552 | synchronously as part of the event loop processing. Libev always reaps all |
1511 | children, even ones not watched. |
1553 | children, even ones not watched. |
1512 | |
1554 | |
1513 | =head3 Overriding the Built-In Processing |
1555 | =head3 Overriding the Built-In Processing |
… | |
… | |
1555 | =head3 Examples |
1597 | =head3 Examples |
1556 | |
1598 | |
1557 | Example: C<fork()> a new process and install a child handler to wait for |
1599 | Example: C<fork()> a new process and install a child handler to wait for |
1558 | its completion. |
1600 | its completion. |
1559 | |
1601 | |
1560 | ev_child cw; |
1602 | ev_child cw; |
1561 | |
1603 | |
1562 | static void |
1604 | static void |
1563 | child_cb (EV_P_ struct ev_child *w, int revents) |
1605 | child_cb (EV_P_ struct ev_child *w, int revents) |
1564 | { |
1606 | { |
1565 | ev_child_stop (EV_A_ w); |
1607 | ev_child_stop (EV_A_ w); |
1566 | printf ("process %d exited with status %x\n", w->rpid, w->rstatus); |
1608 | printf ("process %d exited with status %x\n", w->rpid, w->rstatus); |
1567 | } |
1609 | } |
1568 | |
1610 | |
1569 | pid_t pid = fork (); |
1611 | pid_t pid = fork (); |
1570 | |
1612 | |
1571 | if (pid < 0) |
1613 | if (pid < 0) |
1572 | // error |
1614 | // error |
1573 | else if (pid == 0) |
1615 | else if (pid == 0) |
1574 | { |
1616 | { |
1575 | // the forked child executes here |
1617 | // the forked child executes here |
1576 | exit (1); |
1618 | exit (1); |
1577 | } |
1619 | } |
1578 | else |
1620 | else |
1579 | { |
1621 | { |
1580 | ev_child_init (&cw, child_cb, pid, 0); |
1622 | ev_child_init (&cw, child_cb, pid, 0); |
1581 | ev_child_start (EV_DEFAULT_ &cw); |
1623 | ev_child_start (EV_DEFAULT_ &cw); |
1582 | } |
1624 | } |
1583 | |
1625 | |
1584 | |
1626 | |
1585 | =head2 C<ev_stat> - did the file attributes just change? |
1627 | =head2 C<ev_stat> - did the file attributes just change? |
1586 | |
1628 | |
1587 | This watches a filesystem path for attribute changes. That is, it calls |
1629 | This watches a file system path for attribute changes. That is, it calls |
1588 | C<stat> regularly (or when the OS says it changed) and sees if it changed |
1630 | C<stat> regularly (or when the OS says it changed) and sees if it changed |
1589 | compared to the last time, invoking the callback if it did. |
1631 | compared to the last time, invoking the callback if it did. |
1590 | |
1632 | |
1591 | The path does not need to exist: changing from "path exists" to "path does |
1633 | The path does not need to exist: changing from "path exists" to "path does |
1592 | not exist" is a status change like any other. The condition "path does |
1634 | not exist" is a status change like any other. The condition "path does |
… | |
… | |
1626 | disabled large file support, you get the 32 bit version of the stat |
1668 | disabled large file support, you get the 32 bit version of the stat |
1627 | structure. When using the library from programs that change the ABI to |
1669 | structure. When using the library from programs that change the ABI to |
1628 | use 64 bit file offsets the programs will fail. In that case you have to |
1670 | use 64 bit file offsets the programs will fail. In that case you have to |
1629 | compile libev with the same flags to get binary compatibility. This is |
1671 | compile libev with the same flags to get binary compatibility. This is |
1630 | obviously the case with any flags that change the ABI, but the problem is |
1672 | obviously the case with any flags that change the ABI, but the problem is |
1631 | most noticably with ev_stat and largefile support. |
1673 | most noticeably with ev_stat and large file support. |
1632 | |
1674 | |
1633 | =head3 Inotify |
1675 | =head3 Inotify |
1634 | |
1676 | |
1635 | When C<inotify (7)> support has been compiled into libev (generally only |
1677 | When C<inotify (7)> support has been compiled into libev (generally only |
1636 | available on Linux) and present at runtime, it will be used to speed up |
1678 | available on Linux) and present at runtime, it will be used to speed up |
… | |
… | |
1646 | implement this functionality, due to the requirement of having a file |
1688 | implement this functionality, due to the requirement of having a file |
1647 | descriptor open on the object at all times). |
1689 | descriptor open on the object at all times). |
1648 | |
1690 | |
1649 | =head3 The special problem of stat time resolution |
1691 | =head3 The special problem of stat time resolution |
1650 | |
1692 | |
1651 | The C<stat ()> syscall only supports full-second resolution portably, and |
1693 | The C<stat ()> system call only supports full-second resolution portably, and |
1652 | even on systems where the resolution is higher, many filesystems still |
1694 | even on systems where the resolution is higher, many file systems still |
1653 | only support whole seconds. |
1695 | only support whole seconds. |
1654 | |
1696 | |
1655 | That means that, if the time is the only thing that changes, you can |
1697 | That means that, if the time is the only thing that changes, you can |
1656 | easily miss updates: on the first update, C<ev_stat> detects a change and |
1698 | easily miss updates: on the first update, C<ev_stat> detects a change and |
1657 | calls your callback, which does something. When there is another update |
1699 | calls your callback, which does something. When there is another update |
1658 | within the same second, C<ev_stat> will be unable to detect it as the stat |
1700 | within the same second, C<ev_stat> will be unable to detect it as the stat |
1659 | data does not change. |
1701 | data does not change. |
1660 | |
1702 | |
1661 | The solution to this is to delay acting on a change for slightly more |
1703 | The solution to this is to delay acting on a change for slightly more |
1662 | than second (or till slightly after the next full second boundary), using |
1704 | than a second (or till slightly after the next full second boundary), using |
1663 | a roughly one-second-delay C<ev_timer> (e.g. C<ev_timer_set (w, 0., 1.02); |
1705 | a roughly one-second-delay C<ev_timer> (e.g. C<ev_timer_set (w, 0., 1.02); |
1664 | ev_timer_again (loop, w)>). |
1706 | ev_timer_again (loop, w)>). |
1665 | |
1707 | |
1666 | The C<.02> offset is added to work around small timing inconsistencies |
1708 | The C<.02> offset is added to work around small timing inconsistencies |
1667 | of some operating systems (where the second counter of the current time |
1709 | of some operating systems (where the second counter of the current time |
… | |
… | |
1717 | |
1759 | |
1718 | The specified interval. |
1760 | The specified interval. |
1719 | |
1761 | |
1720 | =item const char *path [read-only] |
1762 | =item const char *path [read-only] |
1721 | |
1763 | |
1722 | The filesystem path that is being watched. |
1764 | The file system path that is being watched. |
1723 | |
1765 | |
1724 | =back |
1766 | =back |
1725 | |
1767 | |
1726 | =head3 Examples |
1768 | =head3 Examples |
1727 | |
1769 | |
1728 | Example: Watch C</etc/passwd> for attribute changes. |
1770 | Example: Watch C</etc/passwd> for attribute changes. |
1729 | |
1771 | |
1730 | static void |
1772 | static void |
1731 | passwd_cb (struct ev_loop *loop, ev_stat *w, int revents) |
1773 | passwd_cb (struct ev_loop *loop, ev_stat *w, int revents) |
1732 | { |
1774 | { |
1733 | /* /etc/passwd changed in some way */ |
1775 | /* /etc/passwd changed in some way */ |
1734 | if (w->attr.st_nlink) |
1776 | if (w->attr.st_nlink) |
1735 | { |
1777 | { |
1736 | printf ("passwd current size %ld\n", (long)w->attr.st_size); |
1778 | printf ("passwd current size %ld\n", (long)w->attr.st_size); |
1737 | printf ("passwd current atime %ld\n", (long)w->attr.st_mtime); |
1779 | printf ("passwd current atime %ld\n", (long)w->attr.st_mtime); |
1738 | printf ("passwd current mtime %ld\n", (long)w->attr.st_mtime); |
1780 | printf ("passwd current mtime %ld\n", (long)w->attr.st_mtime); |
1739 | } |
1781 | } |
1740 | else |
1782 | else |
1741 | /* you shalt not abuse printf for puts */ |
1783 | /* you shalt not abuse printf for puts */ |
1742 | puts ("wow, /etc/passwd is not there, expect problems. " |
1784 | puts ("wow, /etc/passwd is not there, expect problems. " |
1743 | "if this is windows, they already arrived\n"); |
1785 | "if this is windows, they already arrived\n"); |
1744 | } |
1786 | } |
1745 | |
1787 | |
1746 | ... |
1788 | ... |
1747 | ev_stat passwd; |
1789 | ev_stat passwd; |
1748 | |
1790 | |
1749 | ev_stat_init (&passwd, passwd_cb, "/etc/passwd", 0.); |
1791 | ev_stat_init (&passwd, passwd_cb, "/etc/passwd", 0.); |
1750 | ev_stat_start (loop, &passwd); |
1792 | ev_stat_start (loop, &passwd); |
1751 | |
1793 | |
1752 | Example: Like above, but additionally use a one-second delay so we do not |
1794 | Example: Like above, but additionally use a one-second delay so we do not |
1753 | miss updates (however, frequent updates will delay processing, too, so |
1795 | miss updates (however, frequent updates will delay processing, too, so |
1754 | one might do the work both on C<ev_stat> callback invocation I<and> on |
1796 | one might do the work both on C<ev_stat> callback invocation I<and> on |
1755 | C<ev_timer> callback invocation). |
1797 | C<ev_timer> callback invocation). |
1756 | |
1798 | |
1757 | static ev_stat passwd; |
1799 | static ev_stat passwd; |
1758 | static ev_timer timer; |
1800 | static ev_timer timer; |
1759 | |
1801 | |
1760 | static void |
1802 | static void |
1761 | timer_cb (EV_P_ ev_timer *w, int revents) |
1803 | timer_cb (EV_P_ ev_timer *w, int revents) |
1762 | { |
1804 | { |
1763 | ev_timer_stop (EV_A_ w); |
1805 | ev_timer_stop (EV_A_ w); |
1764 | |
1806 | |
1765 | /* now it's one second after the most recent passwd change */ |
1807 | /* now it's one second after the most recent passwd change */ |
1766 | } |
1808 | } |
1767 | |
1809 | |
1768 | static void |
1810 | static void |
1769 | stat_cb (EV_P_ ev_stat *w, int revents) |
1811 | stat_cb (EV_P_ ev_stat *w, int revents) |
1770 | { |
1812 | { |
1771 | /* reset the one-second timer */ |
1813 | /* reset the one-second timer */ |
1772 | ev_timer_again (EV_A_ &timer); |
1814 | ev_timer_again (EV_A_ &timer); |
1773 | } |
1815 | } |
1774 | |
1816 | |
1775 | ... |
1817 | ... |
1776 | ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.); |
1818 | ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.); |
1777 | ev_stat_start (loop, &passwd); |
1819 | ev_stat_start (loop, &passwd); |
1778 | ev_timer_init (&timer, timer_cb, 0., 1.02); |
1820 | ev_timer_init (&timer, timer_cb, 0., 1.02); |
1779 | |
1821 | |
1780 | |
1822 | |
1781 | =head2 C<ev_idle> - when you've got nothing better to do... |
1823 | =head2 C<ev_idle> - when you've got nothing better to do... |
1782 | |
1824 | |
1783 | Idle watchers trigger events when no other events of the same or higher |
1825 | Idle watchers trigger events when no other events of the same or higher |
… | |
… | |
1814 | =head3 Examples |
1856 | =head3 Examples |
1815 | |
1857 | |
1816 | Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the |
1858 | Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the |
1817 | callback, free it. Also, use no error checking, as usual. |
1859 | callback, free it. Also, use no error checking, as usual. |
1818 | |
1860 | |
1819 | static void |
1861 | static void |
1820 | idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents) |
1862 | idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents) |
1821 | { |
1863 | { |
1822 | free (w); |
1864 | free (w); |
1823 | // now do something you wanted to do when the program has |
1865 | // now do something you wanted to do when the program has |
1824 | // no longer anything immediate to do. |
1866 | // no longer anything immediate to do. |
1825 | } |
1867 | } |
1826 | |
1868 | |
1827 | struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle)); |
1869 | struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle)); |
1828 | ev_idle_init (idle_watcher, idle_cb); |
1870 | ev_idle_init (idle_watcher, idle_cb); |
1829 | ev_idle_start (loop, idle_cb); |
1871 | ev_idle_start (loop, idle_cb); |
1830 | |
1872 | |
1831 | |
1873 | |
1832 | =head2 C<ev_prepare> and C<ev_check> - customise your event loop! |
1874 | =head2 C<ev_prepare> and C<ev_check> - customise your event loop! |
1833 | |
1875 | |
1834 | Prepare and check watchers are usually (but not always) used in tandem: |
1876 | Prepare and check watchers are usually (but not always) used in tandem: |
… | |
… | |
1853 | |
1895 | |
1854 | This is done by examining in each prepare call which file descriptors need |
1896 | This is done by examining in each prepare call which file descriptors need |
1855 | to be watched by the other library, registering C<ev_io> watchers for |
1897 | to be watched by the other library, registering C<ev_io> watchers for |
1856 | them and starting an C<ev_timer> watcher for any timeouts (many libraries |
1898 | them and starting an C<ev_timer> watcher for any timeouts (many libraries |
1857 | provide just this functionality). Then, in the check watcher you check for |
1899 | provide just this functionality). Then, in the check watcher you check for |
1858 | any events that occured (by checking the pending status of all watchers |
1900 | any events that occurred (by checking the pending status of all watchers |
1859 | and stopping them) and call back into the library. The I/O and timer |
1901 | and stopping them) and call back into the library. The I/O and timer |
1860 | callbacks will never actually be called (but must be valid nevertheless, |
1902 | callbacks will never actually be called (but must be valid nevertheless, |
1861 | because you never know, you know?). |
1903 | because you never know, you know?). |
1862 | |
1904 | |
1863 | As another example, the Perl Coro module uses these hooks to integrate |
1905 | As another example, the Perl Coro module uses these hooks to integrate |
… | |
… | |
1906 | and in a check watcher, destroy them and call into libadns. What follows |
1948 | and in a check watcher, destroy them and call into libadns. What follows |
1907 | is pseudo-code only of course. This requires you to either use a low |
1949 | is pseudo-code only of course. This requires you to either use a low |
1908 | priority for the check watcher or use C<ev_clear_pending> explicitly, as |
1950 | priority for the check watcher or use C<ev_clear_pending> explicitly, as |
1909 | the callbacks for the IO/timeout watchers might not have been called yet. |
1951 | the callbacks for the IO/timeout watchers might not have been called yet. |
1910 | |
1952 | |
1911 | static ev_io iow [nfd]; |
1953 | static ev_io iow [nfd]; |
1912 | static ev_timer tw; |
1954 | static ev_timer tw; |
1913 | |
1955 | |
1914 | static void |
1956 | static void |
1915 | io_cb (ev_loop *loop, ev_io *w, int revents) |
1957 | io_cb (ev_loop *loop, ev_io *w, int revents) |
1916 | { |
1958 | { |
1917 | } |
1959 | } |
1918 | |
1960 | |
1919 | // create io watchers for each fd and a timer before blocking |
1961 | // create io watchers for each fd and a timer before blocking |
1920 | static void |
1962 | static void |
1921 | adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents) |
1963 | adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents) |
1922 | { |
1964 | { |
1923 | int timeout = 3600000; |
1965 | int timeout = 3600000; |
1924 | struct pollfd fds [nfd]; |
1966 | struct pollfd fds [nfd]; |
1925 | // actual code will need to loop here and realloc etc. |
1967 | // actual code will need to loop here and realloc etc. |
1926 | adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); |
1968 | adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); |
1927 | |
1969 | |
1928 | /* the callback is illegal, but won't be called as we stop during check */ |
1970 | /* the callback is illegal, but won't be called as we stop during check */ |
1929 | ev_timer_init (&tw, 0, timeout * 1e-3); |
1971 | ev_timer_init (&tw, 0, timeout * 1e-3); |
1930 | ev_timer_start (loop, &tw); |
1972 | ev_timer_start (loop, &tw); |
1931 | |
1973 | |
1932 | // create one ev_io per pollfd |
1974 | // create one ev_io per pollfd |
1933 | for (int i = 0; i < nfd; ++i) |
1975 | for (int i = 0; i < nfd; ++i) |
1934 | { |
1976 | { |
1935 | ev_io_init (iow + i, io_cb, fds [i].fd, |
1977 | ev_io_init (iow + i, io_cb, fds [i].fd, |
1936 | ((fds [i].events & POLLIN ? EV_READ : 0) |
1978 | ((fds [i].events & POLLIN ? EV_READ : 0) |
1937 | | (fds [i].events & POLLOUT ? EV_WRITE : 0))); |
1979 | | (fds [i].events & POLLOUT ? EV_WRITE : 0))); |
1938 | |
1980 | |
1939 | fds [i].revents = 0; |
1981 | fds [i].revents = 0; |
1940 | ev_io_start (loop, iow + i); |
1982 | ev_io_start (loop, iow + i); |
1941 | } |
1983 | } |
1942 | } |
1984 | } |
1943 | |
1985 | |
1944 | // stop all watchers after blocking |
1986 | // stop all watchers after blocking |
1945 | static void |
1987 | static void |
1946 | adns_check_cb (ev_loop *loop, ev_check *w, int revents) |
1988 | adns_check_cb (ev_loop *loop, ev_check *w, int revents) |
1947 | { |
1989 | { |
1948 | ev_timer_stop (loop, &tw); |
1990 | ev_timer_stop (loop, &tw); |
1949 | |
1991 | |
1950 | for (int i = 0; i < nfd; ++i) |
1992 | for (int i = 0; i < nfd; ++i) |
1951 | { |
1993 | { |
1952 | // set the relevant poll flags |
1994 | // set the relevant poll flags |
1953 | // could also call adns_processreadable etc. here |
1995 | // could also call adns_processreadable etc. here |
1954 | struct pollfd *fd = fds + i; |
1996 | struct pollfd *fd = fds + i; |
1955 | int revents = ev_clear_pending (iow + i); |
1997 | int revents = ev_clear_pending (iow + i); |
1956 | if (revents & EV_READ ) fd->revents |= fd->events & POLLIN; |
1998 | if (revents & EV_READ ) fd->revents |= fd->events & POLLIN; |
1957 | if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT; |
1999 | if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT; |
1958 | |
2000 | |
1959 | // now stop the watcher |
2001 | // now stop the watcher |
1960 | ev_io_stop (loop, iow + i); |
2002 | ev_io_stop (loop, iow + i); |
1961 | } |
2003 | } |
1962 | |
2004 | |
1963 | adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop)); |
2005 | adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop)); |
1964 | } |
2006 | } |
1965 | |
2007 | |
1966 | Method 2: This would be just like method 1, but you run C<adns_afterpoll> |
2008 | Method 2: This would be just like method 1, but you run C<adns_afterpoll> |
1967 | in the prepare watcher and would dispose of the check watcher. |
2009 | in the prepare watcher and would dispose of the check watcher. |
1968 | |
2010 | |
1969 | Method 3: If the module to be embedded supports explicit event |
2011 | Method 3: If the module to be embedded supports explicit event |
1970 | notification (adns does), you can also make use of the actual watcher |
2012 | notification (libadns does), you can also make use of the actual watcher |
1971 | callbacks, and only destroy/create the watchers in the prepare watcher. |
2013 | callbacks, and only destroy/create the watchers in the prepare watcher. |
1972 | |
2014 | |
1973 | static void |
2015 | static void |
1974 | timer_cb (EV_P_ ev_timer *w, int revents) |
2016 | timer_cb (EV_P_ ev_timer *w, int revents) |
1975 | { |
2017 | { |
1976 | adns_state ads = (adns_state)w->data; |
2018 | adns_state ads = (adns_state)w->data; |
1977 | update_now (EV_A); |
2019 | update_now (EV_A); |
1978 | |
2020 | |
1979 | adns_processtimeouts (ads, &tv_now); |
2021 | adns_processtimeouts (ads, &tv_now); |
1980 | } |
2022 | } |
1981 | |
2023 | |
1982 | static void |
2024 | static void |
1983 | io_cb (EV_P_ ev_io *w, int revents) |
2025 | io_cb (EV_P_ ev_io *w, int revents) |
1984 | { |
2026 | { |
1985 | adns_state ads = (adns_state)w->data; |
2027 | adns_state ads = (adns_state)w->data; |
1986 | update_now (EV_A); |
2028 | update_now (EV_A); |
1987 | |
2029 | |
1988 | if (revents & EV_READ ) adns_processreadable (ads, w->fd, &tv_now); |
2030 | if (revents & EV_READ ) adns_processreadable (ads, w->fd, &tv_now); |
1989 | if (revents & EV_WRITE) adns_processwriteable (ads, w->fd, &tv_now); |
2031 | if (revents & EV_WRITE) adns_processwriteable (ads, w->fd, &tv_now); |
1990 | } |
2032 | } |
1991 | |
2033 | |
1992 | // do not ever call adns_afterpoll |
2034 | // do not ever call adns_afterpoll |
1993 | |
2035 | |
1994 | Method 4: Do not use a prepare or check watcher because the module you |
2036 | Method 4: Do not use a prepare or check watcher because the module you |
1995 | want to embed is too inflexible to support it. Instead, youc na override |
2037 | want to embed is too inflexible to support it. Instead, you can override |
1996 | their poll function. The drawback with this solution is that the main |
2038 | their poll function. The drawback with this solution is that the main |
1997 | loop is now no longer controllable by EV. The C<Glib::EV> module does |
2039 | loop is now no longer controllable by EV. The C<Glib::EV> module does |
1998 | this. |
2040 | this. |
1999 | |
2041 | |
2000 | static gint |
2042 | static gint |
2001 | event_poll_func (GPollFD *fds, guint nfds, gint timeout) |
2043 | event_poll_func (GPollFD *fds, guint nfds, gint timeout) |
2002 | { |
2044 | { |
2003 | int got_events = 0; |
2045 | int got_events = 0; |
2004 | |
2046 | |
2005 | for (n = 0; n < nfds; ++n) |
2047 | for (n = 0; n < nfds; ++n) |
2006 | // create/start io watcher that sets the relevant bits in fds[n] and increment got_events |
2048 | // create/start io watcher that sets the relevant bits in fds[n] and increment got_events |
2007 | |
2049 | |
2008 | if (timeout >= 0) |
2050 | if (timeout >= 0) |
2009 | // create/start timer |
2051 | // create/start timer |
2010 | |
2052 | |
2011 | // poll |
2053 | // poll |
2012 | ev_loop (EV_A_ 0); |
2054 | ev_loop (EV_A_ 0); |
2013 | |
2055 | |
2014 | // stop timer again |
2056 | // stop timer again |
2015 | if (timeout >= 0) |
2057 | if (timeout >= 0) |
2016 | ev_timer_stop (EV_A_ &to); |
2058 | ev_timer_stop (EV_A_ &to); |
2017 | |
2059 | |
2018 | // stop io watchers again - their callbacks should have set |
2060 | // stop io watchers again - their callbacks should have set |
2019 | for (n = 0; n < nfds; ++n) |
2061 | for (n = 0; n < nfds; ++n) |
2020 | ev_io_stop (EV_A_ iow [n]); |
2062 | ev_io_stop (EV_A_ iow [n]); |
2021 | |
2063 | |
2022 | return got_events; |
2064 | return got_events; |
2023 | } |
2065 | } |
2024 | |
2066 | |
2025 | |
2067 | |
2026 | =head2 C<ev_embed> - when one backend isn't enough... |
2068 | =head2 C<ev_embed> - when one backend isn't enough... |
2027 | |
2069 | |
2028 | This is a rather advanced watcher type that lets you embed one event loop |
2070 | This is a rather advanced watcher type that lets you embed one event loop |
… | |
… | |
2084 | |
2126 | |
2085 | Configures the watcher to embed the given loop, which must be |
2127 | Configures the watcher to embed the given loop, which must be |
2086 | embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be |
2128 | embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be |
2087 | invoked automatically, otherwise it is the responsibility of the callback |
2129 | invoked automatically, otherwise it is the responsibility of the callback |
2088 | to invoke it (it will continue to be called until the sweep has been done, |
2130 | to invoke it (it will continue to be called until the sweep has been done, |
2089 | if you do not want thta, you need to temporarily stop the embed watcher). |
2131 | if you do not want that, you need to temporarily stop the embed watcher). |
2090 | |
2132 | |
2091 | =item ev_embed_sweep (loop, ev_embed *) |
2133 | =item ev_embed_sweep (loop, ev_embed *) |
2092 | |
2134 | |
2093 | Make a single, non-blocking sweep over the embedded loop. This works |
2135 | Make a single, non-blocking sweep over the embedded loop. This works |
2094 | similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most |
2136 | similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most |
2095 | apropriate way for embedded loops. |
2137 | appropriate way for embedded loops. |
2096 | |
2138 | |
2097 | =item struct ev_loop *other [read-only] |
2139 | =item struct ev_loop *other [read-only] |
2098 | |
2140 | |
2099 | The embedded event loop. |
2141 | The embedded event loop. |
2100 | |
2142 | |
… | |
… | |
2102 | |
2144 | |
2103 | =head3 Examples |
2145 | =head3 Examples |
2104 | |
2146 | |
2105 | Example: Try to get an embeddable event loop and embed it into the default |
2147 | Example: Try to get an embeddable event loop and embed it into the default |
2106 | event loop. If that is not possible, use the default loop. The default |
2148 | event loop. If that is not possible, use the default loop. The default |
2107 | loop is stored in C<loop_hi>, while the mebeddable loop is stored in |
2149 | loop is stored in C<loop_hi>, while the embeddable loop is stored in |
2108 | C<loop_lo> (which is C<loop_hi> in the acse no embeddable loop can be |
2150 | C<loop_lo> (which is C<loop_hi> in the case no embeddable loop can be |
2109 | used). |
2151 | used). |
2110 | |
2152 | |
2111 | struct ev_loop *loop_hi = ev_default_init (0); |
2153 | struct ev_loop *loop_hi = ev_default_init (0); |
2112 | struct ev_loop *loop_lo = 0; |
2154 | struct ev_loop *loop_lo = 0; |
2113 | struct ev_embed embed; |
2155 | struct ev_embed embed; |
2114 | |
2156 | |
2115 | // see if there is a chance of getting one that works |
2157 | // see if there is a chance of getting one that works |
2116 | // (remember that a flags value of 0 means autodetection) |
2158 | // (remember that a flags value of 0 means autodetection) |
2117 | loop_lo = ev_embeddable_backends () & ev_recommended_backends () |
2159 | loop_lo = ev_embeddable_backends () & ev_recommended_backends () |
2118 | ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) |
2160 | ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) |
2119 | : 0; |
2161 | : 0; |
2120 | |
2162 | |
2121 | // if we got one, then embed it, otherwise default to loop_hi |
2163 | // if we got one, then embed it, otherwise default to loop_hi |
2122 | if (loop_lo) |
2164 | if (loop_lo) |
2123 | { |
2165 | { |
2124 | ev_embed_init (&embed, 0, loop_lo); |
2166 | ev_embed_init (&embed, 0, loop_lo); |
2125 | ev_embed_start (loop_hi, &embed); |
2167 | ev_embed_start (loop_hi, &embed); |
2126 | } |
2168 | } |
2127 | else |
2169 | else |
2128 | loop_lo = loop_hi; |
2170 | loop_lo = loop_hi; |
2129 | |
2171 | |
2130 | Example: Check if kqueue is available but not recommended and create |
2172 | Example: Check if kqueue is available but not recommended and create |
2131 | a kqueue backend for use with sockets (which usually work with any |
2173 | a kqueue backend for use with sockets (which usually work with any |
2132 | kqueue implementation). Store the kqueue/socket-only event loop in |
2174 | kqueue implementation). Store the kqueue/socket-only event loop in |
2133 | C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too). |
2175 | C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too). |
2134 | |
2176 | |
2135 | struct ev_loop *loop = ev_default_init (0); |
2177 | struct ev_loop *loop = ev_default_init (0); |
2136 | struct ev_loop *loop_socket = 0; |
2178 | struct ev_loop *loop_socket = 0; |
2137 | struct ev_embed embed; |
2179 | struct ev_embed embed; |
2138 | |
2180 | |
2139 | if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) |
2181 | if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) |
2140 | if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) |
2182 | if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) |
2141 | { |
2183 | { |
2142 | ev_embed_init (&embed, 0, loop_socket); |
2184 | ev_embed_init (&embed, 0, loop_socket); |
2143 | ev_embed_start (loop, &embed); |
2185 | ev_embed_start (loop, &embed); |
2144 | } |
2186 | } |
2145 | |
2187 | |
2146 | if (!loop_socket) |
2188 | if (!loop_socket) |
2147 | loop_socket = loop; |
2189 | loop_socket = loop; |
2148 | |
2190 | |
2149 | // now use loop_socket for all sockets, and loop for everything else |
2191 | // now use loop_socket for all sockets, and loop for everything else |
2150 | |
2192 | |
2151 | |
2193 | |
2152 | =head2 C<ev_fork> - the audacity to resume the event loop after a fork |
2194 | =head2 C<ev_fork> - the audacity to resume the event loop after a fork |
2153 | |
2195 | |
2154 | Fork watchers are called when a C<fork ()> was detected (usually because |
2196 | Fork watchers are called when a C<fork ()> was detected (usually because |
… | |
… | |
2207 | |
2249 | |
2208 | =item queueing from a signal handler context |
2250 | =item queueing from a signal handler context |
2209 | |
2251 | |
2210 | To implement race-free queueing, you simply add to the queue in the signal |
2252 | To implement race-free queueing, you simply add to the queue in the signal |
2211 | handler but you block the signal handler in the watcher callback. Here is an example that does that for |
2253 | handler but you block the signal handler in the watcher callback. Here is an example that does that for |
2212 | some fictitiuous SIGUSR1 handler: |
2254 | some fictitious SIGUSR1 handler: |
2213 | |
2255 | |
2214 | static ev_async mysig; |
2256 | static ev_async mysig; |
2215 | |
2257 | |
2216 | static void |
2258 | static void |
2217 | sigusr1_handler (void) |
2259 | sigusr1_handler (void) |
… | |
… | |
2291 | =item ev_async_send (loop, ev_async *) |
2333 | =item ev_async_send (loop, ev_async *) |
2292 | |
2334 | |
2293 | Sends/signals/activates the given C<ev_async> watcher, that is, feeds |
2335 | Sends/signals/activates the given C<ev_async> watcher, that is, feeds |
2294 | an C<EV_ASYNC> event on the watcher into the event loop. Unlike |
2336 | an C<EV_ASYNC> event on the watcher into the event loop. Unlike |
2295 | C<ev_feed_event>, this call is safe to do in other threads, signal or |
2337 | C<ev_feed_event>, this call is safe to do in other threads, signal or |
2296 | similar contexts (see the dicusssion of C<EV_ATOMIC_T> in the embedding |
2338 | similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding |
2297 | section below on what exactly this means). |
2339 | section below on what exactly this means). |
2298 | |
2340 | |
2299 | This call incurs the overhead of a syscall only once per loop iteration, |
2341 | This call incurs the overhead of a system call only once per loop iteration, |
2300 | so while the overhead might be noticable, it doesn't apply to repeated |
2342 | so while the overhead might be noticeable, it doesn't apply to repeated |
2301 | calls to C<ev_async_send>. |
2343 | calls to C<ev_async_send>. |
2302 | |
2344 | |
2303 | =item bool = ev_async_pending (ev_async *) |
2345 | =item bool = ev_async_pending (ev_async *) |
2304 | |
2346 | |
2305 | Returns a non-zero value when C<ev_async_send> has been called on the |
2347 | Returns a non-zero value when C<ev_async_send> has been called on the |
… | |
… | |
2307 | event loop. |
2349 | event loop. |
2308 | |
2350 | |
2309 | C<ev_async_send> sets a flag in the watcher and wakes up the loop. When |
2351 | C<ev_async_send> sets a flag in the watcher and wakes up the loop. When |
2310 | the loop iterates next and checks for the watcher to have become active, |
2352 | the loop iterates next and checks for the watcher to have become active, |
2311 | it will reset the flag again. C<ev_async_pending> can be used to very |
2353 | it will reset the flag again. C<ev_async_pending> can be used to very |
2312 | quickly check wether invoking the loop might be a good idea. |
2354 | quickly check whether invoking the loop might be a good idea. |
2313 | |
2355 | |
2314 | Not that this does I<not> check wether the watcher itself is pending, only |
2356 | Not that this does I<not> check whether the watcher itself is pending, only |
2315 | wether it has been requested to make this watcher pending. |
2357 | whether it has been requested to make this watcher pending. |
2316 | |
2358 | |
2317 | =back |
2359 | =back |
2318 | |
2360 | |
2319 | |
2361 | |
2320 | =head1 OTHER FUNCTIONS |
2362 | =head1 OTHER FUNCTIONS |
… | |
… | |
2331 | or timeout without having to allocate/configure/start/stop/free one or |
2373 | or timeout without having to allocate/configure/start/stop/free one or |
2332 | more watchers yourself. |
2374 | more watchers yourself. |
2333 | |
2375 | |
2334 | If C<fd> is less than 0, then no I/O watcher will be started and events |
2376 | If C<fd> is less than 0, then no I/O watcher will be started and events |
2335 | is being ignored. Otherwise, an C<ev_io> watcher for the given C<fd> and |
2377 | is being ignored. Otherwise, an C<ev_io> watcher for the given C<fd> and |
2336 | C<events> set will be craeted and started. |
2378 | C<events> set will be created and started. |
2337 | |
2379 | |
2338 | If C<timeout> is less than 0, then no timeout watcher will be |
2380 | If C<timeout> is less than 0, then no timeout watcher will be |
2339 | started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and |
2381 | started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and |
2340 | repeat = 0) will be started. While C<0> is a valid timeout, it is of |
2382 | repeat = 0) will be started. While C<0> is a valid timeout, it is of |
2341 | dubious value. |
2383 | dubious value. |
… | |
… | |
2343 | The callback has the type C<void (*cb)(int revents, void *arg)> and gets |
2385 | The callback has the type C<void (*cb)(int revents, void *arg)> and gets |
2344 | passed an C<revents> set like normal event callbacks (a combination of |
2386 | passed an C<revents> set like normal event callbacks (a combination of |
2345 | C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg> |
2387 | C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg> |
2346 | value passed to C<ev_once>: |
2388 | value passed to C<ev_once>: |
2347 | |
2389 | |
2348 | static void stdin_ready (int revents, void *arg) |
2390 | static void stdin_ready (int revents, void *arg) |
2349 | { |
2391 | { |
2350 | if (revents & EV_TIMEOUT) |
2392 | if (revents & EV_TIMEOUT) |
2351 | /* doh, nothing entered */; |
2393 | /* doh, nothing entered */; |
2352 | else if (revents & EV_READ) |
2394 | else if (revents & EV_READ) |
2353 | /* stdin might have data for us, joy! */; |
2395 | /* stdin might have data for us, joy! */; |
2354 | } |
2396 | } |
2355 | |
2397 | |
2356 | ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); |
2398 | ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); |
2357 | |
2399 | |
2358 | =item ev_feed_event (ev_loop *, watcher *, int revents) |
2400 | =item ev_feed_event (ev_loop *, watcher *, int revents) |
2359 | |
2401 | |
2360 | Feeds the given event set into the event loop, as if the specified event |
2402 | Feeds the given event set into the event loop, as if the specified event |
2361 | had happened for the specified watcher (which must be a pointer to an |
2403 | had happened for the specified watcher (which must be a pointer to an |
… | |
… | |
2366 | Feed an event on the given fd, as if a file descriptor backend detected |
2408 | Feed an event on the given fd, as if a file descriptor backend detected |
2367 | the given events it. |
2409 | the given events it. |
2368 | |
2410 | |
2369 | =item ev_feed_signal_event (ev_loop *loop, int signum) |
2411 | =item ev_feed_signal_event (ev_loop *loop, int signum) |
2370 | |
2412 | |
2371 | Feed an event as if the given signal occured (C<loop> must be the default |
2413 | Feed an event as if the given signal occurred (C<loop> must be the default |
2372 | loop!). |
2414 | loop!). |
2373 | |
2415 | |
2374 | =back |
2416 | =back |
2375 | |
2417 | |
2376 | |
2418 | |
… | |
… | |
2405 | =back |
2447 | =back |
2406 | |
2448 | |
2407 | =head1 C++ SUPPORT |
2449 | =head1 C++ SUPPORT |
2408 | |
2450 | |
2409 | Libev comes with some simplistic wrapper classes for C++ that mainly allow |
2451 | Libev comes with some simplistic wrapper classes for C++ that mainly allow |
2410 | you to use some convinience methods to start/stop watchers and also change |
2452 | you to use some convenience methods to start/stop watchers and also change |
2411 | the callback model to a model using method callbacks on objects. |
2453 | the callback model to a model using method callbacks on objects. |
2412 | |
2454 | |
2413 | To use it, |
2455 | To use it, |
2414 | |
2456 | |
2415 | #include <ev++.h> |
2457 | #include <ev++.h> |
2416 | |
2458 | |
2417 | This automatically includes F<ev.h> and puts all of its definitions (many |
2459 | This automatically includes F<ev.h> and puts all of its definitions (many |
2418 | of them macros) into the global namespace. All C++ specific things are |
2460 | of them macros) into the global namespace. All C++ specific things are |
2419 | put into the C<ev> namespace. It should support all the same embedding |
2461 | put into the C<ev> namespace. It should support all the same embedding |
2420 | options as F<ev.h>, most notably C<EV_MULTIPLICITY>. |
2462 | options as F<ev.h>, most notably C<EV_MULTIPLICITY>. |
… | |
… | |
2487 | your compiler is good :), then the method will be fully inlined into the |
2529 | your compiler is good :), then the method will be fully inlined into the |
2488 | thunking function, making it as fast as a direct C callback. |
2530 | thunking function, making it as fast as a direct C callback. |
2489 | |
2531 | |
2490 | Example: simple class declaration and watcher initialisation |
2532 | Example: simple class declaration and watcher initialisation |
2491 | |
2533 | |
2492 | struct myclass |
2534 | struct myclass |
2493 | { |
2535 | { |
2494 | void io_cb (ev::io &w, int revents) { } |
2536 | void io_cb (ev::io &w, int revents) { } |
2495 | } |
2537 | } |
2496 | |
2538 | |
2497 | myclass obj; |
2539 | myclass obj; |
2498 | ev::io iow; |
2540 | ev::io iow; |
2499 | iow.set <myclass, &myclass::io_cb> (&obj); |
2541 | iow.set <myclass, &myclass::io_cb> (&obj); |
2500 | |
2542 | |
2501 | =item w->set<function> (void *data = 0) |
2543 | =item w->set<function> (void *data = 0) |
2502 | |
2544 | |
2503 | Also sets a callback, but uses a static method or plain function as |
2545 | Also sets a callback, but uses a static method or plain function as |
2504 | callback. The optional C<data> argument will be stored in the watcher's |
2546 | callback. The optional C<data> argument will be stored in the watcher's |
… | |
… | |
2508 | |
2550 | |
2509 | See the method-C<set> above for more details. |
2551 | See the method-C<set> above for more details. |
2510 | |
2552 | |
2511 | Example: |
2553 | Example: |
2512 | |
2554 | |
2513 | static void io_cb (ev::io &w, int revents) { } |
2555 | static void io_cb (ev::io &w, int revents) { } |
2514 | iow.set <io_cb> (); |
2556 | iow.set <io_cb> (); |
2515 | |
2557 | |
2516 | =item w->set (struct ev_loop *) |
2558 | =item w->set (struct ev_loop *) |
2517 | |
2559 | |
2518 | Associates a different C<struct ev_loop> with this watcher. You can only |
2560 | Associates a different C<struct ev_loop> with this watcher. You can only |
2519 | do this when the watcher is inactive (and not pending either). |
2561 | do this when the watcher is inactive (and not pending either). |
2520 | |
2562 | |
2521 | =item w->set ([args]) |
2563 | =item w->set ([arguments]) |
2522 | |
2564 | |
2523 | Basically the same as C<ev_TYPE_set>, with the same args. Must be |
2565 | Basically the same as C<ev_TYPE_set>, with the same arguments. Must be |
2524 | called at least once. Unlike the C counterpart, an active watcher gets |
2566 | called at least once. Unlike the C counterpart, an active watcher gets |
2525 | automatically stopped and restarted when reconfiguring it with this |
2567 | automatically stopped and restarted when reconfiguring it with this |
2526 | method. |
2568 | method. |
2527 | |
2569 | |
2528 | =item w->start () |
2570 | =item w->start () |
… | |
… | |
2552 | =back |
2594 | =back |
2553 | |
2595 | |
2554 | Example: Define a class with an IO and idle watcher, start one of them in |
2596 | Example: Define a class with an IO and idle watcher, start one of them in |
2555 | the constructor. |
2597 | the constructor. |
2556 | |
2598 | |
2557 | class myclass |
2599 | class myclass |
2558 | { |
2600 | { |
2559 | ev::io io; void io_cb (ev::io &w, int revents); |
2601 | ev::io io; void io_cb (ev::io &w, int revents); |
2560 | ev:idle idle void idle_cb (ev::idle &w, int revents); |
2602 | ev:idle idle void idle_cb (ev::idle &w, int revents); |
2561 | |
2603 | |
2562 | myclass (int fd) |
2604 | myclass (int fd) |
2563 | { |
2605 | { |
2564 | io .set <myclass, &myclass::io_cb > (this); |
2606 | io .set <myclass, &myclass::io_cb > (this); |
2565 | idle.set <myclass, &myclass::idle_cb> (this); |
2607 | idle.set <myclass, &myclass::idle_cb> (this); |
2566 | |
2608 | |
2567 | io.start (fd, ev::READ); |
2609 | io.start (fd, ev::READ); |
2568 | } |
2610 | } |
2569 | }; |
2611 | }; |
2570 | |
2612 | |
2571 | |
2613 | |
2572 | =head1 OTHER LANGUAGE BINDINGS |
2614 | =head1 OTHER LANGUAGE BINDINGS |
2573 | |
2615 | |
2574 | Libev does not offer other language bindings itself, but bindings for a |
2616 | Libev does not offer other language bindings itself, but bindings for a |
2575 | numbe rof languages exist in the form of third-party packages. If you know |
2617 | number of languages exist in the form of third-party packages. If you know |
2576 | any interesting language binding in addition to the ones listed here, drop |
2618 | any interesting language binding in addition to the ones listed here, drop |
2577 | me a note. |
2619 | me a note. |
2578 | |
2620 | |
2579 | =over 4 |
2621 | =over 4 |
2580 | |
2622 | |
… | |
… | |
2584 | libev. EV is developed together with libev. Apart from the EV core module, |
2626 | libev. EV is developed together with libev. Apart from the EV core module, |
2585 | there are additional modules that implement libev-compatible interfaces |
2627 | there are additional modules that implement libev-compatible interfaces |
2586 | to C<libadns> (C<EV::ADNS>), C<Net::SNMP> (C<Net::SNMP::EV>) and the |
2628 | to C<libadns> (C<EV::ADNS>), C<Net::SNMP> (C<Net::SNMP::EV>) and the |
2587 | C<libglib> event core (C<Glib::EV> and C<EV::Glib>). |
2629 | C<libglib> event core (C<Glib::EV> and C<EV::Glib>). |
2588 | |
2630 | |
2589 | It can be found and installed via CPAN, its homepage is found at |
2631 | It can be found and installed via CPAN, its homepage is at |
2590 | L<http://software.schmorp.de/pkg/EV>. |
2632 | L<http://software.schmorp.de/pkg/EV>. |
2591 | |
2633 | |
|
|
2634 | =item Python |
|
|
2635 | |
|
|
2636 | Python bindings can be found at L<http://code.google.com/p/pyev/>. It |
|
|
2637 | seems to be quite complete and well-documented. Note, however, that the |
|
|
2638 | patch they require for libev is outright dangerous as it breaks the ABI |
|
|
2639 | for everybody else, and therefore, should never be applied in an installed |
|
|
2640 | libev (if python requires an incompatible ABI then it needs to embed |
|
|
2641 | libev). |
|
|
2642 | |
2592 | =item Ruby |
2643 | =item Ruby |
2593 | |
2644 | |
2594 | Tony Arcieri has written a ruby extension that offers access to a subset |
2645 | Tony Arcieri has written a ruby extension that offers access to a subset |
2595 | of the libev API and adds filehandle abstractions, asynchronous DNS and |
2646 | of the libev API and adds file handle abstractions, asynchronous DNS and |
2596 | more on top of it. It can be found via gem servers. Its homepage is at |
2647 | more on top of it. It can be found via gem servers. Its homepage is at |
2597 | L<http://rev.rubyforge.org/>. |
2648 | L<http://rev.rubyforge.org/>. |
2598 | |
2649 | |
2599 | =item D |
2650 | =item D |
2600 | |
2651 | |
… | |
… | |
2604 | =back |
2655 | =back |
2605 | |
2656 | |
2606 | |
2657 | |
2607 | =head1 MACRO MAGIC |
2658 | =head1 MACRO MAGIC |
2608 | |
2659 | |
2609 | Libev can be compiled with a variety of options, the most fundamantal |
2660 | Libev can be compiled with a variety of options, the most fundamental |
2610 | of which is C<EV_MULTIPLICITY>. This option determines whether (most) |
2661 | of which is C<EV_MULTIPLICITY>. This option determines whether (most) |
2611 | functions and callbacks have an initial C<struct ev_loop *> argument. |
2662 | functions and callbacks have an initial C<struct ev_loop *> argument. |
2612 | |
2663 | |
2613 | To make it easier to write programs that cope with either variant, the |
2664 | To make it easier to write programs that cope with either variant, the |
2614 | following macros are defined: |
2665 | following macros are defined: |
… | |
… | |
2619 | |
2670 | |
2620 | This provides the loop I<argument> for functions, if one is required ("ev |
2671 | This provides the loop I<argument> for functions, if one is required ("ev |
2621 | loop argument"). The C<EV_A> form is used when this is the sole argument, |
2672 | loop argument"). The C<EV_A> form is used when this is the sole argument, |
2622 | C<EV_A_> is used when other arguments are following. Example: |
2673 | C<EV_A_> is used when other arguments are following. Example: |
2623 | |
2674 | |
2624 | ev_unref (EV_A); |
2675 | ev_unref (EV_A); |
2625 | ev_timer_add (EV_A_ watcher); |
2676 | ev_timer_add (EV_A_ watcher); |
2626 | ev_loop (EV_A_ 0); |
2677 | ev_loop (EV_A_ 0); |
2627 | |
2678 | |
2628 | It assumes the variable C<loop> of type C<struct ev_loop *> is in scope, |
2679 | It assumes the variable C<loop> of type C<struct ev_loop *> is in scope, |
2629 | which is often provided by the following macro. |
2680 | which is often provided by the following macro. |
2630 | |
2681 | |
2631 | =item C<EV_P>, C<EV_P_> |
2682 | =item C<EV_P>, C<EV_P_> |
2632 | |
2683 | |
2633 | This provides the loop I<parameter> for functions, if one is required ("ev |
2684 | This provides the loop I<parameter> for functions, if one is required ("ev |
2634 | loop parameter"). The C<EV_P> form is used when this is the sole parameter, |
2685 | loop parameter"). The C<EV_P> form is used when this is the sole parameter, |
2635 | C<EV_P_> is used when other parameters are following. Example: |
2686 | C<EV_P_> is used when other parameters are following. Example: |
2636 | |
2687 | |
2637 | // this is how ev_unref is being declared |
2688 | // this is how ev_unref is being declared |
2638 | static void ev_unref (EV_P); |
2689 | static void ev_unref (EV_P); |
2639 | |
2690 | |
2640 | // this is how you can declare your typical callback |
2691 | // this is how you can declare your typical callback |
2641 | static void cb (EV_P_ ev_timer *w, int revents) |
2692 | static void cb (EV_P_ ev_timer *w, int revents) |
2642 | |
2693 | |
2643 | It declares a parameter C<loop> of type C<struct ev_loop *>, quite |
2694 | It declares a parameter C<loop> of type C<struct ev_loop *>, quite |
2644 | suitable for use with C<EV_A>. |
2695 | suitable for use with C<EV_A>. |
2645 | |
2696 | |
2646 | =item C<EV_DEFAULT>, C<EV_DEFAULT_> |
2697 | =item C<EV_DEFAULT>, C<EV_DEFAULT_> |
… | |
… | |
2662 | |
2713 | |
2663 | Example: Declare and initialise a check watcher, utilising the above |
2714 | Example: Declare and initialise a check watcher, utilising the above |
2664 | macros so it will work regardless of whether multiple loops are supported |
2715 | macros so it will work regardless of whether multiple loops are supported |
2665 | or not. |
2716 | or not. |
2666 | |
2717 | |
2667 | static void |
2718 | static void |
2668 | check_cb (EV_P_ ev_timer *w, int revents) |
2719 | check_cb (EV_P_ ev_timer *w, int revents) |
2669 | { |
2720 | { |
2670 | ev_check_stop (EV_A_ w); |
2721 | ev_check_stop (EV_A_ w); |
2671 | } |
2722 | } |
2672 | |
2723 | |
2673 | ev_check check; |
2724 | ev_check check; |
2674 | ev_check_init (&check, check_cb); |
2725 | ev_check_init (&check, check_cb); |
2675 | ev_check_start (EV_DEFAULT_ &check); |
2726 | ev_check_start (EV_DEFAULT_ &check); |
2676 | ev_loop (EV_DEFAULT_ 0); |
2727 | ev_loop (EV_DEFAULT_ 0); |
2677 | |
2728 | |
2678 | =head1 EMBEDDING |
2729 | =head1 EMBEDDING |
2679 | |
2730 | |
2680 | Libev can (and often is) directly embedded into host |
2731 | Libev can (and often is) directly embedded into host |
2681 | applications. Examples of applications that embed it include the Deliantra |
2732 | applications. Examples of applications that embed it include the Deliantra |
… | |
… | |
2688 | libev somewhere in your source tree). |
2739 | libev somewhere in your source tree). |
2689 | |
2740 | |
2690 | =head2 FILESETS |
2741 | =head2 FILESETS |
2691 | |
2742 | |
2692 | Depending on what features you need you need to include one or more sets of files |
2743 | Depending on what features you need you need to include one or more sets of files |
2693 | in your app. |
2744 | in your application. |
2694 | |
2745 | |
2695 | =head3 CORE EVENT LOOP |
2746 | =head3 CORE EVENT LOOP |
2696 | |
2747 | |
2697 | To include only the libev core (all the C<ev_*> functions), with manual |
2748 | To include only the libev core (all the C<ev_*> functions), with manual |
2698 | configuration (no autoconf): |
2749 | configuration (no autoconf): |
2699 | |
2750 | |
2700 | #define EV_STANDALONE 1 |
2751 | #define EV_STANDALONE 1 |
2701 | #include "ev.c" |
2752 | #include "ev.c" |
2702 | |
2753 | |
2703 | This will automatically include F<ev.h>, too, and should be done in a |
2754 | This will automatically include F<ev.h>, too, and should be done in a |
2704 | single C source file only to provide the function implementations. To use |
2755 | single C source file only to provide the function implementations. To use |
2705 | it, do the same for F<ev.h> in all files wishing to use this API (best |
2756 | it, do the same for F<ev.h> in all files wishing to use this API (best |
2706 | done by writing a wrapper around F<ev.h> that you can include instead and |
2757 | done by writing a wrapper around F<ev.h> that you can include instead and |
2707 | where you can put other configuration options): |
2758 | where you can put other configuration options): |
2708 | |
2759 | |
2709 | #define EV_STANDALONE 1 |
2760 | #define EV_STANDALONE 1 |
2710 | #include "ev.h" |
2761 | #include "ev.h" |
2711 | |
2762 | |
2712 | Both header files and implementation files can be compiled with a C++ |
2763 | Both header files and implementation files can be compiled with a C++ |
2713 | compiler (at least, thats a stated goal, and breakage will be treated |
2764 | compiler (at least, thats a stated goal, and breakage will be treated |
2714 | as a bug). |
2765 | as a bug). |
2715 | |
2766 | |
2716 | You need the following files in your source tree, or in a directory |
2767 | You need the following files in your source tree, or in a directory |
2717 | in your include path (e.g. in libev/ when using -Ilibev): |
2768 | in your include path (e.g. in libev/ when using -Ilibev): |
2718 | |
2769 | |
2719 | ev.h |
2770 | ev.h |
2720 | ev.c |
2771 | ev.c |
2721 | ev_vars.h |
2772 | ev_vars.h |
2722 | ev_wrap.h |
2773 | ev_wrap.h |
2723 | |
2774 | |
2724 | ev_win32.c required on win32 platforms only |
2775 | ev_win32.c required on win32 platforms only |
2725 | |
2776 | |
2726 | ev_select.c only when select backend is enabled (which is enabled by default) |
2777 | ev_select.c only when select backend is enabled (which is enabled by default) |
2727 | ev_poll.c only when poll backend is enabled (disabled by default) |
2778 | ev_poll.c only when poll backend is enabled (disabled by default) |
2728 | ev_epoll.c only when the epoll backend is enabled (disabled by default) |
2779 | ev_epoll.c only when the epoll backend is enabled (disabled by default) |
2729 | ev_kqueue.c only when the kqueue backend is enabled (disabled by default) |
2780 | ev_kqueue.c only when the kqueue backend is enabled (disabled by default) |
2730 | ev_port.c only when the solaris port backend is enabled (disabled by default) |
2781 | ev_port.c only when the solaris port backend is enabled (disabled by default) |
2731 | |
2782 | |
2732 | F<ev.c> includes the backend files directly when enabled, so you only need |
2783 | F<ev.c> includes the backend files directly when enabled, so you only need |
2733 | to compile this single file. |
2784 | to compile this single file. |
2734 | |
2785 | |
2735 | =head3 LIBEVENT COMPATIBILITY API |
2786 | =head3 LIBEVENT COMPATIBILITY API |
2736 | |
2787 | |
2737 | To include the libevent compatibility API, also include: |
2788 | To include the libevent compatibility API, also include: |
2738 | |
2789 | |
2739 | #include "event.c" |
2790 | #include "event.c" |
2740 | |
2791 | |
2741 | in the file including F<ev.c>, and: |
2792 | in the file including F<ev.c>, and: |
2742 | |
2793 | |
2743 | #include "event.h" |
2794 | #include "event.h" |
2744 | |
2795 | |
2745 | in the files that want to use the libevent API. This also includes F<ev.h>. |
2796 | in the files that want to use the libevent API. This also includes F<ev.h>. |
2746 | |
2797 | |
2747 | You need the following additional files for this: |
2798 | You need the following additional files for this: |
2748 | |
2799 | |
2749 | event.h |
2800 | event.h |
2750 | event.c |
2801 | event.c |
2751 | |
2802 | |
2752 | =head3 AUTOCONF SUPPORT |
2803 | =head3 AUTOCONF SUPPORT |
2753 | |
2804 | |
2754 | Instead of using C<EV_STANDALONE=1> and providing your config in |
2805 | Instead of using C<EV_STANDALONE=1> and providing your configuration in |
2755 | whatever way you want, you can also C<m4_include([libev.m4])> in your |
2806 | whatever way you want, you can also C<m4_include([libev.m4])> in your |
2756 | F<configure.ac> and leave C<EV_STANDALONE> undefined. F<ev.c> will then |
2807 | F<configure.ac> and leave C<EV_STANDALONE> undefined. F<ev.c> will then |
2757 | include F<config.h> and configure itself accordingly. |
2808 | include F<config.h> and configure itself accordingly. |
2758 | |
2809 | |
2759 | For this of course you need the m4 file: |
2810 | For this of course you need the m4 file: |
2760 | |
2811 | |
2761 | libev.m4 |
2812 | libev.m4 |
2762 | |
2813 | |
2763 | =head2 PREPROCESSOR SYMBOLS/MACROS |
2814 | =head2 PREPROCESSOR SYMBOLS/MACROS |
2764 | |
2815 | |
2765 | Libev can be configured via a variety of preprocessor symbols you have to |
2816 | Libev can be configured via a variety of preprocessor symbols you have to |
2766 | define before including any of its files. The default in the absense of |
2817 | define before including any of its files. The default in the absence of |
2767 | autoconf is noted for every option. |
2818 | autoconf is noted for every option. |
2768 | |
2819 | |
2769 | =over 4 |
2820 | =over 4 |
2770 | |
2821 | |
2771 | =item EV_STANDALONE |
2822 | =item EV_STANDALONE |
… | |
… | |
2777 | F<event.h> that are not directly supported by the libev core alone. |
2828 | F<event.h> that are not directly supported by the libev core alone. |
2778 | |
2829 | |
2779 | =item EV_USE_MONOTONIC |
2830 | =item EV_USE_MONOTONIC |
2780 | |
2831 | |
2781 | If defined to be C<1>, libev will try to detect the availability of the |
2832 | If defined to be C<1>, libev will try to detect the availability of the |
2782 | monotonic clock option at both compiletime and runtime. Otherwise no use |
2833 | monotonic clock option at both compile time and runtime. Otherwise no use |
2783 | of the monotonic clock option will be attempted. If you enable this, you |
2834 | of the monotonic clock option will be attempted. If you enable this, you |
2784 | usually have to link against librt or something similar. Enabling it when |
2835 | usually have to link against librt or something similar. Enabling it when |
2785 | the functionality isn't available is safe, though, although you have |
2836 | the functionality isn't available is safe, though, although you have |
2786 | to make sure you link against any libraries where the C<clock_gettime> |
2837 | to make sure you link against any libraries where the C<clock_gettime> |
2787 | function is hiding in (often F<-lrt>). |
2838 | function is hiding in (often F<-lrt>). |
2788 | |
2839 | |
2789 | =item EV_USE_REALTIME |
2840 | =item EV_USE_REALTIME |
2790 | |
2841 | |
2791 | If defined to be C<1>, libev will try to detect the availability of the |
2842 | If defined to be C<1>, libev will try to detect the availability of the |
2792 | realtime clock option at compiletime (and assume its availability at |
2843 | real-time clock option at compile time (and assume its availability at |
2793 | runtime if successful). Otherwise no use of the realtime clock option will |
2844 | runtime if successful). Otherwise no use of the real-time clock option will |
2794 | be attempted. This effectively replaces C<gettimeofday> by C<clock_get |
2845 | be attempted. This effectively replaces C<gettimeofday> by C<clock_get |
2795 | (CLOCK_REALTIME, ...)> and will not normally affect correctness. See the |
2846 | (CLOCK_REALTIME, ...)> and will not normally affect correctness. See the |
2796 | note about libraries in the description of C<EV_USE_MONOTONIC>, though. |
2847 | note about libraries in the description of C<EV_USE_MONOTONIC>, though. |
2797 | |
2848 | |
2798 | =item EV_USE_NANOSLEEP |
2849 | =item EV_USE_NANOSLEEP |
… | |
… | |
2809 | 2.7 or newer, otherwise disabled. |
2860 | 2.7 or newer, otherwise disabled. |
2810 | |
2861 | |
2811 | =item EV_USE_SELECT |
2862 | =item EV_USE_SELECT |
2812 | |
2863 | |
2813 | If undefined or defined to be C<1>, libev will compile in support for the |
2864 | If undefined or defined to be C<1>, libev will compile in support for the |
2814 | C<select>(2) backend. No attempt at autodetection will be done: if no |
2865 | C<select>(2) backend. No attempt at auto-detection will be done: if no |
2815 | other method takes over, select will be it. Otherwise the select backend |
2866 | other method takes over, select will be it. Otherwise the select backend |
2816 | will not be compiled in. |
2867 | will not be compiled in. |
2817 | |
2868 | |
2818 | =item EV_SELECT_USE_FD_SET |
2869 | =item EV_SELECT_USE_FD_SET |
2819 | |
2870 | |
2820 | If defined to C<1>, then the select backend will use the system C<fd_set> |
2871 | If defined to C<1>, then the select backend will use the system C<fd_set> |
2821 | structure. This is useful if libev doesn't compile due to a missing |
2872 | structure. This is useful if libev doesn't compile due to a missing |
2822 | C<NFDBITS> or C<fd_mask> definition or it misguesses the bitset layout on |
2873 | C<NFDBITS> or C<fd_mask> definition or it mis-guesses the bitset layout on |
2823 | exotic systems. This usually limits the range of file descriptors to some |
2874 | exotic systems. This usually limits the range of file descriptors to some |
2824 | low limit such as 1024 or might have other limitations (winsocket only |
2875 | low limit such as 1024 or might have other limitations (winsocket only |
2825 | allows 64 sockets). The C<FD_SETSIZE> macro, set before compilation, might |
2876 | allows 64 sockets). The C<FD_SETSIZE> macro, set before compilation, might |
2826 | influence the size of the C<fd_set> used. |
2877 | influence the size of the C<fd_set> used. |
2827 | |
2878 | |
… | |
… | |
2876 | otherwise another method will be used as fallback. This is the preferred |
2927 | otherwise another method will be used as fallback. This is the preferred |
2877 | backend for Solaris 10 systems. |
2928 | backend for Solaris 10 systems. |
2878 | |
2929 | |
2879 | =item EV_USE_DEVPOLL |
2930 | =item EV_USE_DEVPOLL |
2880 | |
2931 | |
2881 | reserved for future expansion, works like the USE symbols above. |
2932 | Reserved for future expansion, works like the USE symbols above. |
2882 | |
2933 | |
2883 | =item EV_USE_INOTIFY |
2934 | =item EV_USE_INOTIFY |
2884 | |
2935 | |
2885 | If defined to be C<1>, libev will compile in support for the Linux inotify |
2936 | If defined to be C<1>, libev will compile in support for the Linux inotify |
2886 | interface to speed up C<ev_stat> watchers. Its actual availability will |
2937 | interface to speed up C<ev_stat> watchers. Its actual availability will |
… | |
… | |
2893 | access is atomic with respect to other threads or signal contexts. No such |
2944 | access is atomic with respect to other threads or signal contexts. No such |
2894 | type is easily found in the C language, so you can provide your own type |
2945 | type is easily found in the C language, so you can provide your own type |
2895 | that you know is safe for your purposes. It is used both for signal handler "locking" |
2946 | that you know is safe for your purposes. It is used both for signal handler "locking" |
2896 | as well as for signal and thread safety in C<ev_async> watchers. |
2947 | as well as for signal and thread safety in C<ev_async> watchers. |
2897 | |
2948 | |
2898 | In the absense of this define, libev will use C<sig_atomic_t volatile> |
2949 | In the absence of this define, libev will use C<sig_atomic_t volatile> |
2899 | (from F<signal.h>), which is usually good enough on most platforms. |
2950 | (from F<signal.h>), which is usually good enough on most platforms. |
2900 | |
2951 | |
2901 | =item EV_H |
2952 | =item EV_H |
2902 | |
2953 | |
2903 | The name of the F<ev.h> header file used to include it. The default if |
2954 | The name of the F<ev.h> header file used to include it. The default if |
… | |
… | |
2942 | When doing priority-based operations, libev usually has to linearly search |
2993 | When doing priority-based operations, libev usually has to linearly search |
2943 | all the priorities, so having many of them (hundreds) uses a lot of space |
2994 | all the priorities, so having many of them (hundreds) uses a lot of space |
2944 | and time, so using the defaults of five priorities (-2 .. +2) is usually |
2995 | and time, so using the defaults of five priorities (-2 .. +2) is usually |
2945 | fine. |
2996 | fine. |
2946 | |
2997 | |
2947 | If your embedding app does not need any priorities, defining these both to |
2998 | If your embedding application does not need any priorities, defining these both to |
2948 | C<0> will save some memory and cpu. |
2999 | C<0> will save some memory and CPU. |
2949 | |
3000 | |
2950 | =item EV_PERIODIC_ENABLE |
3001 | =item EV_PERIODIC_ENABLE |
2951 | |
3002 | |
2952 | If undefined or defined to be C<1>, then periodic timers are supported. If |
3003 | If undefined or defined to be C<1>, then periodic timers are supported. If |
2953 | defined to be C<0>, then they are not. Disabling them saves a few kB of |
3004 | defined to be C<0>, then they are not. Disabling them saves a few kB of |
… | |
… | |
2981 | |
3032 | |
2982 | =item EV_MINIMAL |
3033 | =item EV_MINIMAL |
2983 | |
3034 | |
2984 | If you need to shave off some kilobytes of code at the expense of some |
3035 | If you need to shave off some kilobytes of code at the expense of some |
2985 | speed, define this symbol to C<1>. Currently this is used to override some |
3036 | speed, define this symbol to C<1>. Currently this is used to override some |
2986 | inlining decisions, saves roughly 30% codesize of amd64. It also selects a |
3037 | inlining decisions, saves roughly 30% code size on amd64. It also selects a |
2987 | much smaller 2-heap for timer management over the default 4-heap. |
3038 | much smaller 2-heap for timer management over the default 4-heap. |
2988 | |
3039 | |
2989 | =item EV_PID_HASHSIZE |
3040 | =item EV_PID_HASHSIZE |
2990 | |
3041 | |
2991 | C<ev_child> watchers use a small hash table to distribute workload by |
3042 | C<ev_child> watchers use a small hash table to distribute workload by |
… | |
… | |
3003 | |
3054 | |
3004 | =item EV_USE_4HEAP |
3055 | =item EV_USE_4HEAP |
3005 | |
3056 | |
3006 | Heaps are not very cache-efficient. To improve the cache-efficiency of the |
3057 | Heaps are not very cache-efficient. To improve the cache-efficiency of the |
3007 | timer and periodics heap, libev uses a 4-heap when this symbol is defined |
3058 | timer and periodics heap, libev uses a 4-heap when this symbol is defined |
3008 | to C<1>. The 4-heap uses more complicated (longer) code but has a |
3059 | to C<1>. The 4-heap uses more complicated (longer) code but has |
3009 | noticable after performance with many (thousands) of watchers. |
3060 | noticeably faster performance with many (thousands) of watchers. |
3010 | |
3061 | |
3011 | The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0> |
3062 | The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0> |
3012 | (disabled). |
3063 | (disabled). |
3013 | |
3064 | |
3014 | =item EV_HEAP_CACHE_AT |
3065 | =item EV_HEAP_CACHE_AT |
3015 | |
3066 | |
3016 | Heaps are not very cache-efficient. To improve the cache-efficiency of the |
3067 | Heaps are not very cache-efficient. To improve the cache-efficiency of the |
3017 | timer and periodics heap, libev can cache the timestamp (I<at>) within |
3068 | timer and periodics heap, libev can cache the timestamp (I<at>) within |
3018 | the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>), |
3069 | the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>), |
3019 | which uses 8-12 bytes more per watcher and a few hundred bytes more code, |
3070 | which uses 8-12 bytes more per watcher and a few hundred bytes more code, |
3020 | but avoids random read accesses on heap changes. This noticably improves |
3071 | but avoids random read accesses on heap changes. This improves performance |
3021 | performance noticably with with many (hundreds) of watchers. |
3072 | noticeably with with many (hundreds) of watchers. |
3022 | |
3073 | |
3023 | The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0> |
3074 | The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0> |
3024 | (disabled). |
3075 | (disabled). |
|
|
3076 | |
|
|
3077 | =item EV_VERIFY |
|
|
3078 | |
|
|
3079 | Controls how much internal verification (see C<ev_loop_verify ()>) will |
|
|
3080 | be done: If set to C<0>, no internal verification code will be compiled |
|
|
3081 | in. If set to C<1>, then verification code will be compiled in, but not |
|
|
3082 | called. If set to C<2>, then the internal verification code will be |
|
|
3083 | called once per loop, which can slow down libev. If set to C<3>, then the |
|
|
3084 | verification code will be called very frequently, which will slow down |
|
|
3085 | libev considerably. |
|
|
3086 | |
|
|
3087 | The default is C<1>, unless C<EV_MINIMAL> is set, in which case it will be |
|
|
3088 | C<0.> |
3025 | |
3089 | |
3026 | =item EV_COMMON |
3090 | =item EV_COMMON |
3027 | |
3091 | |
3028 | By default, all watchers have a C<void *data> member. By redefining |
3092 | By default, all watchers have a C<void *data> member. By redefining |
3029 | this macro to a something else you can include more and other types of |
3093 | this macro to a something else you can include more and other types of |
3030 | members. You have to define it each time you include one of the files, |
3094 | members. You have to define it each time you include one of the files, |
3031 | though, and it must be identical each time. |
3095 | though, and it must be identical each time. |
3032 | |
3096 | |
3033 | For example, the perl EV module uses something like this: |
3097 | For example, the perl EV module uses something like this: |
3034 | |
3098 | |
3035 | #define EV_COMMON \ |
3099 | #define EV_COMMON \ |
3036 | SV *self; /* contains this struct */ \ |
3100 | SV *self; /* contains this struct */ \ |
3037 | SV *cb_sv, *fh /* note no trailing ";" */ |
3101 | SV *cb_sv, *fh /* note no trailing ";" */ |
3038 | |
3102 | |
3039 | =item EV_CB_DECLARE (type) |
3103 | =item EV_CB_DECLARE (type) |
3040 | |
3104 | |
3041 | =item EV_CB_INVOKE (watcher, revents) |
3105 | =item EV_CB_INVOKE (watcher, revents) |
3042 | |
3106 | |
… | |
… | |
3049 | avoid the C<struct ev_loop *> as first argument in all cases, or to use |
3113 | avoid the C<struct ev_loop *> as first argument in all cases, or to use |
3050 | method calls instead of plain function calls in C++. |
3114 | method calls instead of plain function calls in C++. |
3051 | |
3115 | |
3052 | =head2 EXPORTED API SYMBOLS |
3116 | =head2 EXPORTED API SYMBOLS |
3053 | |
3117 | |
3054 | If you need to re-export the API (e.g. via a dll) and you need a list of |
3118 | If you need to re-export the API (e.g. via a DLL) and you need a list of |
3055 | exported symbols, you can use the provided F<Symbol.*> files which list |
3119 | exported symbols, you can use the provided F<Symbol.*> files which list |
3056 | all public symbols, one per line: |
3120 | all public symbols, one per line: |
3057 | |
3121 | |
3058 | Symbols.ev for libev proper |
3122 | Symbols.ev for libev proper |
3059 | Symbols.event for the libevent emulation |
3123 | Symbols.event for the libevent emulation |
3060 | |
3124 | |
3061 | This can also be used to rename all public symbols to avoid clashes with |
3125 | This can also be used to rename all public symbols to avoid clashes with |
3062 | multiple versions of libev linked together (which is obviously bad in |
3126 | multiple versions of libev linked together (which is obviously bad in |
3063 | itself, but sometimes it is inconvinient to avoid this). |
3127 | itself, but sometimes it is inconvenient to avoid this). |
3064 | |
3128 | |
3065 | A sed command like this will create wrapper C<#define>'s that you need to |
3129 | A sed command like this will create wrapper C<#define>'s that you need to |
3066 | include before including F<ev.h>: |
3130 | include before including F<ev.h>: |
3067 | |
3131 | |
3068 | <Symbols.ev sed -e "s/.*/#define & myprefix_&/" >wrap.h |
3132 | <Symbols.ev sed -e "s/.*/#define & myprefix_&/" >wrap.h |
… | |
… | |
3085 | file. |
3149 | file. |
3086 | |
3150 | |
3087 | The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file |
3151 | The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file |
3088 | that everybody includes and which overrides some configure choices: |
3152 | that everybody includes and which overrides some configure choices: |
3089 | |
3153 | |
3090 | #define EV_MINIMAL 1 |
3154 | #define EV_MINIMAL 1 |
3091 | #define EV_USE_POLL 0 |
3155 | #define EV_USE_POLL 0 |
3092 | #define EV_MULTIPLICITY 0 |
3156 | #define EV_MULTIPLICITY 0 |
3093 | #define EV_PERIODIC_ENABLE 0 |
3157 | #define EV_PERIODIC_ENABLE 0 |
3094 | #define EV_STAT_ENABLE 0 |
3158 | #define EV_STAT_ENABLE 0 |
3095 | #define EV_FORK_ENABLE 0 |
3159 | #define EV_FORK_ENABLE 0 |
3096 | #define EV_CONFIG_H <config.h> |
3160 | #define EV_CONFIG_H <config.h> |
3097 | #define EV_MINPRI 0 |
3161 | #define EV_MINPRI 0 |
3098 | #define EV_MAXPRI 0 |
3162 | #define EV_MAXPRI 0 |
3099 | |
3163 | |
3100 | #include "ev++.h" |
3164 | #include "ev++.h" |
3101 | |
3165 | |
3102 | And a F<ev_cpp.C> implementation file that contains libev proper and is compiled: |
3166 | And a F<ev_cpp.C> implementation file that contains libev proper and is compiled: |
3103 | |
3167 | |
3104 | #include "ev_cpp.h" |
3168 | #include "ev_cpp.h" |
3105 | #include "ev.c" |
3169 | #include "ev.c" |
3106 | |
3170 | |
3107 | |
3171 | |
3108 | =head1 THREADS AND COROUTINES |
3172 | =head1 THREADS AND COROUTINES |
3109 | |
3173 | |
3110 | =head2 THREADS |
3174 | =head2 THREADS |
3111 | |
3175 | |
3112 | Libev itself is completely threadsafe, but it uses no locking. This |
3176 | Libev itself is completely thread-safe, but it uses no locking. This |
3113 | means that you can use as many loops as you want in parallel, as long as |
3177 | means that you can use as many loops as you want in parallel, as long as |
3114 | only one thread ever calls into one libev function with the same loop |
3178 | only one thread ever calls into one libev function with the same loop |
3115 | parameter. |
3179 | parameter. |
3116 | |
3180 | |
3117 | Or put differently: calls with different loop parameters can be done in |
3181 | Or put differently: calls with different loop parameters can be done in |
… | |
… | |
3124 | help you but by giving some generic advice: |
3188 | help you but by giving some generic advice: |
3125 | |
3189 | |
3126 | =over 4 |
3190 | =over 4 |
3127 | |
3191 | |
3128 | =item * most applications have a main thread: use the default libev loop |
3192 | =item * most applications have a main thread: use the default libev loop |
3129 | in that thread, or create a seperate thread running only the default loop. |
3193 | in that thread, or create a separate thread running only the default loop. |
3130 | |
3194 | |
3131 | This helps integrating other libraries or software modules that use libev |
3195 | This helps integrating other libraries or software modules that use libev |
3132 | themselves and don't care/know about threading. |
3196 | themselves and don't care/know about threading. |
3133 | |
3197 | |
3134 | =item * one loop per thread is usually a good model. |
3198 | =item * one loop per thread is usually a good model. |
3135 | |
3199 | |
3136 | Doing this is almost never wrong, sometimes a better-performance model |
3200 | Doing this is almost never wrong, sometimes a better-performance model |
3137 | exists, but it is always a good start. |
3201 | exists, but it is always a good start. |
3138 | |
3202 | |
3139 | =item * other models exist, such as the leader/follower pattern, where one |
3203 | =item * other models exist, such as the leader/follower pattern, where one |
3140 | loop is handed through multiple threads in a kind of round-robbin fashion. |
3204 | loop is handed through multiple threads in a kind of round-robin fashion. |
3141 | |
3205 | |
3142 | Chosing a model is hard - look around, learn, know that usually you cna do |
3206 | Choosing a model is hard - look around, learn, know that usually you can do |
3143 | better than you currently do :-) |
3207 | better than you currently do :-) |
3144 | |
3208 | |
3145 | =item * often you need to talk to some other thread which blocks in the |
3209 | =item * often you need to talk to some other thread which blocks in the |
3146 | event loop - C<ev_async> watchers can be used to wake them up from other |
3210 | event loop - C<ev_async> watchers can be used to wake them up from other |
3147 | threads safely (or from signal contexts...). |
3211 | threads safely (or from signal contexts...). |
3148 | |
3212 | |
3149 | =back |
3213 | =back |
3150 | |
3214 | |
3151 | =head2 COROUTINES |
3215 | =head2 COROUTINES |
3152 | |
3216 | |
3153 | Libev is much more accomodating to coroutines ("cooperative threads"): |
3217 | Libev is much more accommodating to coroutines ("cooperative threads"): |
3154 | libev fully supports nesting calls to it's functions from different |
3218 | libev fully supports nesting calls to it's functions from different |
3155 | coroutines (e.g. you can call C<ev_loop> on the same loop from two |
3219 | coroutines (e.g. you can call C<ev_loop> on the same loop from two |
3156 | different coroutines and switch freely between both coroutines running the |
3220 | different coroutines and switch freely between both coroutines running the |
3157 | loop, as long as you don't confuse yourself). The only exception is that |
3221 | loop, as long as you don't confuse yourself). The only exception is that |
3158 | you must not do this from C<ev_periodic> reschedule callbacks. |
3222 | you must not do this from C<ev_periodic> reschedule callbacks. |
… | |
… | |
3206 | |
3270 | |
3207 | =item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd) |
3271 | =item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd) |
3208 | |
3272 | |
3209 | A change means an I/O watcher gets started or stopped, which requires |
3273 | A change means an I/O watcher gets started or stopped, which requires |
3210 | libev to recalculate its status (and possibly tell the kernel, depending |
3274 | libev to recalculate its status (and possibly tell the kernel, depending |
3211 | on backend and wether C<ev_io_set> was used). |
3275 | on backend and whether C<ev_io_set> was used). |
3212 | |
3276 | |
3213 | =item Activating one watcher (putting it into the pending state): O(1) |
3277 | =item Activating one watcher (putting it into the pending state): O(1) |
3214 | |
3278 | |
3215 | =item Priority handling: O(number_of_priorities) |
3279 | =item Priority handling: O(number_of_priorities) |
3216 | |
3280 | |
… | |
… | |
3223 | |
3287 | |
3224 | =item Processing ev_async_send: O(number_of_async_watchers) |
3288 | =item Processing ev_async_send: O(number_of_async_watchers) |
3225 | |
3289 | |
3226 | =item Processing signals: O(max_signal_number) |
3290 | =item Processing signals: O(max_signal_number) |
3227 | |
3291 | |
3228 | Sending involves a syscall I<iff> there were no other C<ev_async_send> |
3292 | Sending involves a system call I<iff> there were no other C<ev_async_send> |
3229 | calls in the current loop iteration. Checking for async and signal events |
3293 | calls in the current loop iteration. Checking for async and signal events |
3230 | involves iterating over all running async watchers or all signal numbers. |
3294 | involves iterating over all running async watchers or all signal numbers. |
3231 | |
3295 | |
3232 | =back |
3296 | =back |
3233 | |
3297 | |
3234 | |
3298 | |
3235 | =head1 Win32 platform limitations and workarounds |
3299 | =head1 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS |
3236 | |
3300 | |
3237 | Win32 doesn't support any of the standards (e.g. POSIX) that libev |
3301 | Win32 doesn't support any of the standards (e.g. POSIX) that libev |
3238 | requires, and its I/O model is fundamentally incompatible with the POSIX |
3302 | requires, and its I/O model is fundamentally incompatible with the POSIX |
3239 | model. Libev still offers limited functionality on this platform in |
3303 | model. Libev still offers limited functionality on this platform in |
3240 | the form of the C<EVBACKEND_SELECT> backend, and only supports socket |
3304 | the form of the C<EVBACKEND_SELECT> backend, and only supports socket |
… | |
… | |
3247 | way (note also that glib is the slowest event library known to man). |
3311 | way (note also that glib is the slowest event library known to man). |
3248 | |
3312 | |
3249 | There is no supported compilation method available on windows except |
3313 | There is no supported compilation method available on windows except |
3250 | embedding it into other applications. |
3314 | embedding it into other applications. |
3251 | |
3315 | |
|
|
3316 | Not a libev limitation but worth mentioning: windows apparently doesn't |
|
|
3317 | accept large writes: instead of resulting in a partial write, windows will |
|
|
3318 | either accept everything or return C<ENOBUFS> if the buffer is too large, |
|
|
3319 | so make sure you only write small amounts into your sockets (less than a |
|
|
3320 | megabyte seems safe, but thsi apparently depends on the amount of memory |
|
|
3321 | available). |
|
|
3322 | |
3252 | Due to the many, low, and arbitrary limits on the win32 platform and |
3323 | Due to the many, low, and arbitrary limits on the win32 platform and |
3253 | the abysmal performance of winsockets, using a large number of sockets |
3324 | the abysmal performance of winsockets, using a large number of sockets |
3254 | is not recommended (and not reasonable). If your program needs to use |
3325 | is not recommended (and not reasonable). If your program needs to use |
3255 | more than a hundred or so sockets, then likely it needs to use a totally |
3326 | more than a hundred or so sockets, then likely it needs to use a totally |
3256 | different implementation for windows, as libev offers the POSIX readyness |
3327 | different implementation for windows, as libev offers the POSIX readiness |
3257 | notification model, which cannot be implemented efficiently on windows |
3328 | notification model, which cannot be implemented efficiently on windows |
3258 | (microsoft monopoly games). |
3329 | (Microsoft monopoly games). |
|
|
3330 | |
|
|
3331 | A typical way to use libev under windows is to embed it (see the embedding |
|
|
3332 | section for details) and use the following F<evwrap.h> header file instead |
|
|
3333 | of F<ev.h>: |
|
|
3334 | |
|
|
3335 | #define EV_STANDALONE /* keeps ev from requiring config.h */ |
|
|
3336 | #define EV_SELECT_IS_WINSOCKET 1 /* configure libev for windows select */ |
|
|
3337 | #define EV_STAT_ENABLE 0 /* no stat() availble */ |
|
|
3338 | |
|
|
3339 | #include "ev.h" |
|
|
3340 | |
|
|
3341 | And compile the following F<evwrap.c> file into your project (make sure |
|
|
3342 | you do I<not> compile the F<ev.c> or any other embedded soruce files!): |
|
|
3343 | |
|
|
3344 | #include "evwrap.h" |
|
|
3345 | #include "ev.c" |
3259 | |
3346 | |
3260 | =over 4 |
3347 | =over 4 |
3261 | |
3348 | |
3262 | =item The winsocket select function |
3349 | =item The winsocket select function |
3263 | |
3350 | |
3264 | The winsocket C<select> function doesn't follow POSIX in that it requires |
3351 | The winsocket C<select> function doesn't follow POSIX in that it |
3265 | socket I<handles> and not socket I<file descriptors>. This makes select |
3352 | requires socket I<handles> and not socket I<file descriptors> (it is |
3266 | very inefficient, and also requires a mapping from file descriptors |
3353 | also extremely buggy). This makes select very inefficient, and also |
3267 | to socket handles. See the discussion of the C<EV_SELECT_USE_FD_SET>, |
3354 | requires a mapping from file descriptors to socket handles (the Microsoft |
3268 | C<EV_SELECT_IS_WINSOCKET> and C<EV_FD_TO_WIN32_HANDLE> preprocessor |
3355 | C runtime provides the function C<_open_osfhandle> for this). See the |
3269 | symbols for more info. |
3356 | discussion of the C<EV_SELECT_USE_FD_SET>, C<EV_SELECT_IS_WINSOCKET> and |
|
|
3357 | C<EV_FD_TO_WIN32_HANDLE> preprocessor symbols for more info. |
3270 | |
3358 | |
3271 | The configuration for a "naked" win32 using the microsoft runtime |
3359 | The configuration for a "naked" win32 using the Microsoft runtime |
3272 | libraries and raw winsocket select is: |
3360 | libraries and raw winsocket select is: |
3273 | |
3361 | |
3274 | #define EV_USE_SELECT 1 |
3362 | #define EV_USE_SELECT 1 |
3275 | #define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */ |
3363 | #define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */ |
3276 | |
3364 | |
3277 | Note that winsockets handling of fd sets is O(n), so you can easily get a |
3365 | Note that winsockets handling of fd sets is O(n), so you can easily get a |
3278 | complexity in the O(n²) range when using win32. |
3366 | complexity in the O(n²) range when using win32. |
3279 | |
3367 | |
3280 | =item Limited number of file descriptors |
3368 | =item Limited number of file descriptors |
3281 | |
3369 | |
3282 | Windows has numerous arbitrary (and low) limits on things. |
3370 | Windows has numerous arbitrary (and low) limits on things. |
3283 | |
3371 | |
3284 | Early versions of winsocket's select only supported waiting for a maximum |
3372 | Early versions of winsocket's select only supported waiting for a maximum |
3285 | of C<64> handles (probably owning to the fact that all windows kernels |
3373 | of C<64> handles (probably owning to the fact that all windows kernels |
3286 | can only wait for C<64> things at the same time internally; microsoft |
3374 | can only wait for C<64> things at the same time internally; Microsoft |
3287 | recommends spawning a chain of threads and wait for 63 handles and the |
3375 | recommends spawning a chain of threads and wait for 63 handles and the |
3288 | previous thread in each. Great). |
3376 | previous thread in each. Great). |
3289 | |
3377 | |
3290 | Newer versions support more handles, but you need to define C<FD_SETSIZE> |
3378 | Newer versions support more handles, but you need to define C<FD_SETSIZE> |
3291 | to some high number (e.g. C<2048>) before compiling the winsocket select |
3379 | to some high number (e.g. C<2048>) before compiling the winsocket select |
3292 | call (which might be in libev or elsewhere, for example, perl does its own |
3380 | call (which might be in libev or elsewhere, for example, perl does its own |
3293 | select emulation on windows). |
3381 | select emulation on windows). |
3294 | |
3382 | |
3295 | Another limit is the number of file descriptors in the microsoft runtime |
3383 | Another limit is the number of file descriptors in the Microsoft runtime |
3296 | libraries, which by default is C<64> (there must be a hidden I<64> fetish |
3384 | libraries, which by default is C<64> (there must be a hidden I<64> fetish |
3297 | or something like this inside microsoft). You can increase this by calling |
3385 | or something like this inside Microsoft). You can increase this by calling |
3298 | C<_setmaxstdio>, which can increase this limit to C<2048> (another |
3386 | C<_setmaxstdio>, which can increase this limit to C<2048> (another |
3299 | arbitrary limit), but is broken in many versions of the microsoft runtime |
3387 | arbitrary limit), but is broken in many versions of the Microsoft runtime |
3300 | libraries. |
3388 | libraries. |
3301 | |
3389 | |
3302 | This might get you to about C<512> or C<2048> sockets (depending on |
3390 | This might get you to about C<512> or C<2048> sockets (depending on |
3303 | windows version and/or the phase of the moon). To get more, you need to |
3391 | windows version and/or the phase of the moon). To get more, you need to |
3304 | wrap all I/O functions and provide your own fd management, but the cost of |
3392 | wrap all I/O functions and provide your own fd management, but the cost of |
… | |
… | |
3311 | |
3399 | |
3312 | In addition to a working ISO-C implementation, libev relies on a few |
3400 | In addition to a working ISO-C implementation, libev relies on a few |
3313 | additional extensions: |
3401 | additional extensions: |
3314 | |
3402 | |
3315 | =over 4 |
3403 | =over 4 |
|
|
3404 | |
|
|
3405 | =item C<void (*)(ev_watcher_type *, int revents)> must have compatible |
|
|
3406 | calling conventions regardless of C<ev_watcher_type *>. |
|
|
3407 | |
|
|
3408 | Libev assumes not only that all watcher pointers have the same internal |
|
|
3409 | structure (guaranteed by POSIX but not by ISO C for example), but it also |
|
|
3410 | assumes that the same (machine) code can be used to call any watcher |
|
|
3411 | callback: The watcher callbacks have different type signatures, but libev |
|
|
3412 | calls them using an C<ev_watcher *> internally. |
3316 | |
3413 | |
3317 | =item C<sig_atomic_t volatile> must be thread-atomic as well |
3414 | =item C<sig_atomic_t volatile> must be thread-atomic as well |
3318 | |
3415 | |
3319 | The type C<sig_atomic_t volatile> (or whatever is defined as |
3416 | The type C<sig_atomic_t volatile> (or whatever is defined as |
3320 | C<EV_ATOMIC_T>) must be atomic w.r.t. accesses from different |
3417 | C<EV_ATOMIC_T>) must be atomic w.r.t. accesses from different |
… | |
… | |
3352 | =back |
3449 | =back |
3353 | |
3450 | |
3354 | If you know of other additional requirements drop me a note. |
3451 | If you know of other additional requirements drop me a note. |
3355 | |
3452 | |
3356 | |
3453 | |
|
|
3454 | =head1 COMPILER WARNINGS |
|
|
3455 | |
|
|
3456 | Depending on your compiler and compiler settings, you might get no or a |
|
|
3457 | lot of warnings when compiling libev code. Some people are apparently |
|
|
3458 | scared by this. |
|
|
3459 | |
|
|
3460 | However, these are unavoidable for many reasons. For one, each compiler |
|
|
3461 | has different warnings, and each user has different tastes regarding |
|
|
3462 | warning options. "Warn-free" code therefore cannot be a goal except when |
|
|
3463 | targeting a specific compiler and compiler-version. |
|
|
3464 | |
|
|
3465 | Another reason is that some compiler warnings require elaborate |
|
|
3466 | workarounds, or other changes to the code that make it less clear and less |
|
|
3467 | maintainable. |
|
|
3468 | |
|
|
3469 | And of course, some compiler warnings are just plain stupid, or simply |
|
|
3470 | wrong (because they don't actually warn about the condition their message |
|
|
3471 | seems to warn about). |
|
|
3472 | |
|
|
3473 | While libev is written to generate as few warnings as possible, |
|
|
3474 | "warn-free" code is not a goal, and it is recommended not to build libev |
|
|
3475 | with any compiler warnings enabled unless you are prepared to cope with |
|
|
3476 | them (e.g. by ignoring them). Remember that warnings are just that: |
|
|
3477 | warnings, not errors, or proof of bugs. |
|
|
3478 | |
|
|
3479 | |
|
|
3480 | =head1 VALGRIND |
|
|
3481 | |
|
|
3482 | Valgrind has a special section here because it is a popular tool that is |
|
|
3483 | highly useful, but valgrind reports are very hard to interpret. |
|
|
3484 | |
|
|
3485 | If you think you found a bug (memory leak, uninitialised data access etc.) |
|
|
3486 | in libev, then check twice: If valgrind reports something like: |
|
|
3487 | |
|
|
3488 | ==2274== definitely lost: 0 bytes in 0 blocks. |
|
|
3489 | ==2274== possibly lost: 0 bytes in 0 blocks. |
|
|
3490 | ==2274== still reachable: 256 bytes in 1 blocks. |
|
|
3491 | |
|
|
3492 | Then there is no memory leak. Similarly, under some circumstances, |
|
|
3493 | valgrind might report kernel bugs as if it were a bug in libev, or it |
|
|
3494 | might be confused (it is a very good tool, but only a tool). |
|
|
3495 | |
|
|
3496 | If you are unsure about something, feel free to contact the mailing list |
|
|
3497 | with the full valgrind report and an explanation on why you think this is |
|
|
3498 | a bug in libev. However, don't be annoyed when you get a brisk "this is |
|
|
3499 | no bug" answer and take the chance of learning how to interpret valgrind |
|
|
3500 | properly. |
|
|
3501 | |
|
|
3502 | If you need, for some reason, empty reports from valgrind for your project |
|
|
3503 | I suggest using suppression lists. |
|
|
3504 | |
|
|
3505 | |
3357 | =head1 AUTHOR |
3506 | =head1 AUTHOR |
3358 | |
3507 | |
3359 | Marc Lehmann <libev@schmorp.de>. |
3508 | Marc Lehmann <libev@schmorp.de>. |
3360 | |
3509 | |