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

Comparing libev/README.embed (file contents):
Revision 1.9 by root, Thu Nov 8 18:38:51 2007 UTC vs.
Revision 1.18 by root, Sat Nov 10 15:02:07 2007 UTC

… …
22 instead and where you can put other configuration options): 22 instead and where you can put other configuration options):
23 23
24 #define EV_STANDALONE 1 24 #define EV_STANDALONE 1
25 #include "ev.h" 25 #include "ev.h"
26 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).
30
27 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
28 in your include path (e.g. in libev/ when using -Ilibev): 32 in your include path (e.g. in libev/ when using -Ilibev):
29 33
30 ev.h 34 ev.h
31 ev.c 35 ev.c
32 ev_vars.h 36 ev_vars.h
33 ev_wrap.h 37 ev_wrap.h
34 ev_win32.c 38 ev_win32.c
35 39
36 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)
37 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)
38 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)
39 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)
40 44
41 "ev.c" includes the backend files directly when enabled. 45 "ev.c" includes the backend files directly when enabled.
… …
55 You need the following additional files for this: 59 You need the following additional files for this:
56 60
57 event.h 61 event.h
58 event.c 62 event.c
59 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
60PREPROCESSOR SYMBOLS 71PREPROCESSOR SYMBOLS
61 72
62 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
63 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
64 and only include the select backend. 75 and only include the select backend.
65 76
66 EV_STANDALONE 77 EV_STANDALONE
67 78
68 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
… …
124 otherwise another method will be used as fallback. This is the 135 otherwise another method will be used as fallback. This is the
125 preferred backend for BSD and BSd-like systems. Darwin brokenness 136 preferred backend for BSD and BSd-like systems. Darwin brokenness
126 will be detected at runtime and routed around by disabling this 137 will be detected at runtime and routed around by disabling this
127 backend. 138 backend.
128 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
129 EV_COMMON 152 EV_COMMON
130 153
131 By default, all watchers have a "void *data" member. By redefining 154 By default, all watchers have a "void *data" member. By redefining
132 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
133 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
… …
152 you can create additional independent event loops. Otherwise there 175 you can create additional independent event loops. Otherwise there
153 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
154 event loop pointer argument. Instead, all functions act on the 177 event loop pointer argument. Instead, all functions act on the
155 single default loop. 178 single default loop.
156 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
157EXAMPLES 192EXAMPLES
158 193
159 For a real-world example of a program the includes libev 194 For a real-world example of a program the includes libev
160 verbatim, you can have a look at the EV perl module 195 verbatim, you can have a look at the EV perl module
161 (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