1 |
EMBEDDING THE LIBEV CODE INTO YOUR OWN PROGRAMS |
2 |
|
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 |
5 |
into your source tree. |
6 |
|
7 |
This is how it works: |
8 |
|
9 |
FILESETS |
10 |
|
11 |
CORE EVENT LOOP |
12 |
|
13 |
To include only the libev core (all the ev_* functions): |
14 |
|
15 |
#define EV_STANDALONE 1 |
16 |
#include "ev.c" |
17 |
|
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 |
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): |
23 |
|
24 |
#define EV_STANDALONE 1 |
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). |
30 |
|
31 |
You need the following files in your source tree, or in a directory |
32 |
in your include path (e.g. in libev/ when using -Ilibev): |
33 |
|
34 |
ev.h |
35 |
ev.c |
36 |
ev_vars.h |
37 |
ev_wrap.h |
38 |
ev_win32.c |
39 |
|
40 |
ev_select.c only when select backend is enabled (which is is by default) |
41 |
ev_poll.c only when poll backend is enabled (disabled by default) |
42 |
ev_epoll.c only when the epoll backend is enabled (disabled by default) |
43 |
ev_kqueue.c only when the kqueue backend is enabled (disabled by default) |
44 |
|
45 |
"ev.c" includes the backend files directly when enabled. |
46 |
|
47 |
LIBEVENT COMPATIBILITY API |
48 |
|
49 |
To include the libevent compatibility API, also include: |
50 |
|
51 |
#include "event.c" |
52 |
|
53 |
in the file including "ev.c", and: |
54 |
|
55 |
#include "event.h" |
56 |
|
57 |
in the files that want to use the libevent API. This also includes "ev.h". |
58 |
|
59 |
You need the following additional files for this: |
60 |
|
61 |
event.h |
62 |
event.c |
63 |
|
64 |
PREPROCESSOR SYMBOLS |
65 |
|
66 |
Libev can be configured via a variety of preprocessor symbols you have to define |
67 |
before including any of its files. The default is not to build for mulciplicity |
68 |
and only include the select backend. |
69 |
|
70 |
EV_STANDALONE |
71 |
|
72 |
Must always be "1", which keeps libev from including config.h or |
73 |
other files, and it also defines dummy implementations for some |
74 |
libevent functions (such as logging, which is not supported). It |
75 |
will also not define any of the structs usually found in "event.h" |
76 |
that are not directly supported by libev code alone. |
77 |
|
78 |
EV_H |
79 |
|
80 |
The name of the ev.h header file used to include it. The default |
81 |
if undefined is <ev.h> in event.h and "ev.h" in ev.c. This can |
82 |
be used to virtually rename the ev.h header file in case of |
83 |
conflicts. |
84 |
|
85 |
EV_EVENT_H |
86 |
|
87 |
Similarly to EV_H, this macro cna be used to override event.c's idea |
88 |
of where the event.h header can be found. |
89 |
|
90 |
EV_USE_MONOTONIC |
91 |
|
92 |
If undefined or defined to be "1", libev will try to detect the |
93 |
availability of the monotonic clock option at both compiletime and |
94 |
runtime. Otherwise no use of the monotonic clock option will be |
95 |
attempted. |
96 |
|
97 |
EV_USE_REALTIME |
98 |
|
99 |
If defined to be "1", libev will try to detect the availability |
100 |
of the realtime clock option at compiletime (and assume its |
101 |
availability at runtime if successful). Otherwise no use of the |
102 |
realtime clock option will be attempted. This effectively replaces |
103 |
gettimeofday by clock_get (CLOCK_REALTIME, ...) and will not normally |
104 |
affect correctness. |
105 |
|
106 |
EV_USE_SELECT |
107 |
|
108 |
If undefined or defined to be "1", libev will compile in support |
109 |
for the select(2) backend. No attempt at autodetection will be |
110 |
done: if no other method takes over, select will be it. Otherwise |
111 |
the select backend will not be compiled in. |
112 |
|
113 |
EV_SELECT_USE_WIN32_HANDLES |
114 |
|
115 |
When defined to 1, the select backend will assume that select |
116 |
doesn't understand file descriptors but wants osf handles on |
117 |
win32 (this is the case when the select to be used is the winsock |
118 |
select). This means that it will call _get_osfhandle on the fd to |
119 |
convert it to an OS handle. Should not be defined on non-win32 |
120 |
platforms. |
121 |
|
122 |
EV_USE_POLL |
123 |
|
124 |
If defined to be "1", libev will compile in support for the poll(2) |
125 |
backend. No attempt at autodetection will be done. poll usually |
126 |
performs worse than select, so its not enabled by default (it is |
127 |
also slightly less portable). |
128 |
|
129 |
EV_USE_EPOLL |
130 |
|
131 |
If defined to be "1", libev will compile in support for the Linux |
132 |
epoll backend. Its availability will be detected at runtime, |
133 |
otherwise another method will be used as fallback. This is the |
134 |
preferred backend for GNU/Linux systems. |
135 |
|
136 |
EV_USE_KQUEUE |
137 |
|
138 |
If defined to be "1", libev will compile in support for the BSD |
139 |
style kqueue backend. Its availability will be detected at runtime, |
140 |
otherwise another method will be used as fallback. This is the |
141 |
preferred backend for BSD and BSd-like systems. Darwin brokenness |
142 |
will be detected at runtime and routed around by disabling this |
143 |
backend. |
144 |
|
145 |
EV_COMMON |
146 |
|
147 |
By default, all watchers have a "void *data" member. By redefining |
148 |
this macro to a something else you can include more and other types |
149 |
of members. You have to define it each time you include one of the |
150 |
files, though, and it must be identical each time. |
151 |
|
152 |
For example, the perl EV module uses this: |
153 |
|
154 |
#define EV_COMMON \ |
155 |
SV *self; /* contains this struct */ \ |
156 |
SV *cb_sv, *fh /* note no trailing ";" */ |
157 |
|
158 |
EV_PROTOTYPES |
159 |
|
160 |
If defined to be "0", then "ev.h" will not define any function |
161 |
prototypes, but still define all the structs and other |
162 |
symbols. This is occasionally useful. |
163 |
|
164 |
EV_MULTIPLICITY |
165 |
|
166 |
If undefined or defined to "1", then all event-loop-specific |
167 |
functions will have the "struct ev_loop *" as first argument, and |
168 |
you can create additional independent event loops. Otherwise there |
169 |
will be no support for multiple event loops and there is no first |
170 |
event loop pointer argument. Instead, all functions act on the |
171 |
single default loop. |
172 |
|
173 |
EXAMPLES |
174 |
|
175 |
For a real-world example of a program the includes libev |
176 |
verbatim, you can have a look at the EV perl module |
177 |
(http://software.schmorp.de/pkg/EV.html). It has the libev files in |
178 |
the libev/ subdirectory and includes them in the EV/EVAPI.h (public |
179 |
interface) and EV.xs (implementation) files. Only the EV.xs file will |
180 |
be compiled. |
181 |
|