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 | |
… | |
… | |
15 | #define EV_STANDALONE 1 |
15 | #define EV_STANDALONE 1 |
16 | #include "ev.c" |
16 | #include "ev.c" |
17 | |
17 | |
18 | 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 |
19 | single C source file only to provide the function implementations. To |
19 | single C source file only to provide the function implementations. To |
20 | 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): |
21 | |
23 | |
22 | #define EV_STANDALONE 1 |
24 | #define EV_STANDALONE 1 |
23 | #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). |
24 | |
30 | |
25 | 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 |
26 | in your include path (e.g. in libev/ when using -Ilibev): |
32 | in your include path (e.g. in libev/ when using -Ilibev): |
27 | |
33 | |
28 | ev.h |
34 | ev.h |
29 | ev.c |
35 | ev.c |
30 | ev_vars.h |
36 | ev_vars.h |
31 | ev_wrap.h |
37 | ev_wrap.h |
32 | ev_win32.c |
38 | ev_win32.c |
33 | |
39 | |
34 | 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) |
35 | 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) |
36 | 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) |
37 | 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) |
38 | |
44 | |
39 | "ev.c" includes the backend files directly when enabled. |
45 | "ev.c" includes the backend files directly when enabled. |
… | |
… | |
67 | other files, and it also defines dummy implementations for some |
73 | other files, and it also defines dummy implementations for some |
68 | libevent functions (such as logging, which is not supported). It |
74 | libevent functions (such as logging, which is not supported). It |
69 | will also not define any of the structs usually found in "event.h" |
75 | will also not define any of the structs usually found in "event.h" |
70 | that are not directly supported by libev code alone. |
76 | that are not directly supported by libev code alone. |
71 | |
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 how the event.h header can be found. |
|
|
89 | |
72 | EV_USE_MONOTONIC |
90 | EV_USE_MONOTONIC |
73 | |
91 | |
74 | If undefined or defined to be "1", libev will try to detect the |
92 | If undefined or defined to be "1", libev will try to detect the |
75 | availability of the monotonic clock option at both compiletime and |
93 | availability of the monotonic clock option at both compiletime and |
76 | runtime. Otherwise no use of the monotonic clock option will be |
94 | runtime. Otherwise no use of the monotonic clock option will be |
… | |
… | |
89 | |
107 | |
90 | If undefined or defined to be "1", libev will compile in support |
108 | If undefined or defined to be "1", libev will compile in support |
91 | for the select(2) backend. No attempt at autodetection will be |
109 | for the select(2) backend. No attempt at autodetection will be |
92 | done: if no other method takes over, select will be it. Otherwise |
110 | done: if no other method takes over, select will be it. Otherwise |
93 | the select backend will not be compiled in. |
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. |
94 | |
121 | |
95 | EV_USE_POLL |
122 | EV_USE_POLL |
96 | |
123 | |
97 | If defined to be "1", libev will compile in support for the poll(2) |
124 | If defined to be "1", libev will compile in support for the poll(2) |
98 | backend. No attempt at autodetection will be done. poll usually |
125 | backend. No attempt at autodetection will be done. poll usually |