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

Comparing libev/README.embed (file contents):
Revision 1.19 by root, Sat Nov 10 15:15:49 2007 UTC vs.
Revision 1.24 by root, Mon Nov 12 00:43:24 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)
… …
103 If undefined or defined to be "1", libev will compile in support 104 If undefined or defined to be "1", libev will compile in support
104 for the select(2) backend. No attempt at autodetection will be 105 for the select(2) backend. No attempt at autodetection will be
105 done: if no other method takes over, select will be it. Otherwise 106 done: if no other method takes over, select will be it. Otherwise
106 the select backend will not be compiled in. 107 the select backend will not be compiled in.
107 108
108 EV_SELECT_USE_WIN32_HANDLES 109 EV_SELECT_USE_FD_SET
110
111 If defined to 1, then the select backend will use the system fd_set
112 structure. This is useful if libev doesn't compile due to a missing
113 NFDBITS or fd_mask definition or it misguesses the bitset layout on
114 exotic systems. This usually limits the range of file descriptors
115 to some low limit such as 1024 or might have other limitations
116 (winsocket only allows 64 sockets). The FD_SETSIZE macro, set
117 before compilation, might influence the size of the fd_set used.
118
119 EV_SELECT_IS_WINSOCKET
109 120
110 When defined to 1, the select backend will assume that select 121 When defined to 1, the select backend will assume that select
111 doesn't understand file descriptors but wants osf handles on 122 doesn't understand file descriptors but wants osf handles on
112 win32 (this is the case when the select to be used is the winsock 123 win32 (this is the case when the select to be used is the winsock
113 select). This means that it will call _get_osfhandle on the fd to 124 select). This means that it will call _get_osfhandle on the fd to
… …
115 platforms. 126 platforms.
116 127
117 EV_USE_POLL 128 EV_USE_POLL
118 129
119 If defined to be "1", libev will compile in support for the poll(2) 130 If defined to be "1", libev will compile in support for the poll(2)
120 backend. No attempt at autodetection will be done. poll usually 131 backend. Otherwise it will be enabled on non-win32 platforms. It
121 performs worse than select, so its not enabled by default (it is 132 takes precedence over select.
122 also slightly less portable).
123 133
124 EV_USE_EPOLL 134 EV_USE_EPOLL
125 135
126 If defined to be "1", libev will compile in support for the Linux 136 If defined to be "1", libev will compile in support for the Linux
127 epoll backend. Its availability will be detected at runtime, 137 epoll backend. Its availability will be detected at runtime,
… …
131 EV_USE_KQUEUE 141 EV_USE_KQUEUE
132 142
133 If defined to be "1", libev will compile in support for the BSD 143 If defined to be "1", libev will compile in support for the BSD
134 style kqueue backend. Its availability will be detected at runtime, 144 style kqueue backend. Its availability will be detected at runtime,
135 otherwise another method will be used as fallback. This is the 145 otherwise another method will be used as fallback. This is the
136 preferred backend for BSD and BSd-like systems. Darwin brokenness 146 preferred backend for BSD and BSD-like systems. Darwin brokenness
137 will be detected at runtime and routed around by disabling this 147 will be detected at runtime and routed around by disabling this
138 backend. 148 backend.
149
150 EV_USE_DEVPOLL
151 EV_USE_PORTS
152
153 reserved for future expansion, works like the USE symbols above.
139 154
140 EV_H 155 EV_H
141 156
142 The name of the ev.h header file used to include it. The default 157 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 158 if undefined is <ev.h> in event.h and "ev.h" in ev.c. This can
… …
146 161
147 EV_EVENT_H 162 EV_EVENT_H
148 163
149 Similarly to EV_H, this macro cna be used to override event.c's idea 164 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. 165 of how the event.h header can be found.
166
167 EV_PROTOTYPES
168
169 If defined to be "0", then "ev.h" will not define any function
170 prototypes, but still define all the structs and other
171 symbols. This is occasionally useful.
172
173 EV_MULTIPLICITY
174
175 If undefined or defined to "1", then all event-loop-specific
176 functions will have the "struct ev_loop *" as first argument, and
177 you can create additional independent event loops. Otherwise there
178 will be no support for multiple event loops and there is no first
179 event loop pointer argument. Instead, all functions act on the
180 single default loop.
181
182 EV_PERIODICS
183
184 If undefined or defined to be "1", then periodic timers are
185 supported, otherwise not. This saves a few kb of code.
151 186
152 EV_COMMON 187 EV_COMMON
153 188
154 By default, all watchers have a "void *data" member. By redefining 189 By default, all watchers have a "void *data" member. By redefining
155 this macro to a something else you can include more and other types 190 this macro to a something else you can include more and other types
… …
159 For example, the perl EV module uses this: 194 For example, the perl EV module uses this:
160 195
161 #define EV_COMMON \ 196 #define EV_COMMON \
162 SV *self; /* contains this struct */ \ 197 SV *self; /* contains this struct */ \
163 SV *cb_sv, *fh /* note no trailing ";" */ 198 SV *cb_sv, *fh /* note no trailing ";" */
164
165 EV_PROTOTYPES
166
167 If defined to be "0", then "ev.h" will not define any function
168 prototypes, but still define all the structs and other
169 symbols. This is occasionally useful.
170
171 EV_MULTIPLICITY
172
173 If undefined or defined to "1", then all event-loop-specific
174 functions will have the "struct ev_loop *" as first argument, and
175 you can create additional independent event loops. Otherwise there
176 will be no support for multiple event loops and there is no first
177 event loop pointer argument. Instead, all functions act on the
178 single default loop.
179 199
180 EV_CB_DECLARE(type) 200 EV_CB_DECLARE(type)
181 EV_CB_INVOKE(watcher,revents) 201 EV_CB_INVOKE(watcher,revents)
182 ev_set_cb(ev,cb) 202 ev_set_cb(ev,cb)
183 203

Diff Legend

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