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

Comparing libev/README.embed (file contents):
Revision 1.2 by root, Sun Nov 4 18:16:52 2007 UTC vs.
Revision 1.28 by root, Fri Nov 23 11:32:21 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 38
39 ev_win32.c required on win32 platforms only
40
41 ev_select.c only when select backend is enabled (which is is by default)
42 ev_poll.c only when poll backend is enabled (disabled by default)
43 ev_epoll.c only when the epoll backend is enabled (disabled by default)
44 ev_kqueue.c only when the kqueue backend is enabled (disabled by default)
45 ev_port.c only when the solaris port backend is enabled (disabled by default)
46
47 "ev.c" includes the backend files directly when enabled.
48
49 LIBEVENT COMPATIBILITY API
50
31 To include the libevent compatibility API, also include: 51 To include the libevent compatibility API, also include:
32 52
33 #include "event.c" 53 #include "event.c"
34 54
35 in the file including "ev.c", and: 55 in the file including "ev.c", and:
… …
41 You need the following additional files for this: 61 You need the following additional files for this:
42 62
43 event.h 63 event.h
44 event.c 64 event.c
45 65
66AUTOCONF SUPPORT
67
68 Instead of using EV_STANDALONE=1 and providing your config in whatever
69 way you want, you can also m4_include([libev.m4]) in your configure.ac
70 and leave EV_STANDALONE off. ev.c will then include "config.h" and
71 configure itself accordingly.
72
46PREPROCESSOR SYMBOLS 73PREPROCESSOR SYMBOLS
47 74
48 Libev can be configured via a variety of preprocessor symbols you have to define 75 Libev can be configured via a variety of preprocessor symbols you have to define
49 before including any of its files. The default is not to build for mulciplicity 76 before including any of its files. The default is not to build for multiplicity
50 and only include the select backend. 77 and only include the select backend.
51 78
52 EV_STANDALONE 79 EV_STANDALONE
53 80
54 Must always be "1", which keeps libev from including config.h or 81 Must always be "1", which keeps libev from including config.h or
… …
57 will also not define any of the structs usually found in "event.h" 84 will also not define any of the structs usually found in "event.h"
58 that are not directly supported by libev code alone. 85 that are not directly supported by libev code alone.
59 86
60 EV_USE_MONOTONIC 87 EV_USE_MONOTONIC
61 88
62 If undefined or defined to be "1", libev will try to detect the 89 If defined to be "1", libev will try to detect the availability
63 availability of the monotonic clock option at both compiletime and 90 of the monotonic clock option at both compiletime and
64 runtime. Otherwise no use of the monotonic clock option will be 91 runtime. Otherwise no use of the monotonic clock option will be
65 attempted. 92 attempted. If you enable this, you usually have to link against
93 librt or something similar. Enabling it when the functionality
94 isn't available is safe, though.
66 95
67 EV_USE_REALTIME 96 EV_USE_REALTIME
68 97
69 If defined to be "1", libev will try to detect the availability 98 If defined to be "1", libev will try to detect the availability
70 of the realtime clock option at compiletime (and assume its 99 of the realtime clock option at compiletime (and assume its
… …
78 If undefined or defined to be "1", libev will compile in support 107 If undefined or defined to be "1", libev will compile in support
79 for the select(2) backend. No attempt at autodetection will be 108 for the select(2) backend. No attempt at autodetection will be
80 done: if no other method takes over, select will be it. Otherwise 109 done: if no other method takes over, select will be it. Otherwise
81 the select backend will not be compiled in. 110 the select backend will not be compiled in.
82 111
112 EV_SELECT_USE_FD_SET
113
114 If defined to 1, then the select backend will use the system fd_set
115 structure. This is useful if libev doesn't compile due to a missing
116 NFDBITS or fd_mask definition or it misguesses the bitset layout on
117 exotic systems. This usually limits the range of file descriptors
118 to some low limit such as 1024 or might have other limitations
119 (winsocket only allows 64 sockets). The FD_SETSIZE macro, set
120 before compilation, might influence the size of the fd_set used.
121
122 EV_SELECT_IS_WINSOCKET
123
124 When defined to 1, the select backend will assume that
125 select/socket/connect etc. don't understand file descriptors but
126 wants osf handles on win32 (this is the case when the select to
127 be used is the winsock select). This means that it will call
128 _get_osfhandle on the fd to convert it to an OS handle. Otherwise,
129 it is assumed that all these functions actually work on fds, even
130 on win32. Should not be defined on non-win32 platforms.
131
83 EV_USE_POLL 132 EV_USE_POLL
84 133
85 If defined to be "1", libev will compile in support for the poll(2) 134 If defined to be "1", libev will compile in support for the poll(2)
86 backend. No attempt at autodetection will be done. poll usually 135 backend. Otherwise it will be enabled on non-win32 platforms. It
87 performs worse than select, so its not enabled by default (it is 136 takes precedence over select.
88 also slightly less portable).
89 137
90 EV_USE_EPOLL 138 EV_USE_EPOLL
91 139
92 If defined to be "1", libev will compile in support for the Linux 140 If defined to be "1", libev will compile in support for the Linux
93 epoll backend. Its availability will be detected at runtime, 141 epoll backend. Its availability will be detected at runtime,
… …
97 EV_USE_KQUEUE 145 EV_USE_KQUEUE
98 146
99 If defined to be "1", libev will compile in support for the BSD 147 If defined to be "1", libev will compile in support for the BSD
100 style kqueue backend. Its availability will be detected at runtime, 148 style kqueue backend. Its availability will be detected at runtime,
101 otherwise another method will be used as fallback. This is the 149 otherwise another method will be used as fallback. This is the
102 preferred backend for BSD and BSd-like systems. Darwin brokenness 150 preferred backend for BSD and BSD-like systems. Darwin brokenness
103 will be detected at runtime and routed around by disabling this 151 will be detected at runtime and routed around by disabling this
104 backend. 152 backend.
153
154 EV_USE_PORT
155
156 If defined to be "1", libev will compile in support for the Solaris
157 10 port style backend. Its availability will be detected at runtime,
158 otherwise another method will be used as fallback. This is the
159 preferred backend for Solaris 10 systems.
160
161 EV_USE_DEVPOLL
162
163 reserved for future expansion, works like the USE symbols above.
164
165 EV_H
166
167 The name of the ev.h header file used to include it. The default
168 if undefined is <ev.h> in event.h and "ev.h" in ev.c. This can
169 be used to virtually rename the ev.h header file in case of
170 conflicts.
171
172 EV_CONFIG_H
173
174 If EV_STANDALONE isn't 1, this variable can be used to override
175 ev.c's idea of where to find the "config.h" file.
176
177 EV_EVENT_H
178
179 Similarly to EV_H, this macro can be used to override event.c's idea
180 of how the event.h header can be found.
181
182 EV_PROTOTYPES
183
184 If defined to be "0", then "ev.h" will not define any function
185 prototypes, but still define all the structs and other
186 symbols. This is occasionally useful.
187
188 EV_MULTIPLICITY
189
190 If undefined or defined to "1", then all event-loop-specific
191 functions will have the "struct ev_loop *" as first argument, and
192 you can create additional independent event loops. Otherwise there
193 will be no support for multiple event loops and there is no first
194 event loop pointer argument. Instead, all functions act on the
195 single default loop.
196
197 EV_PERIODICS
198
199 If undefined or defined to be "1", then periodic timers are
200 supported, otherwise not. This saves a few kb of code.
105 201
106 EV_COMMON 202 EV_COMMON
107 203
108 By default, all watchers have a "void *data" member. By redefining 204 By default, all watchers have a "void *data" member. By redefining
109 this macro to a something else you can include more and other types 205 this macro to a something else you can include more and other types
… …
112 208
113 For example, the perl EV module uses this: 209 For example, the perl EV module uses this:
114 210
115 #define EV_COMMON \ 211 #define EV_COMMON \
116 SV *self; /* contains this struct */ \ 212 SV *self; /* contains this struct */ \
117 SV *cb_sv, *fh; 213 SV *cb_sv, *fh /* note no trailing ";" */
118 214
119 EV_PROTOTYPES 215 EV_CB_DECLARE(type)
216 EV_CB_INVOKE(watcher,revents)
217 ev_set_cb(ev,cb)
120 218
121 If defined to be "0", then "ev.h" will not define any function 219 Can be used to change the callback member declaration in each
122 prototypes, but still define all the structs and other 220 watcher, and the way callbacks are invoked and set. Must expand
123 symbols. This is occasionally useful. 221 to a struct member definition and a statement, respectively. See
124 222 the ev.v header file for their default definitions. One possible
125 EV_MULTIPLICITY 223 use for overriding these is to avoid the ev_loop pointer as first
126 224 argument in all cases, or to use method calls instead of plain
127 If undefined or defined to "1", then all event-loop-specific 225 function calls in C++.
128 functions will have the "struct ev_loop *" as first argument, and
129 you can create additional independent event loops. Otherwise there
130 will be no support for multiple event loops and there is no first
131 event loop pointer argument. Instead, all functions act on the
132 single default loop.
133 226
134EXAMPLES 227EXAMPLES
135 228
136 For a real-world example of a program the includes libev 229 For a real-world example of a program the includes libev
137 verbatim, you can have a look at the EV perl module 230 verbatim, you can have a look at the EV perl module
138 (http://software.schmorp.de/pkg/EV.html). It has the libev files in 231 (http://software.schmorp.de/pkg/EV.html). It has the libev files in
139 the liev/ subdirectory and includes them in the EV/EVAPI.h (public 232 the libev/ subdirectory and includes them in the EV/EVAPI.h (public
140 interface) and EV.xs (implementation) files. Only EV.xs file will be 233 interface) and EV.xs (implementation) files. Only the EV.xs file will
141 compiled. 234 be compiled.
142 235

Diff Legend

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