| … | |
… | |
| 15 | #define EV_STANDALONE 1 |
15 | #define EV_STANDALONE 1 |
| 16 | #include "ev.c" |
16 | #include "ev.c" |
| 17 | |
17 | |
| 18 | This will automatically include ev.h, too, and should be done in a |
18 | This will automatically include ev.h, too, and should be done in a |
| 19 | single C source file only to provide the function implementations. To |
19 | single C source file only to provide the function implementations. To |
| 20 | use it, do the same for ev.h in all users: |
20 | use it, do the same for ev.h in all files wishing to use this API |
|
|
21 | (best done by writing a wrapper around ev.h that you can include |
|
|
22 | instead and where you can put other configuration options): |
| 21 | |
23 | |
| 22 | #define EV_STANDALONE 1 |
24 | #define EV_STANDALONE 1 |
| 23 | #include "ev.h" |
25 | #include "ev.h" |
|
|
26 | |
|
|
27 | Both header files and implementation files can be compiled with a C++ |
|
|
28 | compiler (at least, thats a stated goal, and breakage will be treated |
|
|
29 | as a bug). |
| 24 | |
30 | |
| 25 | You need the following files in your source tree, or in a directory |
31 | You need the following files in your source tree, or in a directory |
| 26 | in your include path (e.g. in libev/ when using -Ilibev): |
32 | in your include path (e.g. in libev/ when using -Ilibev): |
| 27 | |
33 | |
| 28 | ev.h |
34 | ev.h |
| 29 | ev.c |
35 | ev.c |
| 30 | ev_vars.h |
36 | ev_vars.h |
| 31 | ev_wrap.h |
37 | ev_wrap.h |
| 32 | ev_win32.c |
38 | ev_win32.c |
| 33 | |
39 | |
| 34 | ev_select.c only when select backend is enabled (which is by default) |
40 | ev_select.c only when select backend is enabled (which is is by default) |
| 35 | ev_poll.c only when poll backend is enabled (disabled by default) |
41 | ev_poll.c only when poll backend is enabled (disabled by default) |
| 36 | ev_epoll.c only when the epoll backend is enabled (disabled by default) |
42 | ev_epoll.c only when the epoll backend is enabled (disabled by default) |
| 37 | ev_kqueue.c only when the kqueue backend is enabled (disabled by default) |
43 | ev_kqueue.c only when the kqueue backend is enabled (disabled by default) |
| 38 | |
44 | |
| 39 | "ev.c" includes the backend files directly when enabled. |
45 | "ev.c" includes the backend files directly when enabled. |
| … | |
… | |
| 122 | otherwise another method will be used as fallback. This is the |
128 | otherwise another method will be used as fallback. This is the |
| 123 | preferred backend for BSD and BSd-like systems. Darwin brokenness |
129 | preferred backend for BSD and BSd-like systems. Darwin brokenness |
| 124 | will be detected at runtime and routed around by disabling this |
130 | will be detected at runtime and routed around by disabling this |
| 125 | backend. |
131 | backend. |
| 126 | |
132 | |
|
|
133 | EV_H |
|
|
134 | |
|
|
135 | The name of the ev.h header file used to include it. The default |
|
|
136 | if undefined is <ev.h> in event.h and "ev.h" in ev.c. This can |
|
|
137 | be used to virtually rename the ev.h header file in case of |
|
|
138 | conflicts. |
|
|
139 | |
|
|
140 | EV_EVENT_H |
|
|
141 | |
|
|
142 | Similarly to EV_H, this macro cna be used to override event.c's idea |
|
|
143 | of how the event.h header can be found. |
|
|
144 | |
| 127 | EV_COMMON |
145 | EV_COMMON |
| 128 | |
146 | |
| 129 | By default, all watchers have a "void *data" member. By redefining |
147 | By default, all watchers have a "void *data" member. By redefining |
| 130 | this macro to a something else you can include more and other types |
148 | this macro to a something else you can include more and other types |
| 131 | of members. You have to define it each time you include one of the |
149 | of members. You have to define it each time you include one of the |
| … | |
… | |
| 150 | you can create additional independent event loops. Otherwise there |
168 | you can create additional independent event loops. Otherwise there |
| 151 | will be no support for multiple event loops and there is no first |
169 | will be no support for multiple event loops and there is no first |
| 152 | event loop pointer argument. Instead, all functions act on the |
170 | event loop pointer argument. Instead, all functions act on the |
| 153 | single default loop. |
171 | single default loop. |
| 154 | |
172 | |
|
|
173 | EV_CB_DECLARE(type) |
|
|
174 | EV_CB_INVOKE(watcher,revents) |
|
|
175 | |
|
|
176 | Can be used to change the callback member declaration in each |
|
|
177 | watcher, and the way callbacks are invoked. Must expand to a struct |
|
|
178 | member definition and a statement, respectively. See the ev.v |
|
|
179 | header file for their default definitions. |
|
|
180 | |
| 155 | EXAMPLES |
181 | EXAMPLES |
| 156 | |
182 | |
| 157 | For a real-world example of a program the includes libev |
183 | For a real-world example of a program the includes libev |
| 158 | verbatim, you can have a look at the EV perl module |
184 | verbatim, you can have a look at the EV perl module |
| 159 | (http://software.schmorp.de/pkg/EV.html). It has the libev files in |
185 | (http://software.schmorp.de/pkg/EV.html). It has the libev files in |
