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

Comparing libev/README.embed (file contents):
Revision 1.14 by root, Fri Nov 9 19:14:51 2007 UTC vs.
Revision 1.25 by root, Fri Nov 16 01:33:53 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 how 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
… …
108 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
109 for the select(2) backend. No attempt at autodetection will be 105 for the select(2) backend. No attempt at autodetection will be
110 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
111 the select backend will not be compiled in. 107 the select backend will not be compiled in.
112 108
113 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
114 120
115 When defined to 1, the select backend will assume that select 121 When defined to 1, the select backend will assume that select
116 doesn't understand file descriptors but wants osf handles on 122 doesn't understand file descriptors but wants osf handles on
117 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
118 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
… …
120 platforms. 126 platforms.
121 127
122 EV_USE_POLL 128 EV_USE_POLL
123 129
124 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)
125 backend. No attempt at autodetection will be done. poll usually 131 backend. Otherwise it will be enabled on non-win32 platforms. It
126 performs worse than select, so its not enabled by default (it is 132 takes precedence over select.
127 also slightly less portable).
128 133
129 EV_USE_EPOLL 134 EV_USE_EPOLL
130 135
131 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
132 epoll backend. Its availability will be detected at runtime, 137 epoll backend. Its availability will be detected at runtime,
… …
136 EV_USE_KQUEUE 141 EV_USE_KQUEUE
137 142
138 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
139 style kqueue backend. Its availability will be detected at runtime, 144 style kqueue backend. Its availability will be detected at runtime,
140 otherwise another method will be used as fallback. This is the 145 otherwise another method will be used as fallback. This is the
141 preferred backend for BSD and BSd-like systems. Darwin brokenness 146 preferred backend for BSD and BSD-like systems. Darwin brokenness
142 will be detected at runtime and routed around by disabling this 147 will be detected at runtime and routed around by disabling this
143 backend. 148 backend.
149
150 EV_USE_PORT
151
152 If defined to be "1", libev will compile in support for the Solaris
153 10 port style backend. Its availability will be detected at runtime,
154 otherwise another method will be used as fallback. This is the
155 preferred backend for Solaris 10 systems.
156
157 EV_USE_DEVPOLL
158
159 reserved for future expansion, works like the USE symbols above.
160
161 EV_H
162
163 The name of the ev.h header file used to include it. The default
164 if undefined is <ev.h> in event.h and "ev.h" in ev.c. This can
165 be used to virtually rename the ev.h header file in case of
166 conflicts.
167
168 EV_EVENT_H
169
170 Similarly to EV_H, this macro cna be used to override event.c's idea
171 of how the event.h header can be found.
172
173 EV_PROTOTYPES
174
175 If defined to be "0", then "ev.h" will not define any function
176 prototypes, but still define all the structs and other
177 symbols. This is occasionally useful.
178
179 EV_MULTIPLICITY
180
181 If undefined or defined to "1", then all event-loop-specific
182 functions will have the "struct ev_loop *" as first argument, and
183 you can create additional independent event loops. Otherwise there
184 will be no support for multiple event loops and there is no first
185 event loop pointer argument. Instead, all functions act on the
186 single default loop.
187
188 EV_PERIODICS
189
190 If undefined or defined to be "1", then periodic timers are
191 supported, otherwise not. This saves a few kb of code.
144 192
145 EV_COMMON 193 EV_COMMON
146 194
147 By default, all watchers have a "void *data" member. By redefining 195 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 196 this macro to a something else you can include more and other types
… …
153 201
154 #define EV_COMMON \ 202 #define EV_COMMON \
155 SV *self; /* contains this struct */ \ 203 SV *self; /* contains this struct */ \
156 SV *cb_sv, *fh /* note no trailing ";" */ 204 SV *cb_sv, *fh /* note no trailing ";" */
157 205
158 EV_PROTOTYPES 206 EV_CB_DECLARE(type)
207 EV_CB_INVOKE(watcher,revents)
208 ev_set_cb(ev,cb)
159 209
160 If defined to be "0", then "ev.h" will not define any function 210 Can be used to change the callback member declaration in each
161 prototypes, but still define all the structs and other 211 watcher, and the way callbacks are invoked and set. Must expand
162 symbols. This is occasionally useful. 212 to a struct member definition and a statement, respectively. See
163 213 the ev.v header file for their default definitions. One possible
164 EV_MULTIPLICITY 214 use for overriding these is to avoid the ev_loop pointer as first
165 215 argument in all cases, or to use method calls instead of plain
166 If undefined or defined to "1", then all event-loop-specific 216 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 217
173EXAMPLES 218EXAMPLES
174 219
175 For a real-world example of a program the includes libev 220 For a real-world example of a program the includes libev
176 verbatim, you can have a look at the EV perl module 221 verbatim, you can have a look at the EV perl module

Diff Legend

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