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

Comparing libev/README.embed (file contents):
Revision 1.13 by root, Fri Nov 9 19:14:37 2007 UTC vs.
Revision 1.18 by root, Sat Nov 10 15:02:07 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([ev.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
82 be used to virtually rename the ev.h header file in case of
83 conflicts.
84
85 EV_EVENT_H
86
87 Similarly to EV_H, this macro cna be used to override event.c's idea
88 of where the event.h header can be found.
89 84
90 EV_USE_MONOTONIC 85 EV_USE_MONOTONIC
91 86
92 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
93 availability of the monotonic clock option at both compiletime and 88 availability of the monotonic clock option at both compiletime and
… …
140 otherwise another method will be used as fallback. This is the 135 otherwise another method will be used as fallback. This is the
141 preferred backend for BSD and BSd-like systems. Darwin brokenness 136 preferred backend for BSD and BSd-like systems. Darwin brokenness
142 will be detected at runtime and routed around by disabling this 137 will be detected at runtime and routed around by disabling this
143 backend. 138 backend.
144 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
145 EV_COMMON 152 EV_COMMON
146 153
147 By default, all watchers have a "void *data" member. By redefining 154 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 155 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 156 of members. You have to define it each time you include one of the
… …
168 you can create additional independent event loops. Otherwise there 175 you can create additional independent event loops. Otherwise there
169 will be no support for multiple event loops and there is no first 176 will be no support for multiple event loops and there is no first
170 event loop pointer argument. Instead, all functions act on the 177 event loop pointer argument. Instead, all functions act on the
171 single default loop. 178 single default loop.
172 179
180 EV_CB_DECLARE(type)
181 EV_CB_INVOKE(watcher,revents)
182 ev_set_cb(ev,cb)
183
184 Can be used to change the callback member declaration in each
185 watcher, and the way callbacks are invoked and set. Must expand
186 to a struct member definition and a statement, respectively. See
187 the ev.v header file for their default definitions. One possible
188 use for overriding these is to avoid the ev_loop pointer as first
189 argument in all cases, or to use method calls instead of plain
190 function calls in C++.
191
173EXAMPLES 192EXAMPLES
174 193
175 For a real-world example of a program the includes libev 194 For a real-world example of a program the includes libev
176 verbatim, you can have a look at the EV perl module 195 verbatim, you can have a look at the EV perl module
177 (http://software.schmorp.de/pkg/EV.html). It has the libev files in 196 (http://software.schmorp.de/pkg/EV.html). It has the libev files in

Diff Legend

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