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.15 by root, Fri Nov 9 20:55:09 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.
124 otherwise another method will be used as fallback. This is the 128 otherwise another method will be used as fallback. This is the
125 preferred backend for BSD and BSd-like systems. Darwin brokenness 129 preferred backend for BSD and BSd-like systems. Darwin brokenness
126 will be detected at runtime and routed around by disabling this 130 will be detected at runtime and routed around by disabling this
127 backend. 131 backend.
128 132
133 EV_H
134
135 The name of the ev.h header file used to include it. The default
136 if undefined is <ev.h> in event.h and "ev.h" in ev.c. This can
137 be used to virtually rename the ev.h header file in case of
138 conflicts.
139
140 EV_EVENT_H
141
142 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.
144
129 EV_COMMON 145 EV_COMMON
130 146
131 By default, all watchers have a "void *data" member. By redefining 147 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 148 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 149 of members. You have to define it each time you include one of the
152 you can create additional independent event loops. Otherwise there 168 you can create additional independent event loops. Otherwise there
153 will be no support for multiple event loops and there is no first 169 will be no support for multiple event loops and there is no first
154 event loop pointer argument. Instead, all functions act on the 170 event loop pointer argument. Instead, all functions act on the
155 single default loop. 171 single default loop.
156 172
173 EV_CB_DECLARE(type)
174 EV_CB_INVOKE(watcher,revents)
175
176 Can be used to change the callback member declaration in each
177 watcher, and the way callbacks are invoked. Must expand to a struct
178 member definition and a statement, respectively. See the ev.v
179 header file for their default definitions.
180
157EXAMPLES 181EXAMPLES
158 182
159 For a real-world example of a program the includes libev 183 For a real-world example of a program the includes libev
160 verbatim, you can have a look at the EV perl module 184 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 185 (http://software.schmorp.de/pkg/EV.html). It has the libev files in

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines