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

Comparing libev/README.embed (file contents):
Revision 1.5 by root, Tue Nov 6 19:45:29 2007 UTC vs.
Revision 1.25 by root, Fri Nov 16 01:33:53 2007 UTC

1EMBEDDING THE LIBEV CODE INTO YOUR OWN PROGRAMS 1EMBEDDING THE LIBEV CODE INTO YOUR OWN PROGRAMS
2 2
3 Instead of building the libev library you cna also include the code 3 Instead of building the libev library you can also include the code
4 as-is into your programs. To update, you only have to copy a few files 4 as-is into your programs. To update, you only have to copy a few files
5 into your source tree. 5 into your source tree.
6 6
7 This is how it works: 7 This is how it works:
8 8
… …
15 #define EV_STANDALONE 1 15 #define EV_STANDALONE 1
16 #include "ev.c" 16 #include "ev.c"
17 17
18 This will automatically include ev.h, too, and should be done in a 18 This will automatically include ev.h, too, and should be done in a
19 single C source file only to provide the function implementations. To 19 single C source file only to provide the function implementations. To
20 use it, do the same for ev.h in all users: 20 use it, do the same for ev.h in all files wishing to use this API
21 (best done by writing a wrapper around ev.h that you can include
22 instead and where you can put other configuration options):
21 23
22 #define EV_STANDALONE 1 24 #define EV_STANDALONE 1
23 #include "ev.h" 25 #include "ev.h"
26
27 Both header files and implementation files can be compiled with a C++
28 compiler (at least, thats a stated goal, and breakage will be treated
29 as a bug).
24 30
25 You need the following files in your source tree, or in a directory 31 You need the following files in your source tree, or in a directory
26 in your include path (e.g. in libev/ when using -Ilibev): 32 in your include path (e.g. in libev/ when using -Ilibev):
27 33
28 ev.h 34 ev.h
29 ev.c 35 ev.c
30 ev_vars.h 36 ev_vars.h
31 ev_wrap.h 37 ev_wrap.h
32 ev_win32.c
33 38
39 ev_win32.c required on win32 platforms only
40
34 ev_select.c only when select backend is enabled (which is by default) 41 ev_select.c only when select backend is enabled (which is is by default)
35 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)
36 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)
37 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)
38 45
39 "ev.c" includes the backend files directly when enabled. 46 "ev.c" includes the backend files directly when enabled.
… …
53 You need the following additional files for this: 60 You need the following additional files for this:
54 61
55 event.h 62 event.h
56 event.c 63 event.c
57 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
58PREPROCESSOR SYMBOLS 72PREPROCESSOR SYMBOLS
59 73
60 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
61 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
62 and only include the select backend. 76 and only include the select backend.
63 77
64 EV_STANDALONE 78 EV_STANDALONE
65 79
66 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
… …
90 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
91 for the select(2) backend. No attempt at autodetection will be 105 for the select(2) backend. No attempt at autodetection will be
92 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
93 the select backend will not be compiled in. 107 the select backend will not be compiled in.
94 108
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
120
121 When defined to 1, the select backend will assume that select
122 doesn't understand file descriptors but wants osf handles on
123 win32 (this is the case when the select to be used is the winsock
124 select). This means that it will call _get_osfhandle on the fd to
125 convert it to an OS handle. Should not be defined on non-win32
126 platforms.
127
95 EV_USE_POLL 128 EV_USE_POLL
96 129
97 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)
98 backend. No attempt at autodetection will be done. poll usually 131 backend. Otherwise it will be enabled on non-win32 platforms. It
99 performs worse than select, so its not enabled by default (it is 132 takes precedence over select.
100 also slightly less portable).
101 133
102 EV_USE_EPOLL 134 EV_USE_EPOLL
103 135
104 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
105 epoll backend. Its availability will be detected at runtime, 137 epoll backend. Its availability will be detected at runtime,
… …
109 EV_USE_KQUEUE 141 EV_USE_KQUEUE
110 142
111 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
112 style kqueue backend. Its availability will be detected at runtime, 144 style kqueue backend. Its availability will be detected at runtime,
113 otherwise another method will be used as fallback. This is the 145 otherwise another method will be used as fallback. This is the
114 preferred backend for BSD and BSd-like systems. Darwin brokenness 146 preferred backend for BSD and BSD-like systems. Darwin brokenness
115 will be detected at runtime and routed around by disabling this 147 will be detected at runtime and routed around by disabling this
116 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.
117 192
118 EV_COMMON 193 EV_COMMON
119 194
120 By default, all watchers have a "void *data" member. By redefining 195 By default, all watchers have a "void *data" member. By redefining
121 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
… …
124 199
125 For example, the perl EV module uses this: 200 For example, the perl EV module uses this:
126 201
127 #define EV_COMMON \ 202 #define EV_COMMON \
128 SV *self; /* contains this struct */ \ 203 SV *self; /* contains this struct */ \
129 SV *cb_sv, *fh; 204 SV *cb_sv, *fh /* note no trailing ";" */
130 205
131 EV_PROTOTYPES 206 EV_CB_DECLARE(type)
207 EV_CB_INVOKE(watcher,revents)
208 ev_set_cb(ev,cb)
132 209
133 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
134 prototypes, but still define all the structs and other 211 watcher, and the way callbacks are invoked and set. Must expand
135 symbols. This is occasionally useful. 212 to a struct member definition and a statement, respectively. See
136 213 the ev.v header file for their default definitions. One possible
137 EV_MULTIPLICITY 214 use for overriding these is to avoid the ev_loop pointer as first
138 215 argument in all cases, or to use method calls instead of plain
139 If undefined or defined to "1", then all event-loop-specific 216 function calls in C++.
140 functions will have the "struct ev_loop *" as first argument, and
141 you can create additional independent event loops. Otherwise there
142 will be no support for multiple event loops and there is no first
143 event loop pointer argument. Instead, all functions act on the
144 single default loop.
145 217
146EXAMPLES 218EXAMPLES
147 219
148 For a real-world example of a program the includes libev 220 For a real-world example of a program the includes libev
149 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