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

Comparing libev/README.embed (file contents):
Revision 1.12 by root, Fri Nov 9 17:07:59 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
73 other files, and it also defines dummy implementations for some 80 other files, and it also defines dummy implementations for some
74 libevent functions (such as logging, which is not supported). It 81 libevent functions (such as logging, which is not supported). It
75 will also not define any of the structs usually found in "event.h" 82 will also not define any of the structs usually found in "event.h"
76 that are not directly supported by libev code alone. 83 that are not directly supported by libev code alone.
77
78 EV_H
79
80 The name of the ev.h header file used to include it. The default
81 if undefined is <ev.h> in event.h and "ev.h" in ev.c. This can be used
82 to virtually rename the ev.h header file
83 84
84 EV_USE_MONOTONIC 85 EV_USE_MONOTONIC
85 86
86 If undefined or defined to be "1", libev will try to detect the 87 If undefined or defined to be "1", libev will try to detect the
87 availability of the monotonic clock option at both compiletime and 88 availability of the monotonic clock option at both compiletime and
… …
134 otherwise another method will be used as fallback. This is the 135 otherwise another method will be used as fallback. This is the
135 preferred backend for BSD and BSd-like systems. Darwin brokenness 136 preferred backend for BSD and BSd-like systems. Darwin brokenness
136 will be detected at runtime and routed around by disabling this 137 will be detected at runtime and routed around by disabling this
137 backend. 138 backend.
138 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
139 EV_COMMON 172 EV_COMMON
140 173
141 By default, all watchers have a "void *data" member. By redefining 174 By default, all watchers have a "void *data" member. By redefining
142 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
143 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
… …
147 180
148 #define EV_COMMON \ 181 #define EV_COMMON \
149 SV *self; /* contains this struct */ \ 182 SV *self; /* contains this struct */ \
150 SV *cb_sv, *fh /* note no trailing ";" */ 183 SV *cb_sv, *fh /* note no trailing ";" */
151 184
152 EV_PROTOTYPES 185 EV_CB_DECLARE(type)
186 EV_CB_INVOKE(watcher,revents)
187 ev_set_cb(ev,cb)
153 188
154 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
155 prototypes, but still define all the structs and other 190 watcher, and the way callbacks are invoked and set. Must expand
156 symbols. This is occasionally useful. 191 to a struct member definition and a statement, respectively. See
157 192 the ev.v header file for their default definitions. One possible
158 EV_MULTIPLICITY 193 use for overriding these is to avoid the ev_loop pointer as first
159 194 argument in all cases, or to use method calls instead of plain
160 If undefined or defined to "1", then all event-loop-specific 195 function calls in C++.
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 196
167EXAMPLES 197EXAMPLES
168 198
169 For a real-world example of a program the includes libev 199 For a real-world example of a program the includes libev
170 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