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

Comparing libev/README.embed (file contents):
Revision 1.8 by root, Thu Nov 8 17:56:30 2007 UTC vs.
Revision 1.20 by root, Sun Nov 11 01:07:35 2007 UTC

… …
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.
… …
53 You need the following additional files for this: 59 You need the following additional files for this:
54 60
55 event.h 61 event.h
56 event.c 62 event.c
57 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
58PREPROCESSOR SYMBOLS 71PREPROCESSOR SYMBOLS
59 72
60 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
61 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
62 and only include the select backend. 75 and only include the select backend.
63 76
64 EV_STANDALONE 77 EV_STANDALONE
65 78
66 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
… …
122 otherwise another method will be used as fallback. This is the 135 otherwise another method will be used as fallback. This is the
123 preferred backend for BSD and BSd-like systems. Darwin brokenness 136 preferred backend for BSD and BSd-like systems. Darwin brokenness
124 will be detected at runtime and routed around by disabling this 137 will be detected at runtime and routed around by disabling this
125 backend. 138 backend.
126 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
127 EV_COMMON 172 EV_COMMON
128 173
129 By default, all watchers have a "void *data" member. By redefining 174 By default, all watchers have a "void *data" member. By redefining
130 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
131 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
… …
135 180
136 #define EV_COMMON \ 181 #define EV_COMMON \
137 SV *self; /* contains this struct */ \ 182 SV *self; /* contains this struct */ \
138 SV *cb_sv, *fh /* note no trailing ";" */ 183 SV *cb_sv, *fh /* note no trailing ";" */
139 184
140 EV_PROTOTYPES 185 EV_CB_DECLARE(type)
186 EV_CB_INVOKE(watcher,revents)
187 ev_set_cb(ev,cb)
141 188
142 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
143 prototypes, but still define all the structs and other 190 watcher, and the way callbacks are invoked and set. Must expand
144 symbols. This is occasionally useful. 191 to a struct member definition and a statement, respectively. See
145 192 the ev.v header file for their default definitions. One possible
146 EV_MULTIPLICITY 193 use for overriding these is to avoid the ev_loop pointer as first
147 194 argument in all cases, or to use method calls instead of plain
148 If undefined or defined to "1", then all event-loop-specific 195 function calls in C++.
149 functions will have the "struct ev_loop *" as first argument, and
150 you can create additional independent event loops. Otherwise there
151 will be no support for multiple event loops and there is no first
152 event loop pointer argument. Instead, all functions act on the
153 single default loop.
154 196
155EXAMPLES 197EXAMPLES
156 198
157 For a real-world example of a program the includes libev 199 For a real-world example of a program the includes libev
158 verbatim, you can have a look at the EV perl module 200 verbatim, you can have a look at the EV perl module

Diff Legend

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