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) |
36 | |
45 | |
37 | "ev.c" includes the backend files directly when enabled. |
46 | "ev.c" includes the backend files directly when enabled. |
38 | |
47 | |
|
|
48 | LIBEVENT COMPATIBILITY API |
|
|
49 | |
39 | To include the libevent compatibility API, also include: |
50 | To include the libevent compatibility API, also include: |
40 | |
51 | |
41 | #include "event.c" |
52 | #include "event.c" |
42 | |
53 | |
43 | in the file including "ev.c", and: |
54 | in the file including "ev.c", and: |
… | |
… | |
49 | You need the following additional files for this: |
60 | You need the following additional files for this: |
50 | |
61 | |
51 | event.h |
62 | event.h |
52 | event.c |
63 | event.c |
53 | |
64 | |
|
|
65 | AUTOCONF SUPPORT |
|
|
66 | |
|
|
67 | Instead of using EV_STANDALONE=1 and providing your config in whatever |
|
|
68 | way you want, you can also m4_include([libev.m4]) in your configure.ac |
|
|
69 | and leave EV_STANDALONE off. ev.c will then include "config.h" and |
|
|
70 | configure itself accordingly. |
|
|
71 | |
54 | PREPROCESSOR SYMBOLS |
72 | PREPROCESSOR SYMBOLS |
55 | |
73 | |
56 | Libev can be configured via a variety of preprocessor symbols you have to define |
74 | 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 |
75 | before including any of its files. The default is not to build for multiplicity |
58 | and only include the select backend. |
76 | and only include the select backend. |
59 | |
77 | |
60 | EV_STANDALONE |
78 | EV_STANDALONE |
61 | |
79 | |
62 | Must always be "1", which keeps libev from including config.h or |
80 | Must always be "1", which keeps libev from including config.h or |
… | |
… | |
86 | If undefined or defined to be "1", libev will compile in support |
104 | If undefined or defined to be "1", libev will compile in support |
87 | for the select(2) backend. No attempt at autodetection will be |
105 | for the select(2) backend. No attempt at autodetection will be |
88 | done: if no other method takes over, select will be it. Otherwise |
106 | done: if no other method takes over, select will be it. Otherwise |
89 | the select backend will not be compiled in. |
107 | the select backend will not be compiled in. |
90 | |
108 | |
|
|
109 | EV_SELECT_USE_WIN32_HANDLES |
|
|
110 | |
|
|
111 | When defined to 1, the select backend will assume that select |
|
|
112 | doesn't understand file descriptors but wants osf handles on |
|
|
113 | win32 (this is the case when the select to be used is the winsock |
|
|
114 | select). This means that it will call _get_osfhandle on the fd to |
|
|
115 | convert it to an OS handle. Should not be defined on non-win32 |
|
|
116 | platforms. |
|
|
117 | |
91 | EV_USE_POLL |
118 | EV_USE_POLL |
92 | |
119 | |
93 | If defined to be "1", libev will compile in support for the poll(2) |
120 | 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 |
121 | backend. No attempt at autodetection will be done. poll usually |
95 | performs worse than select, so its not enabled by default (it is |
122 | performs worse than select, so its not enabled by default (it is |
… | |
… | |
109 | otherwise another method will be used as fallback. This is the |
136 | otherwise another method will be used as fallback. This is the |
110 | preferred backend for BSD and BSd-like systems. Darwin brokenness |
137 | preferred backend for BSD and BSd-like systems. Darwin brokenness |
111 | will be detected at runtime and routed around by disabling this |
138 | will be detected at runtime and routed around by disabling this |
112 | backend. |
139 | backend. |
113 | |
140 | |
|
|
141 | EV_H |
|
|
142 | |
|
|
143 | The name of the ev.h header file used to include it. The default |
|
|
144 | if undefined is <ev.h> in event.h and "ev.h" in ev.c. This can |
|
|
145 | be used to virtually rename the ev.h header file in case of |
|
|
146 | conflicts. |
|
|
147 | |
|
|
148 | EV_EVENT_H |
|
|
149 | |
|
|
150 | Similarly to EV_H, this macro cna be used to override event.c's idea |
|
|
151 | of how the event.h header can be found. |
|
|
152 | |
|
|
153 | EV_PROTOTYPES |
|
|
154 | |
|
|
155 | If defined to be "0", then "ev.h" will not define any function |
|
|
156 | prototypes, but still define all the structs and other |
|
|
157 | symbols. This is occasionally useful. |
|
|
158 | |
|
|
159 | EV_MULTIPLICITY |
|
|
160 | |
|
|
161 | If undefined or defined to "1", then all event-loop-specific |
|
|
162 | functions will have the "struct ev_loop *" as first argument, and |
|
|
163 | you can create additional independent event loops. Otherwise there |
|
|
164 | will be no support for multiple event loops and there is no first |
|
|
165 | event loop pointer argument. Instead, all functions act on the |
|
|
166 | single default loop. |
|
|
167 | |
|
|
168 | EV_PERIODICS |
|
|
169 | |
|
|
170 | If undefined or defined to be "1", then periodic timers are |
|
|
171 | supported, otherwise not. This saves a few kb of code. |
|
|
172 | |
114 | EV_COMMON |
173 | EV_COMMON |
115 | |
174 | |
116 | By default, all watchers have a "void *data" member. By redefining |
175 | 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 |
176 | this macro to a something else you can include more and other types |
118 | of members. You have to define it each time you include one of the |
177 | of members. You have to define it each time you include one of the |
… | |
… | |
120 | |
179 | |
121 | For example, the perl EV module uses this: |
180 | For example, the perl EV module uses this: |
122 | |
181 | |
123 | #define EV_COMMON \ |
182 | #define EV_COMMON \ |
124 | SV *self; /* contains this struct */ \ |
183 | SV *self; /* contains this struct */ \ |
125 | SV *cb_sv, *fh; |
184 | SV *cb_sv, *fh /* note no trailing ";" */ |
126 | |
185 | |
127 | EV_PROTOTYPES |
186 | EV_CB_DECLARE(type) |
|
|
187 | EV_CB_INVOKE(watcher,revents) |
|
|
188 | ev_set_cb(ev,cb) |
128 | |
189 | |
129 | If defined to be "0", then "ev.h" will not define any function |
190 | Can be used to change the callback member declaration in each |
130 | prototypes, but still define all the structs and other |
191 | watcher, and the way callbacks are invoked and set. Must expand |
131 | symbols. This is occasionally useful. |
192 | to a struct member definition and a statement, respectively. See |
132 | |
193 | the ev.v header file for their default definitions. One possible |
133 | EV_MULTIPLICITY |
194 | use for overriding these is to avoid the ev_loop pointer as first |
134 | |
195 | argument in all cases, or to use method calls instead of plain |
135 | If undefined or defined to "1", then all event-loop-specific |
196 | 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 | |
197 | |
142 | EXAMPLES |
198 | EXAMPLES |
143 | |
199 | |
144 | For a real-world example of a program the includes libev |
200 | For a real-world example of a program the includes libev |
145 | verbatim, you can have a look at the EV perl module |
201 | 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 |
202 | (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 |
203 | 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 |
204 | interface) and EV.xs (implementation) files. Only the EV.xs file will |
149 | compiled. |
205 | be compiled. |
150 | |
206 | |