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 | |
|
|
11 | CORE EVENT LOOP |
10 | |
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 |
|
|
38 | ev_win32.c |
|
|
39 | |
30 | 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) |
31 | 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) |
32 | 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) |
33 | 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) |
34 | |
44 | |
35 | "ev.c" includes the backend files directly when enabled. |
45 | "ev.c" includes the backend files directly when enabled. |
|
|
46 | |
|
|
47 | LIBEVENT COMPATIBILITY API |
36 | |
48 | |
37 | To include the libevent compatibility API, also include: |
49 | To include the libevent compatibility API, also include: |
38 | |
50 | |
39 | #include "event.c" |
51 | #include "event.c" |
40 | |
52 | |
… | |
… | |
84 | If undefined or defined to be "1", libev will compile in support |
96 | If undefined or defined to be "1", libev will compile in support |
85 | for the select(2) backend. No attempt at autodetection will be |
97 | for the select(2) backend. No attempt at autodetection will be |
86 | done: if no other method takes over, select will be it. Otherwise |
98 | done: if no other method takes over, select will be it. Otherwise |
87 | the select backend will not be compiled in. |
99 | the select backend will not be compiled in. |
88 | |
100 | |
|
|
101 | EV_SELECT_USE_WIN32_HANDLES |
|
|
102 | |
|
|
103 | When defined to 1, the select backend will assume that select |
|
|
104 | doesn't understand file descriptors but wants osf handles on |
|
|
105 | win32 (this is the case when the select to be used is the winsock |
|
|
106 | select). This means that it will call _get_osfhandle on the fd to |
|
|
107 | convert it to an OS handle. Should not be defined on non-win32 |
|
|
108 | platforms. |
|
|
109 | |
89 | EV_USE_POLL |
110 | EV_USE_POLL |
90 | |
111 | |
91 | If defined to be "1", libev will compile in support for the poll(2) |
112 | If defined to be "1", libev will compile in support for the poll(2) |
92 | backend. No attempt at autodetection will be done. poll usually |
113 | backend. No attempt at autodetection will be done. poll usually |
93 | performs worse than select, so its not enabled by default (it is |
114 | performs worse than select, so its not enabled by default (it is |
… | |
… | |
107 | otherwise another method will be used as fallback. This is the |
128 | otherwise another method will be used as fallback. This is the |
108 | preferred backend for BSD and BSd-like systems. Darwin brokenness |
129 | preferred backend for BSD and BSd-like systems. Darwin brokenness |
109 | will be detected at runtime and routed around by disabling this |
130 | will be detected at runtime and routed around by disabling this |
110 | backend. |
131 | backend. |
111 | |
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 | |
112 | EV_COMMON |
145 | EV_COMMON |
113 | |
146 | |
114 | By default, all watchers have a "void *data" member. By redefining |
147 | By default, all watchers have a "void *data" member. By redefining |
115 | 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 |
116 | 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 |
… | |
… | |
118 | |
151 | |
119 | For example, the perl EV module uses this: |
152 | For example, the perl EV module uses this: |
120 | |
153 | |
121 | #define EV_COMMON \ |
154 | #define EV_COMMON \ |
122 | SV *self; /* contains this struct */ \ |
155 | SV *self; /* contains this struct */ \ |
123 | SV *cb_sv, *fh; |
156 | SV *cb_sv, *fh /* note no trailing ";" */ |
124 | |
157 | |
125 | EV_PROTOTYPES |
158 | EV_PROTOTYPES |
126 | |
159 | |
127 | If defined to be "0", then "ev.h" will not define any function |
160 | If defined to be "0", then "ev.h" will not define any function |
128 | prototypes, but still define all the structs and other |
161 | prototypes, but still define all the structs and other |
… | |
… | |
135 | you can create additional independent event loops. Otherwise there |
168 | you can create additional independent event loops. Otherwise there |
136 | 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 |
137 | event loop pointer argument. Instead, all functions act on the |
170 | event loop pointer argument. Instead, all functions act on the |
138 | single default loop. |
171 | single default loop. |
139 | |
172 | |
|
|
173 | EV_CB_DECLARE(type) |
|
|
174 | EV_CB_INVOKE(watcher,revents) |
|
|
175 | ev_set_cb(ev,cb) |
|
|
176 | |
|
|
177 | Can be used to change the callback member declaration in each |
|
|
178 | watcher, and the way callbacks are invoked and set. Must expand |
|
|
179 | to a struct member definition and a statement, respectively. See |
|
|
180 | the ev.v header file for their default definitions. One possible |
|
|
181 | use for overriding these is to avoid the ev_loop pointer as first |
|
|
182 | argument in all cases, or to use method calls instead of plain |
|
|
183 | function calls in C++. |
|
|
184 | |
140 | EXAMPLES |
185 | EXAMPLES |
141 | |
186 | |
142 | For a real-world example of a program the includes libev |
187 | For a real-world example of a program the includes libev |
143 | verbatim, you can have a look at the EV perl module |
188 | verbatim, you can have a look at the EV perl module |
144 | (http://software.schmorp.de/pkg/EV.html). It has the libev files in |
189 | (http://software.schmorp.de/pkg/EV.html). It has the libev files in |
145 | the liev/ subdirectory and includes them in the EV/EVAPI.h (public |
190 | the libev/ subdirectory and includes them in the EV/EVAPI.h (public |
146 | interface) and EV.xs (implementation) files. Only EV.xs file will be |
191 | interface) and EV.xs (implementation) files. Only the EV.xs file will |
147 | compiled. |
192 | be compiled. |
148 | |
193 | |