1 | EMBEDDING THE LIBEV CODE INTO YOUR OWN PROGRAMS |
1 | EMBEDDING THE LIBEV CODE INTO YOUR OWN PROGRAMS |
2 | |
2 | |
3 | Instead of building the libev library you cna also include the code |
3 | Instead of building the libev library you can also include the code |
4 | as-is into your programs. To update, you only have to copy a few files |
4 | as-is into your programs. To update, you only have to copy a few files |
5 | into your source tree. |
5 | into your source tree. |
6 | |
6 | |
7 | This is how it works: |
7 | This is how it works: |
8 | |
8 | |
9 | FILESETS |
9 | FILESETS |
10 | |
10 | |
|
|
11 | CORE EVENT LOOP |
|
|
12 | |
11 | To include only the libev core (all the ev_* functions): |
13 | To include only the libev core (all the ev_* functions): |
12 | |
14 | |
13 | #define EV_STANDALONE 1 |
15 | #define EV_STANDALONE 1 |
14 | #include "ev.c" |
16 | #include "ev.c" |
15 | |
17 | |
16 | 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 |
17 | single C source file only to provide the function implementations. To |
19 | single C source file only to provide the function implementations. To |
18 | 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): |
19 | |
23 | |
20 | #define EV_STANDALONE 1 |
24 | #define EV_STANDALONE 1 |
21 | #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). |
22 | |
30 | |
23 | 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 |
24 | in your include path (e.g. in libev/ when using -Ilibev): |
32 | in your include path (e.g. in libev/ when using -Ilibev): |
25 | |
33 | |
26 | ev.h |
34 | ev.h |
27 | ev.c |
35 | ev.c |
28 | ev_vars.h |
36 | ev_vars.h |
29 | ev_wrap.h |
37 | ev_wrap.h |
30 | ev_win32.c |
|
|
31 | |
38 | |
|
|
39 | ev_win32.c required on win32 platforms only |
|
|
40 | |
32 | ev_select.c only when select backend is enabled (which is by default) |
41 | ev_select.c only when select backend is enabled (which is is by default) |
33 | ev_poll.c only when poll backend is enabled (disabled by default) |
42 | ev_poll.c only when poll backend is enabled (disabled by default) |
34 | ev_epoll.c only when the epoll backend is enabled (disabled by default) |
43 | ev_epoll.c only when the epoll backend is enabled (disabled by default) |
35 | ev_kqueue.c only when the kqueue backend is enabled (disabled by default) |
44 | ev_kqueue.c only when the kqueue backend is enabled (disabled by default) |
|
|
45 | ev_port.c only when the solaris port backend is enabled (disabled by default) |
36 | |
46 | |
37 | "ev.c" includes the backend files directly when enabled. |
47 | "ev.c" includes the backend files directly when enabled. |
|
|
48 | |
|
|
49 | LIBEVENT COMPATIBILITY API |
38 | |
50 | |
39 | To include the libevent compatibility API, also include: |
51 | To include the libevent compatibility API, also include: |
40 | |
52 | |
41 | #include "event.c" |
53 | #include "event.c" |
42 | |
54 | |
… | |
… | |
49 | You need the following additional files for this: |
61 | You need the following additional files for this: |
50 | |
62 | |
51 | event.h |
63 | event.h |
52 | event.c |
64 | event.c |
53 | |
65 | |
|
|
66 | AUTOCONF SUPPORT |
|
|
67 | |
|
|
68 | Instead of using EV_STANDALONE=1 and providing your config in whatever |
|
|
69 | way you want, you can also m4_include([libev.m4]) in your configure.ac |
|
|
70 | and leave EV_STANDALONE off. ev.c will then include "config.h" and |
|
|
71 | configure itself accordingly. |
|
|
72 | |
54 | PREPROCESSOR SYMBOLS |
73 | PREPROCESSOR SYMBOLS |
55 | |
74 | |
56 | Libev can be configured via a variety of preprocessor symbols you have to define |
75 | Libev can be configured via a variety of preprocessor symbols you have to define |
57 | before including any of its files. The default is not to build for mulciplicity |
76 | before including any of its files. The default is not to build for multiplicity |
58 | and only include the select backend. |
77 | and only include the select backend. |
59 | |
78 | |
60 | EV_STANDALONE |
79 | EV_STANDALONE |
61 | |
80 | |
62 | Must always be "1", which keeps libev from including config.h or |
81 | Must always be "1", which keeps libev from including config.h or |
… | |
… | |
65 | will also not define any of the structs usually found in "event.h" |
84 | will also not define any of the structs usually found in "event.h" |
66 | that are not directly supported by libev code alone. |
85 | that are not directly supported by libev code alone. |
67 | |
86 | |
68 | EV_USE_MONOTONIC |
87 | EV_USE_MONOTONIC |
69 | |
88 | |
70 | If undefined or defined to be "1", libev will try to detect the |
89 | If defined to be "1", libev will try to detect the availability |
71 | availability of the monotonic clock option at both compiletime and |
90 | of the monotonic clock option at both compiletime and |
72 | runtime. Otherwise no use of the monotonic clock option will be |
91 | runtime. Otherwise no use of the monotonic clock option will be |
73 | attempted. |
92 | attempted. If you enable this, you usually have to link against |
|
|
93 | librt or something similar. Enabling it when the functionality |
|
|
94 | isn't available is safe, though. |
74 | |
95 | |
75 | EV_USE_REALTIME |
96 | EV_USE_REALTIME |
76 | |
97 | |
77 | If defined to be "1", libev will try to detect the availability |
98 | If defined to be "1", libev will try to detect the availability |
78 | of the realtime clock option at compiletime (and assume its |
99 | of the realtime clock option at compiletime (and assume its |
… | |
… | |
86 | If undefined or defined to be "1", libev will compile in support |
107 | If undefined or defined to be "1", libev will compile in support |
87 | for the select(2) backend. No attempt at autodetection will be |
108 | for the select(2) backend. No attempt at autodetection will be |
88 | done: if no other method takes over, select will be it. Otherwise |
109 | done: if no other method takes over, select will be it. Otherwise |
89 | the select backend will not be compiled in. |
110 | the select backend will not be compiled in. |
90 | |
111 | |
|
|
112 | EV_SELECT_USE_FD_SET |
|
|
113 | |
|
|
114 | If defined to 1, then the select backend will use the system fd_set |
|
|
115 | structure. This is useful if libev doesn't compile due to a missing |
|
|
116 | NFDBITS or fd_mask definition or it misguesses the bitset layout on |
|
|
117 | exotic systems. This usually limits the range of file descriptors |
|
|
118 | to some low limit such as 1024 or might have other limitations |
|
|
119 | (winsocket only allows 64 sockets). The FD_SETSIZE macro, set |
|
|
120 | before compilation, might influence the size of the fd_set used. |
|
|
121 | |
|
|
122 | EV_SELECT_IS_WINSOCKET |
|
|
123 | |
|
|
124 | When defined to 1, the select backend will assume that select |
|
|
125 | doesn't understand file descriptors but wants osf handles on |
|
|
126 | win32 (this is the case when the select to be used is the winsock |
|
|
127 | select). This means that it will call _get_osfhandle on the fd to |
|
|
128 | convert it to an OS handle. Should not be defined on non-win32 |
|
|
129 | platforms. |
|
|
130 | |
91 | EV_USE_POLL |
131 | EV_USE_POLL |
92 | |
132 | |
93 | If defined to be "1", libev will compile in support for the poll(2) |
133 | If defined to be "1", libev will compile in support for the poll(2) |
94 | backend. No attempt at autodetection will be done. poll usually |
134 | backend. Otherwise it will be enabled on non-win32 platforms. It |
95 | performs worse than select, so its not enabled by default (it is |
135 | takes precedence over select. |
96 | also slightly less portable). |
|
|
97 | |
136 | |
98 | EV_USE_EPOLL |
137 | EV_USE_EPOLL |
99 | |
138 | |
100 | If defined to be "1", libev will compile in support for the Linux |
139 | If defined to be "1", libev will compile in support for the Linux |
101 | epoll backend. Its availability will be detected at runtime, |
140 | epoll backend. Its availability will be detected at runtime, |
… | |
… | |
105 | EV_USE_KQUEUE |
144 | EV_USE_KQUEUE |
106 | |
145 | |
107 | If defined to be "1", libev will compile in support for the BSD |
146 | If defined to be "1", libev will compile in support for the BSD |
108 | style kqueue backend. Its availability will be detected at runtime, |
147 | style kqueue backend. Its availability will be detected at runtime, |
109 | otherwise another method will be used as fallback. This is the |
148 | otherwise another method will be used as fallback. This is the |
110 | preferred backend for BSD and BSd-like systems. Darwin brokenness |
149 | preferred backend for BSD and BSD-like systems. Darwin brokenness |
111 | will be detected at runtime and routed around by disabling this |
150 | will be detected at runtime and routed around by disabling this |
112 | backend. |
151 | backend. |
|
|
152 | |
|
|
153 | EV_USE_PORT |
|
|
154 | |
|
|
155 | If defined to be "1", libev will compile in support for the Solaris |
|
|
156 | 10 port style backend. Its availability will be detected at runtime, |
|
|
157 | otherwise another method will be used as fallback. This is the |
|
|
158 | preferred backend for Solaris 10 systems. |
|
|
159 | |
|
|
160 | EV_USE_DEVPOLL |
|
|
161 | |
|
|
162 | reserved for future expansion, works like the USE symbols above. |
|
|
163 | |
|
|
164 | EV_H |
|
|
165 | |
|
|
166 | The name of the ev.h header file used to include it. The default |
|
|
167 | if undefined is <ev.h> in event.h and "ev.h" in ev.c. This can |
|
|
168 | be used to virtually rename the ev.h header file in case of |
|
|
169 | conflicts. |
|
|
170 | |
|
|
171 | EV_EVENT_H |
|
|
172 | |
|
|
173 | Similarly to EV_H, this macro cna be used to override event.c's idea |
|
|
174 | of how the event.h header can be found. |
|
|
175 | |
|
|
176 | EV_PROTOTYPES |
|
|
177 | |
|
|
178 | If defined to be "0", then "ev.h" will not define any function |
|
|
179 | prototypes, but still define all the structs and other |
|
|
180 | symbols. This is occasionally useful. |
|
|
181 | |
|
|
182 | EV_MULTIPLICITY |
|
|
183 | |
|
|
184 | If undefined or defined to "1", then all event-loop-specific |
|
|
185 | functions will have the "struct ev_loop *" as first argument, and |
|
|
186 | you can create additional independent event loops. Otherwise there |
|
|
187 | will be no support for multiple event loops and there is no first |
|
|
188 | event loop pointer argument. Instead, all functions act on the |
|
|
189 | single default loop. |
|
|
190 | |
|
|
191 | EV_PERIODICS |
|
|
192 | |
|
|
193 | If undefined or defined to be "1", then periodic timers are |
|
|
194 | supported, otherwise not. This saves a few kb of code. |
113 | |
195 | |
114 | EV_COMMON |
196 | EV_COMMON |
115 | |
197 | |
116 | By default, all watchers have a "void *data" member. By redefining |
198 | By default, all watchers have a "void *data" member. By redefining |
117 | this macro to a something else you can include more and other types |
199 | this macro to a something else you can include more and other types |
… | |
… | |
120 | |
202 | |
121 | For example, the perl EV module uses this: |
203 | For example, the perl EV module uses this: |
122 | |
204 | |
123 | #define EV_COMMON \ |
205 | #define EV_COMMON \ |
124 | SV *self; /* contains this struct */ \ |
206 | SV *self; /* contains this struct */ \ |
125 | SV *cb_sv, *fh; |
207 | SV *cb_sv, *fh /* note no trailing ";" */ |
126 | |
208 | |
127 | EV_PROTOTYPES |
209 | EV_CB_DECLARE(type) |
|
|
210 | EV_CB_INVOKE(watcher,revents) |
|
|
211 | ev_set_cb(ev,cb) |
128 | |
212 | |
129 | If defined to be "0", then "ev.h" will not define any function |
213 | Can be used to change the callback member declaration in each |
130 | prototypes, but still define all the structs and other |
214 | watcher, and the way callbacks are invoked and set. Must expand |
131 | symbols. This is occasionally useful. |
215 | to a struct member definition and a statement, respectively. See |
132 | |
216 | the ev.v header file for their default definitions. One possible |
133 | EV_MULTIPLICITY |
217 | use for overriding these is to avoid the ev_loop pointer as first |
134 | |
218 | argument in all cases, or to use method calls instead of plain |
135 | If undefined or defined to "1", then all event-loop-specific |
219 | function calls in C++. |
136 | functions will have the "struct ev_loop *" as first argument, and |
|
|
137 | you can create additional independent event loops. Otherwise there |
|
|
138 | will be no support for multiple event loops and there is no first |
|
|
139 | event loop pointer argument. Instead, all functions act on the |
|
|
140 | single default loop. |
|
|
141 | |
220 | |
142 | EXAMPLES |
221 | EXAMPLES |
143 | |
222 | |
144 | For a real-world example of a program the includes libev |
223 | For a real-world example of a program the includes libev |
145 | verbatim, you can have a look at the EV perl module |
224 | verbatim, you can have a look at the EV perl module |
146 | (http://software.schmorp.de/pkg/EV.html). It has the libev files in |
225 | (http://software.schmorp.de/pkg/EV.html). It has the libev files in |
147 | the liev/ subdirectory and includes them in the EV/EVAPI.h (public |
226 | the libev/ subdirectory and includes them in the EV/EVAPI.h (public |
148 | interface) and EV.xs (implementation) files. Only EV.xs file will be |
227 | interface) and EV.xs (implementation) files. Only the EV.xs file will |
149 | compiled. |
228 | be compiled. |
150 | |
229 | |