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

Comparing libev/README.embed (file contents):
Revision 1.20 by root, Sun Nov 11 01:07:35 2007 UTC vs.
Revision 1.28 by root, Fri Nov 23 11:32:21 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)
45 ev_port.c only when the solaris port backend is enabled (disabled by default)
44 46
45 "ev.c" includes the backend files directly when enabled. 47 "ev.c" includes the backend files directly when enabled.
46 48
47 LIBEVENT COMPATIBILITY API 49 LIBEVENT COMPATIBILITY API
48 50
… …
82 will also not define any of the structs usually found in "event.h" 84 will also not define any of the structs usually found in "event.h"
83 that are not directly supported by libev code alone. 85 that are not directly supported by libev code alone.
84 86
85 EV_USE_MONOTONIC 87 EV_USE_MONOTONIC
86 88
87 If undefined or defined to be "1", libev will try to detect the 89 If defined to be "1", libev will try to detect the availability
88 availability of the monotonic clock option at both compiletime and 90 of the monotonic clock option at both compiletime and
89 runtime. Otherwise no use of the monotonic clock option will be 91 runtime. Otherwise no use of the monotonic clock option will be
90 attempted. 92 attempted. If you enable this, you usually have to link against
93 librt or something similar. Enabling it when the functionality
94 isn't available is safe, though.
91 95
92 EV_USE_REALTIME 96 EV_USE_REALTIME
93 97
94 If defined to be "1", libev will try to detect the availability 98 If defined to be "1", libev will try to detect the availability
95 of the realtime clock option at compiletime (and assume its 99 of the realtime clock option at compiletime (and assume its
… …
103 If undefined or defined to be "1", libev will compile in support 107 If undefined or defined to be "1", libev will compile in support
104 for the select(2) backend. No attempt at autodetection will be 108 for the select(2) backend. No attempt at autodetection will be
105 done: if no other method takes over, select will be it. Otherwise 109 done: if no other method takes over, select will be it. Otherwise
106 the select backend will not be compiled in. 110 the select backend will not be compiled in.
107 111
108 EV_SELECT_USE_WIN32_HANDLES 112 EV_SELECT_USE_FD_SET
109 113
114 If defined to 1, then the select backend will use the system fd_set
115 structure. This is useful if libev doesn't compile due to a missing
116 NFDBITS or fd_mask definition or it misguesses the bitset layout on
117 exotic systems. This usually limits the range of file descriptors
118 to some low limit such as 1024 or might have other limitations
119 (winsocket only allows 64 sockets). The FD_SETSIZE macro, set
120 before compilation, might influence the size of the fd_set used.
121
122 EV_SELECT_IS_WINSOCKET
123
110 When defined to 1, the select backend will assume that select 124 When defined to 1, the select backend will assume that
111 doesn't understand file descriptors but wants osf handles on 125 select/socket/connect etc. don't understand file descriptors but
112 win32 (this is the case when the select to be used is the winsock 126 wants osf handles on win32 (this is the case when the select to
113 select). This means that it will call _get_osfhandle on the fd to 127 be used is the winsock select). This means that it will call
114 convert it to an OS handle. Should not be defined on non-win32 128 _get_osfhandle on the fd to convert it to an OS handle. Otherwise,
115 platforms. 129 it is assumed that all these functions actually work on fds, even
130 on win32. Should not be defined on non-win32 platforms.
116 131
117 EV_USE_POLL 132 EV_USE_POLL
118 133
119 If defined to be "1", libev will compile in support for the poll(2) 134 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 135 backend. Otherwise it will be enabled on non-win32 platforms. It
121 performs worse than select, so its not enabled by default (it is 136 takes precedence over select.
122 also slightly less portable).
123 137
124 EV_USE_EPOLL 138 EV_USE_EPOLL
125 139
126 If defined to be "1", libev will compile in support for the Linux 140 If defined to be "1", libev will compile in support for the Linux
127 epoll backend. Its availability will be detected at runtime, 141 epoll backend. Its availability will be detected at runtime,
… …
131 EV_USE_KQUEUE 145 EV_USE_KQUEUE
132 146
133 If defined to be "1", libev will compile in support for the BSD 147 If defined to be "1", libev will compile in support for the BSD
134 style kqueue backend. Its availability will be detected at runtime, 148 style kqueue backend. Its availability will be detected at runtime,
135 otherwise another method will be used as fallback. This is the 149 otherwise another method will be used as fallback. This is the
136 preferred backend for BSD and BSd-like systems. Darwin brokenness 150 preferred backend for BSD and BSD-like systems. Darwin brokenness
137 will be detected at runtime and routed around by disabling this 151 will be detected at runtime and routed around by disabling this
138 backend. 152 backend.
153
154 EV_USE_PORT
155
156 If defined to be "1", libev will compile in support for the Solaris
157 10 port style backend. Its availability will be detected at runtime,
158 otherwise another method will be used as fallback. This is the
159 preferred backend for Solaris 10 systems.
160
161 EV_USE_DEVPOLL
162
163 reserved for future expansion, works like the USE symbols above.
139 164
140 EV_H 165 EV_H
141 166
142 The name of the ev.h header file used to include it. The default 167 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 168 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 169 be used to virtually rename the ev.h header file in case of
145 conflicts. 170 conflicts.
146 171
172 EV_CONFIG_H
173
174 If EV_STANDALONE isn't 1, this variable can be used to override
175 ev.c's idea of where to find the "config.h" file.
176
147 EV_EVENT_H 177 EV_EVENT_H
148 178
149 Similarly to EV_H, this macro cna be used to override event.c's idea 179 Similarly to EV_H, this macro can be used to override event.c's idea
150 of how the event.h header can be found. 180 of how the event.h header can be found.
151 181
152 EV_PROTOTYPES 182 EV_PROTOTYPES
153 183
154 If defined to be "0", then "ev.h" will not define any function 184 If defined to be "0", then "ev.h" will not define any function

Diff Legend

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