… | |
… | |
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 |
|
|
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 |
109 | |
123 | |
110 | When defined to 1, the select backend will assume that select |
124 | When defined to 1, the select backend will assume that select |
111 | doesn't understand file descriptors but wants osf handles on |
125 | 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 |
126 | 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 |
127 | select). This means that it will call _get_osfhandle on the fd to |
… | |
… | |
115 | platforms. |
129 | platforms. |
116 | |
130 | |
117 | EV_USE_POLL |
131 | EV_USE_POLL |
118 | |
132 | |
119 | If defined to be "1", libev will compile in support for the poll(2) |
133 | 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 |
134 | backend. Otherwise it will be enabled on non-win32 platforms. It |
121 | performs worse than select, so its not enabled by default (it is |
135 | takes precedence over select. |
122 | also slightly less portable). |
|
|
123 | |
136 | |
124 | EV_USE_EPOLL |
137 | EV_USE_EPOLL |
125 | |
138 | |
126 | If defined to be "1", libev will compile in support for the Linux |
139 | If defined to be "1", libev will compile in support for the Linux |
127 | epoll backend. Its availability will be detected at runtime, |
140 | epoll backend. Its availability will be detected at runtime, |
… | |
… | |
131 | EV_USE_KQUEUE |
144 | EV_USE_KQUEUE |
132 | |
145 | |
133 | If defined to be "1", libev will compile in support for the BSD |
146 | If defined to be "1", libev will compile in support for the BSD |
134 | style kqueue backend. Its availability will be detected at runtime, |
147 | style kqueue backend. Its availability will be detected at runtime, |
135 | otherwise another method will be used as fallback. This is the |
148 | otherwise another method will be used as fallback. This is the |
136 | preferred backend for BSD and BSd-like systems. Darwin brokenness |
149 | preferred backend for BSD and BSD-like systems. Darwin brokenness |
137 | will be detected at runtime and routed around by disabling this |
150 | will be detected at runtime and routed around by disabling this |
138 | backend. |
151 | backend. |
|
|
152 | |
|
|
153 | EV_USE_PORT |
|
|
154 | |
|
|
155 | If defined to be "1", libev will compile in support for the Solaris |
|
|
156 | 10 port style backend. Its availability will be detected at runtime, |
|
|
157 | otherwise another method will be used as fallback. This is the |
|
|
158 | preferred backend for Solaris 10 systems. |
|
|
159 | |
|
|
160 | EV_USE_DEVPOLL |
|
|
161 | |
|
|
162 | reserved for future expansion, works like the USE symbols above. |
139 | |
163 | |
140 | EV_H |
164 | EV_H |
141 | |
165 | |
142 | The name of the ev.h header file used to include it. The default |
166 | 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 |
167 | if undefined is <ev.h> in event.h and "ev.h" in ev.c. This can |
… | |
… | |
146 | |
170 | |
147 | EV_EVENT_H |
171 | EV_EVENT_H |
148 | |
172 | |
149 | Similarly to EV_H, this macro cna be used to override event.c's idea |
173 | 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. |
174 | of how the event.h header can be found. |
|
|
175 | |
|
|
176 | EV_PROTOTYPES |
|
|
177 | |
|
|
178 | If defined to be "0", then "ev.h" will not define any function |
|
|
179 | prototypes, but still define all the structs and other |
|
|
180 | symbols. This is occasionally useful. |
|
|
181 | |
|
|
182 | EV_MULTIPLICITY |
|
|
183 | |
|
|
184 | If undefined or defined to "1", then all event-loop-specific |
|
|
185 | functions will have the "struct ev_loop *" as first argument, and |
|
|
186 | you can create additional independent event loops. Otherwise there |
|
|
187 | will be no support for multiple event loops and there is no first |
|
|
188 | event loop pointer argument. Instead, all functions act on the |
|
|
189 | single default loop. |
|
|
190 | |
|
|
191 | EV_PERIODICS |
|
|
192 | |
|
|
193 | If undefined or defined to be "1", then periodic timers are |
|
|
194 | supported, otherwise not. This saves a few kb of code. |
151 | |
195 | |
152 | EV_COMMON |
196 | EV_COMMON |
153 | |
197 | |
154 | By default, all watchers have a "void *data" member. By redefining |
198 | 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 |
199 | this macro to a something else you can include more and other types |
… | |
… | |
159 | For example, the perl EV module uses this: |
203 | For example, the perl EV module uses this: |
160 | |
204 | |
161 | #define EV_COMMON \ |
205 | #define EV_COMMON \ |
162 | SV *self; /* contains this struct */ \ |
206 | SV *self; /* contains this struct */ \ |
163 | SV *cb_sv, *fh /* note no trailing ";" */ |
207 | 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 | |
208 | |
180 | EV_CB_DECLARE(type) |
209 | EV_CB_DECLARE(type) |
181 | EV_CB_INVOKE(watcher,revents) |
210 | EV_CB_INVOKE(watcher,revents) |
182 | ev_set_cb(ev,cb) |
211 | ev_set_cb(ev,cb) |
183 | |
212 | |