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.23 by root, Sun Nov 11 17:59:25 2007 UTC

… …
33 33
34 ev.h 34 ev.h
35 ev.c 35 ev.c
36 ev_vars.h 36 ev_vars.h
37 ev_wrap.h 37 ev_wrap.h
38 ev_win32.c 38
39 ev_win32.c required on win32 platforms only
39 40
40 ev_select.c only when select backend is enabled (which is is by default) 41 ev_select.c only when select backend is enabled (which is is by default)
41 ev_poll.c only when poll backend is enabled (disabled by default) 42 ev_poll.c only when poll backend is enabled (disabled by default)
42 ev_epoll.c only when the epoll backend is enabled (disabled by default) 43 ev_epoll.c only when the epoll backend is enabled (disabled by default)
43 ev_kqueue.c only when the kqueue backend is enabled (disabled by default) 44 ev_kqueue.c only when the kqueue backend is enabled (disabled by default)
… …
59 You need the following additional files for this: 60 You need the following additional files for this:
60 61
61 event.h 62 event.h
62 event.c 63 event.c
63 64
65AUTOCONF SUPPORT
66
67 Instead of using EV_STANDALONE=1 and providing your config in whatever
68 way you want, you can also m4_include([libev.m4]) in your configure.ac
69 and leave EV_STANDALONE off. ev.c will then include "config.h" and
70 configure itself accordingly.
71
64PREPROCESSOR SYMBOLS 72PREPROCESSOR SYMBOLS
65 73
66 Libev can be configured via a variety of preprocessor symbols you have to define 74 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 75 before including any of its files. The default is not to build for multiplicity
68 and only include the select backend. 76 and only include the select backend.
69 77
70 EV_STANDALONE 78 EV_STANDALONE
71 79
72 Must always be "1", which keeps libev from including config.h or 80 Must always be "1", which keeps libev from including config.h or
73 other files, and it also defines dummy implementations for some 81 other files, and it also defines dummy implementations for some
74 libevent functions (such as logging, which is not supported). It 82 libevent functions (such as logging, which is not supported). It
75 will also not define any of the structs usually found in "event.h" 83 will also not define any of the structs usually found in "event.h"
76 that are not directly supported by libev code alone. 84 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 85
90 EV_USE_MONOTONIC 86 EV_USE_MONOTONIC
91 87
92 If undefined or defined to be "1", libev will try to detect the 88 If undefined or defined to be "1", libev will try to detect the
93 availability of the monotonic clock option at both compiletime and 89 availability of the monotonic clock option at both compiletime and
… …
136 EV_USE_KQUEUE 132 EV_USE_KQUEUE
137 133
138 If defined to be "1", libev will compile in support for the BSD 134 If defined to be "1", libev will compile in support for the BSD
139 style kqueue backend. Its availability will be detected at runtime, 135 style kqueue backend. Its availability will be detected at runtime,
140 otherwise another method will be used as fallback. This is the 136 otherwise another method will be used as fallback. This is the
141 preferred backend for BSD and BSd-like systems. Darwin brokenness 137 preferred backend for BSD and BSD-like systems. Darwin brokenness
142 will be detected at runtime and routed around by disabling this 138 will be detected at runtime and routed around by disabling this
143 backend. 139 backend.
140
141 EV_USE_DEVPOLL
142 EV_USE_PORTS
143
144 reserved for future expansion, works like the USE symbols above.
145
146 EV_H
147
148 The name of the ev.h header file used to include it. The default
149 if undefined is <ev.h> in event.h and "ev.h" in ev.c. This can
150 be used to virtually rename the ev.h header file in case of
151 conflicts.
152
153 EV_EVENT_H
154
155 Similarly to EV_H, this macro cna be used to override event.c's idea
156 of how the event.h header can be found.
157
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_PERIODICS
174
175 If undefined or defined to be "1", then periodic timers are
176 supported, otherwise not. This saves a few kb of code.
144 177
145 EV_COMMON 178 EV_COMMON
146 179
147 By default, all watchers have a "void *data" member. By redefining 180 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 181 this macro to a something else you can include more and other types
… …
153 186
154 #define EV_COMMON \ 187 #define EV_COMMON \
155 SV *self; /* contains this struct */ \ 188 SV *self; /* contains this struct */ \
156 SV *cb_sv, *fh /* note no trailing ";" */ 189 SV *cb_sv, *fh /* note no trailing ";" */
157 190
158 EV_PROTOTYPES 191 EV_CB_DECLARE(type)
192 EV_CB_INVOKE(watcher,revents)
193 ev_set_cb(ev,cb)
159 194
160 If defined to be "0", then "ev.h" will not define any function 195 Can be used to change the callback member declaration in each
161 prototypes, but still define all the structs and other 196 watcher, and the way callbacks are invoked and set. Must expand
162 symbols. This is occasionally useful. 197 to a struct member definition and a statement, respectively. See
163 198 the ev.v header file for their default definitions. One possible
164 EV_MULTIPLICITY 199 use for overriding these is to avoid the ev_loop pointer as first
165 200 argument in all cases, or to use method calls instead of plain
166 If undefined or defined to "1", then all event-loop-specific 201 function calls in C++.
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 202
173EXAMPLES 203EXAMPLES
174 204
175 For a real-world example of a program the includes libev 205 For a real-world example of a program the includes libev
176 verbatim, you can have a look at the EV perl module 206 verbatim, you can have a look at the EV perl module

Diff Legend

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