ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libev/README.embed
(Generate patch)

Comparing libev/README.embed (file contents):
Revision 1.4 by root, Tue Nov 6 16:27:10 2007 UTC vs.
Revision 1.24 by root, Mon Nov 12 00:43:24 2007 UTC

1EMBEDDING THE LIBEV CODE INTO YOUR OWN PROGRAMS 1EMBEDDING 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
9FILESETS 9FILESETS
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
65AUTOCONF 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
54PREPROCESSOR SYMBOLS 72PREPROCESSOR 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_FD_SET
110
111 If defined to 1, then the select backend will use the system fd_set
112 structure. This is useful if libev doesn't compile due to a missing
113 NFDBITS or fd_mask definition or it misguesses the bitset layout on
114 exotic systems. This usually limits the range of file descriptors
115 to some low limit such as 1024 or might have other limitations
116 (winsocket only allows 64 sockets). The FD_SETSIZE macro, set
117 before compilation, might influence the size of the fd_set used.
118
119 EV_SELECT_IS_WINSOCKET
120
121 When defined to 1, the select backend will assume that select
122 doesn't understand file descriptors but wants osf handles on
123 win32 (this is the case when the select to be used is the winsock
124 select). This means that it will call _get_osfhandle on the fd to
125 convert it to an OS handle. Should not be defined on non-win32
126 platforms.
127
91 EV_USE_POLL 128 EV_USE_POLL
92 129
93 If defined to be "1", libev will compile in support for the poll(2) 130 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 131 backend. Otherwise it will be enabled on non-win32 platforms. It
95 performs worse than select, so its not enabled by default (it is 132 takes precedence over select.
96 also slightly less portable).
97 133
98 EV_USE_EPOLL 134 EV_USE_EPOLL
99 135
100 If defined to be "1", libev will compile in support for the Linux 136 If defined to be "1", libev will compile in support for the Linux
101 epoll backend. Its availability will be detected at runtime, 137 epoll backend. Its availability will be detected at runtime,
… …
105 EV_USE_KQUEUE 141 EV_USE_KQUEUE
106 142
107 If defined to be "1", libev will compile in support for the BSD 143 If defined to be "1", libev will compile in support for the BSD
108 style kqueue backend. Its availability will be detected at runtime, 144 style kqueue backend. Its availability will be detected at runtime,
109 otherwise another method will be used as fallback. This is the 145 otherwise another method will be used as fallback. This is the
110 preferred backend for BSD and BSd-like systems. Darwin brokenness 146 preferred backend for BSD and BSD-like systems. Darwin brokenness
111 will be detected at runtime and routed around by disabling this 147 will be detected at runtime and routed around by disabling this
112 backend. 148 backend.
149
150 EV_USE_DEVPOLL
151 EV_USE_PORTS
152
153 reserved for future expansion, works like the USE symbols above.
154
155 EV_H
156
157 The name of the ev.h header file used to include it. The default
158 if undefined is <ev.h> in event.h and "ev.h" in ev.c. This can
159 be used to virtually rename the ev.h header file in case of
160 conflicts.
161
162 EV_EVENT_H
163
164 Similarly to EV_H, this macro cna be used to override event.c's idea
165 of how the event.h header can be found.
166
167 EV_PROTOTYPES
168
169 If defined to be "0", then "ev.h" will not define any function
170 prototypes, but still define all the structs and other
171 symbols. This is occasionally useful.
172
173 EV_MULTIPLICITY
174
175 If undefined or defined to "1", then all event-loop-specific
176 functions will have the "struct ev_loop *" as first argument, and
177 you can create additional independent event loops. Otherwise there
178 will be no support for multiple event loops and there is no first
179 event loop pointer argument. Instead, all functions act on the
180 single default loop.
181
182 EV_PERIODICS
183
184 If undefined or defined to be "1", then periodic timers are
185 supported, otherwise not. This saves a few kb of code.
113 186
114 EV_COMMON 187 EV_COMMON
115 188
116 By default, all watchers have a "void *data" member. By redefining 189 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 190 this macro to a something else you can include more and other types
… …
120 193
121 For example, the perl EV module uses this: 194 For example, the perl EV module uses this:
122 195
123 #define EV_COMMON \ 196 #define EV_COMMON \
124 SV *self; /* contains this struct */ \ 197 SV *self; /* contains this struct */ \
125 SV *cb_sv, *fh; 198 SV *cb_sv, *fh /* note no trailing ";" */
126 199
127 EV_PROTOTYPES 200 EV_CB_DECLARE(type)
201 EV_CB_INVOKE(watcher,revents)
202 ev_set_cb(ev,cb)
128 203
129 If defined to be "0", then "ev.h" will not define any function 204 Can be used to change the callback member declaration in each
130 prototypes, but still define all the structs and other 205 watcher, and the way callbacks are invoked and set. Must expand
131 symbols. This is occasionally useful. 206 to a struct member definition and a statement, respectively. See
132 207 the ev.v header file for their default definitions. One possible
133 EV_MULTIPLICITY 208 use for overriding these is to avoid the ev_loop pointer as first
134 209 argument in all cases, or to use method calls instead of plain
135 If undefined or defined to "1", then all event-loop-specific 210 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 211
142EXAMPLES 212EXAMPLES
143 213
144 For a real-world example of a program the includes libev 214 For a real-world example of a program the includes libev
145 verbatim, you can have a look at the EV perl module 215 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 216 (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 217 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 218 interface) and EV.xs (implementation) files. Only the EV.xs file will
149 compiled. 219 be compiled.
150 220

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines