… | |
… | |
22 | instead and where you can put other configuration options): |
22 | instead and where you can put other configuration options): |
23 | |
23 | |
24 | #define EV_STANDALONE 1 |
24 | #define EV_STANDALONE 1 |
25 | #include "ev.h" |
25 | #include "ev.h" |
26 | |
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). |
|
|
30 | |
27 | 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 |
28 | in your include path (e.g. in libev/ when using -Ilibev): |
32 | in your include path (e.g. in libev/ when using -Ilibev): |
29 | |
33 | |
30 | ev.h |
34 | ev.h |
31 | ev.c |
35 | ev.c |
… | |
… | |
55 | You need the following additional files for this: |
59 | You need the following additional files for this: |
56 | |
60 | |
57 | event.h |
61 | event.h |
58 | event.c |
62 | event.c |
59 | |
63 | |
|
|
64 | AUTOCONF SUPPORT |
|
|
65 | |
|
|
66 | Instead of using EV_STANDALONE=1 and providing your config in whatever |
|
|
67 | way you want, you can also m4_include([libev.m4]) in your configure.ac |
|
|
68 | and leave EV_STANDALONE off. ev.c will then include "config.h" and |
|
|
69 | configure itself accordingly. |
|
|
70 | |
60 | PREPROCESSOR SYMBOLS |
71 | PREPROCESSOR SYMBOLS |
61 | |
72 | |
62 | Libev can be configured via a variety of preprocessor symbols you have to define |
73 | Libev can be configured via a variety of preprocessor symbols you have to define |
63 | before including any of its files. The default is not to build for mulciplicity |
74 | before including any of its files. The default is not to build for multiplicity |
64 | and only include the select backend. |
75 | and only include the select backend. |
65 | |
76 | |
66 | EV_STANDALONE |
77 | EV_STANDALONE |
67 | |
78 | |
68 | Must always be "1", which keeps libev from including config.h or |
79 | Must always be "1", which keeps libev from including config.h or |
… | |
… | |
124 | otherwise another method will be used as fallback. This is the |
135 | otherwise another method will be used as fallback. This is the |
125 | preferred backend for BSD and BSd-like systems. Darwin brokenness |
136 | preferred backend for BSD and BSd-like systems. Darwin brokenness |
126 | will be detected at runtime and routed around by disabling this |
137 | will be detected at runtime and routed around by disabling this |
127 | backend. |
138 | backend. |
128 | |
139 | |
|
|
140 | EV_H |
|
|
141 | |
|
|
142 | The name of the ev.h header file used to include it. The default |
|
|
143 | if undefined is <ev.h> in event.h and "ev.h" in ev.c. This can |
|
|
144 | be used to virtually rename the ev.h header file in case of |
|
|
145 | conflicts. |
|
|
146 | |
|
|
147 | EV_EVENT_H |
|
|
148 | |
|
|
149 | Similarly to EV_H, this macro cna be used to override event.c's idea |
|
|
150 | of how the event.h header can be found. |
|
|
151 | |
|
|
152 | EV_PROTOTYPES |
|
|
153 | |
|
|
154 | If defined to be "0", then "ev.h" will not define any function |
|
|
155 | prototypes, but still define all the structs and other |
|
|
156 | symbols. This is occasionally useful. |
|
|
157 | |
|
|
158 | EV_MULTIPLICITY |
|
|
159 | |
|
|
160 | If undefined or defined to "1", then all event-loop-specific |
|
|
161 | functions will have the "struct ev_loop *" as first argument, and |
|
|
162 | you can create additional independent event loops. Otherwise there |
|
|
163 | will be no support for multiple event loops and there is no first |
|
|
164 | event loop pointer argument. Instead, all functions act on the |
|
|
165 | single default loop. |
|
|
166 | |
|
|
167 | EV_PERIODICS |
|
|
168 | |
|
|
169 | If undefined or defined to be "1", then periodic timers are |
|
|
170 | supported, otherwise not. This saves a few kb of code. |
|
|
171 | |
129 | EV_COMMON |
172 | EV_COMMON |
130 | |
173 | |
131 | By default, all watchers have a "void *data" member. By redefining |
174 | By default, all watchers have a "void *data" member. By redefining |
132 | this macro to a something else you can include more and other types |
175 | this macro to a something else you can include more and other types |
133 | of members. You have to define it each time you include one of the |
176 | of members. You have to define it each time you include one of the |
… | |
… | |
137 | |
180 | |
138 | #define EV_COMMON \ |
181 | #define EV_COMMON \ |
139 | SV *self; /* contains this struct */ \ |
182 | SV *self; /* contains this struct */ \ |
140 | SV *cb_sv, *fh /* note no trailing ";" */ |
183 | SV *cb_sv, *fh /* note no trailing ";" */ |
141 | |
184 | |
142 | EV_PROTOTYPES |
185 | EV_CB_DECLARE(type) |
|
|
186 | EV_CB_INVOKE(watcher,revents) |
|
|
187 | ev_set_cb(ev,cb) |
143 | |
188 | |
144 | If defined to be "0", then "ev.h" will not define any function |
189 | Can be used to change the callback member declaration in each |
145 | prototypes, but still define all the structs and other |
190 | watcher, and the way callbacks are invoked and set. Must expand |
146 | symbols. This is occasionally useful. |
191 | to a struct member definition and a statement, respectively. See |
147 | |
192 | the ev.v header file for their default definitions. One possible |
148 | EV_MULTIPLICITY |
193 | use for overriding these is to avoid the ev_loop pointer as first |
149 | |
194 | argument in all cases, or to use method calls instead of plain |
150 | If undefined or defined to "1", then all event-loop-specific |
195 | function calls in C++. |
151 | functions will have the "struct ev_loop *" as first argument, and |
|
|
152 | you can create additional independent event loops. Otherwise there |
|
|
153 | will be no support for multiple event loops and there is no first |
|
|
154 | event loop pointer argument. Instead, all functions act on the |
|
|
155 | single default loop. |
|
|
156 | |
196 | |
157 | EXAMPLES |
197 | EXAMPLES |
158 | |
198 | |
159 | For a real-world example of a program the includes libev |
199 | For a real-world example of a program the includes libev |
160 | verbatim, you can have a look at the EV perl module |
200 | verbatim, you can have a look at the EV perl module |