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

Comparing libev/README.embed (file contents):
Revision 1.16 by root, Fri Nov 9 21:06:23 2007 UTC vs.
Revision 1.20 by root, Sun Nov 11 01:07:35 2007 UTC

… …
59 You need the following additional files for this: 59 You need the following additional files for this:
60 60
61 event.h 61 event.h
62 event.c 62 event.c
63 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
64PREPROCESSOR SYMBOLS 71PREPROCESSOR SYMBOLS
65 72
66 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
67 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
68 and only include the select backend. 75 and only include the select backend.
69 76
70 EV_STANDALONE 77 EV_STANDALONE
71 78
72 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
… …
140 EV_EVENT_H 147 EV_EVENT_H
141 148
142 Similarly to EV_H, this macro cna be used to override event.c's idea 149 Similarly to EV_H, this macro cna be used to override event.c's idea
143 of how the event.h header can be found. 150 of how the event.h header can be found.
144 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
145 EV_COMMON 172 EV_COMMON
146 173
147 By default, all watchers have a "void *data" member. By redefining 174 By default, all watchers have a "void *data" member. By redefining
148 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
149 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
… …
153 180
154 #define EV_COMMON \ 181 #define EV_COMMON \
155 SV *self; /* contains this struct */ \ 182 SV *self; /* contains this struct */ \
156 SV *cb_sv, *fh /* note no trailing ";" */ 183 SV *cb_sv, *fh /* note no trailing ";" */
157 184
158 EV_PROTOTYPES
159
160 If defined to be "0", then "ev.h" will not define any function
161 prototypes, but still define all the structs and other
162 symbols. This is occasionally useful.
163
164 EV_MULTIPLICITY
165
166 If undefined or defined to "1", then all event-loop-specific
167 functions will have the "struct ev_loop *" as first argument, and
168 you can create additional independent event loops. Otherwise there
169 will be no support for multiple event loops and there is no first
170 event loop pointer argument. Instead, all functions act on the
171 single default loop.
172
173 EV_CB_DECLARE(type) 185 EV_CB_DECLARE(type)
174 EV_CB_INVOKE(watcher,revents) 186 EV_CB_INVOKE(watcher,revents)
187 ev_set_cb(ev,cb)
175 188
176 Can be used to change the callback member declaration in each 189 Can be used to change the callback member declaration in each
177 watcher, and the way callbacks are invoked. Must expand to a struct 190 watcher, and the way callbacks are invoked and set. Must expand
178 member definition and a statement, respectively. See the ev.v 191 to a struct member definition and a statement, respectively. See
179 header file for their default definitions. One possible use for overriding 192 the ev.v header file for their default definitions. One possible
180 these is to avoid the ev_loop pointer as first argument in all cases, or 193 use for overriding these is to avoid the ev_loop pointer as first
181 to use method calls instead of plain function calls in C++. 194 argument in all cases, or to use method calls instead of plain
195 function calls in C++.
182 196
183EXAMPLES 197EXAMPLES
184 198
185 For a real-world example of a program the includes libev 199 For a real-world example of a program the includes libev
186 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