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

Comparing libev/README.embed (file contents):
Revision 1.7 by root, Thu Nov 8 16:58:00 2007 UTC vs.
Revision 1.26 by root, Fri Nov 16 10:37:28 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)
45 ev_port.c only when the solaris port backend is enabled (disabled by default)
38 46
39 "ev.c" includes the backend files directly when enabled. 47 "ev.c" includes the backend files directly when enabled.
40 48
41 LIBEVENT COMPATIBILITY API 49 LIBEVENT COMPATIBILITY API
42 50
… …
53 You need the following additional files for this: 61 You need the following additional files for this:
54 62
55 event.h 63 event.h
56 event.c 64 event.c
57 65
66AUTOCONF SUPPORT
67
68 Instead of using EV_STANDALONE=1 and providing your config in whatever
69 way you want, you can also m4_include([libev.m4]) in your configure.ac
70 and leave EV_STANDALONE off. ev.c will then include "config.h" and
71 configure itself accordingly.
72
58PREPROCESSOR SYMBOLS 73PREPROCESSOR SYMBOLS
59 74
60 Libev can be configured via a variety of preprocessor symbols you have to define 75 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 76 before including any of its files. The default is not to build for multiplicity
62 and only include the select backend. 77 and only include the select backend.
63 78
64 EV_STANDALONE 79 EV_STANDALONE
65 80
66 Must always be "1", which keeps libev from including config.h or 81 Must always be "1", which keeps libev from including config.h or
… …
69 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"
70 that are not directly supported by libev code alone. 85 that are not directly supported by libev code alone.
71 86
72 EV_USE_MONOTONIC 87 EV_USE_MONOTONIC
73 88
74 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
75 availability of the monotonic clock option at both compiletime and 90 of the monotonic clock option at both compiletime and
76 runtime. Otherwise no use of the monotonic clock option will be 91 runtime. Otherwise no use of the monotonic clock option will be
77 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.
78 95
79 EV_USE_REALTIME 96 EV_USE_REALTIME
80 97
81 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
82 of the realtime clock option at compiletime (and assume its 99 of the realtime clock option at compiletime (and assume its
… …
90 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
91 for the select(2) backend. No attempt at autodetection will be 108 for the select(2) backend. No attempt at autodetection will be
92 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
93 the select backend will not be compiled in. 110 the select backend will not be compiled in.
94 111
95 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
96 123
97 When defined to 1, the select backend will assume that select 124 When defined to 1, the select backend will assume that select
98 doesn't understand file descriptors but wants osf handles on 125 doesn't understand file descriptors but wants osf handles on
99 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
100 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
… …
102 platforms. 129 platforms.
103 130
104 EV_USE_POLL 131 EV_USE_POLL
105 132
106 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)
107 backend. No attempt at autodetection will be done. poll usually 134 backend. Otherwise it will be enabled on non-win32 platforms. It
108 performs worse than select, so its not enabled by default (it is 135 takes precedence over select.
109 also slightly less portable).
110 136
111 EV_USE_EPOLL 137 EV_USE_EPOLL
112 138
113 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
114 epoll backend. Its availability will be detected at runtime, 140 epoll backend. Its availability will be detected at runtime,
… …
118 EV_USE_KQUEUE 144 EV_USE_KQUEUE
119 145
120 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
121 style kqueue backend. Its availability will be detected at runtime, 147 style kqueue backend. Its availability will be detected at runtime,
122 otherwise another method will be used as fallback. This is the 148 otherwise another method will be used as fallback. This is the
123 preferred backend for BSD and BSd-like systems. Darwin brokenness 149 preferred backend for BSD and BSD-like systems. Darwin brokenness
124 will be detected at runtime and routed around by disabling this 150 will be detected at runtime and routed around by disabling this
125 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.
163
164 EV_H
165
166 The name of the ev.h header file used to include it. The default
167 if undefined is <ev.h> in event.h and "ev.h" in ev.c. This can
168 be used to virtually rename the ev.h header file in case of
169 conflicts.
170
171 EV_EVENT_H
172
173 Similarly to EV_H, this macro cna be used to override event.c's idea
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.
126 195
127 EV_COMMON 196 EV_COMMON
128 197
129 By default, all watchers have a "void *data" member. By redefining 198 By default, all watchers have a "void *data" member. By redefining
130 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
… …
135 204
136 #define EV_COMMON \ 205 #define EV_COMMON \
137 SV *self; /* contains this struct */ \ 206 SV *self; /* contains this struct */ \
138 SV *cb_sv, *fh /* note no trailing ";" */ 207 SV *cb_sv, *fh /* note no trailing ";" */
139 208
140 EV_PROTOTYPES 209 EV_CB_DECLARE(type)
210 EV_CB_INVOKE(watcher,revents)
211 ev_set_cb(ev,cb)
141 212
142 If defined to be "0", then "ev.h" will not define any function 213 Can be used to change the callback member declaration in each
143 prototypes, but still define all the structs and other 214 watcher, and the way callbacks are invoked and set. Must expand
144 symbols. This is occasionally useful. 215 to a struct member definition and a statement, respectively. See
145 216 the ev.v header file for their default definitions. One possible
146 EV_MULTIPLICITY 217 use for overriding these is to avoid the ev_loop pointer as first
147 218 argument in all cases, or to use method calls instead of plain
148 If undefined or defined to "1", then all event-loop-specific 219 function calls in C++.
149 functions will have the "struct ev_loop *" as first argument, and
150 you can create additional independent event loops. Otherwise there
151 will be no support for multiple event loops and there is no first
152 event loop pointer argument. Instead, all functions act on the
153 single default loop.
154 220
155EXAMPLES 221EXAMPLES
156 222
157 For a real-world example of a program the includes libev 223 For a real-world example of a program the includes libev
158 verbatim, you can have a look at the EV perl module 224 verbatim, you can have a look at the EV perl module

Diff Legend

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