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.20 by root, Sun Nov 11 01:07:35 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 38 ev_win32.c
31 39
32 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)
33 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)
34 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)
35 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)
36 44
37 "ev.c" includes the backend files directly when enabled. 45 "ev.c" includes the backend files directly when enabled.
38 46
47 LIBEVENT COMPATIBILITY API
48
39 To include the libevent compatibility API, also include: 49 To include the libevent compatibility API, also include:
40 50
41 #include "event.c" 51 #include "event.c"
42 52
43 in the file including "ev.c", and: 53 in the file including "ev.c", and:
… …
49 You need the following additional files for this: 59 You need the following additional files for this:
50 60
51 event.h 61 event.h
52 event.c 62 event.c
53 63
64AUTOCONF SUPPORT
65
66 Instead of using EV_STANDALONE=1 and providing your config in whatever
67 way you want, you can also m4_include([libev.m4]) in your configure.ac
68 and leave EV_STANDALONE off. ev.c will then include "config.h" and
69 configure itself accordingly.
70
54PREPROCESSOR SYMBOLS 71PREPROCESSOR SYMBOLS
55 72
56 Libev can be configured via a variety of preprocessor symbols you have to define 73 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 74 before including any of its files. The default is not to build for multiplicity
58 and only include the select backend. 75 and only include the select backend.
59 76
60 EV_STANDALONE 77 EV_STANDALONE
61 78
62 Must always be "1", which keeps libev from including config.h or 79 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 103 If undefined or defined to be "1", libev will compile in support
87 for the select(2) backend. No attempt at autodetection will be 104 for the select(2) backend. No attempt at autodetection will be
88 done: if no other method takes over, select will be it. Otherwise 105 done: if no other method takes over, select will be it. Otherwise
89 the select backend will not be compiled in. 106 the select backend will not be compiled in.
90 107
108 EV_SELECT_USE_WIN32_HANDLES
109
110 When defined to 1, the select backend will assume that select
111 doesn't understand file descriptors but wants osf handles on
112 win32 (this is the case when the select to be used is the winsock
113 select). This means that it will call _get_osfhandle on the fd to
114 convert it to an OS handle. Should not be defined on non-win32
115 platforms.
116
91 EV_USE_POLL 117 EV_USE_POLL
92 118
93 If defined to be "1", libev will compile in support for the poll(2) 119 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 120 backend. No attempt at autodetection will be done. poll usually
95 performs worse than select, so its not enabled by default (it is 121 performs worse than select, so its not enabled by default (it is
… …
109 otherwise another method will be used as fallback. This is the 135 otherwise another method will be used as fallback. This is the
110 preferred backend for BSD and BSd-like systems. Darwin brokenness 136 preferred backend for BSD and BSd-like systems. Darwin brokenness
111 will be detected at runtime and routed around by disabling this 137 will be detected at runtime and routed around by disabling this
112 backend. 138 backend.
113 139
140 EV_H
141
142 The name of the ev.h header file used to include it. The default
143 if undefined is <ev.h> in event.h and "ev.h" in ev.c. This can
144 be used to virtually rename the ev.h header file in case of
145 conflicts.
146
147 EV_EVENT_H
148
149 Similarly to EV_H, this macro cna be used to override event.c's idea
150 of how the event.h header can be found.
151
152 EV_PROTOTYPES
153
154 If defined to be "0", then "ev.h" will not define any function
155 prototypes, but still define all the structs and other
156 symbols. This is occasionally useful.
157
158 EV_MULTIPLICITY
159
160 If undefined or defined to "1", then all event-loop-specific
161 functions will have the "struct ev_loop *" as first argument, and
162 you can create additional independent event loops. Otherwise there
163 will be no support for multiple event loops and there is no first
164 event loop pointer argument. Instead, all functions act on the
165 single default loop.
166
167 EV_PERIODICS
168
169 If undefined or defined to be "1", then periodic timers are
170 supported, otherwise not. This saves a few kb of code.
171
114 EV_COMMON 172 EV_COMMON
115 173
116 By default, all watchers have a "void *data" member. By redefining 174 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 175 this macro to a something else you can include more and other types
118 of members. You have to define it each time you include one of the 176 of members. You have to define it each time you include one of the
… …
120 178
121 For example, the perl EV module uses this: 179 For example, the perl EV module uses this:
122 180
123 #define EV_COMMON \ 181 #define EV_COMMON \
124 SV *self; /* contains this struct */ \ 182 SV *self; /* contains this struct */ \
125 SV *cb_sv, *fh; 183 SV *cb_sv, *fh /* note no trailing ";" */
126 184
127 EV_PROTOTYPES 185 EV_CB_DECLARE(type)
186 EV_CB_INVOKE(watcher,revents)
187 ev_set_cb(ev,cb)
128 188
129 If defined to be "0", then "ev.h" will not define any function 189 Can be used to change the callback member declaration in each
130 prototypes, but still define all the structs and other 190 watcher, and the way callbacks are invoked and set. Must expand
131 symbols. This is occasionally useful. 191 to a struct member definition and a statement, respectively. See
132 192 the ev.v header file for their default definitions. One possible
133 EV_MULTIPLICITY 193 use for overriding these is to avoid the ev_loop pointer as first
134 194 argument in all cases, or to use method calls instead of plain
135 If undefined or defined to "1", then all event-loop-specific 195 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 196
142EXAMPLES 197EXAMPLES
143 198
144 For a real-world example of a program the includes libev 199 For a real-world example of a program the includes libev
145 verbatim, you can have a look at the EV perl module 200 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 201 (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 202 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 203 interface) and EV.xs (implementation) files. Only the EV.xs file will
149 compiled. 204 be compiled.
150 205

Diff Legend

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