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.22 by ayin, Sun Nov 11 17:02:08 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
… …
118 EV_USE_KQUEUE 132 EV_USE_KQUEUE
119 133
120 If defined to be "1", libev will compile in support for the BSD 134 If defined to be "1", libev will compile in support for the BSD
121 style kqueue backend. Its availability will be detected at runtime, 135 style kqueue backend. Its availability will be detected at runtime,
122 otherwise another method will be used as fallback. This is the 136 otherwise another method will be used as fallback. This is the
123 preferred backend for BSD and BSd-like systems. Darwin brokenness 137 preferred backend for BSD and BSD-like systems. Darwin brokenness
124 will be detected at runtime and routed around by disabling this 138 will be detected at runtime and routed around by disabling this
125 backend. 139 backend.
140
141 EV_H
142
143 The name of the ev.h header file used to include it. The default
144 if undefined is <ev.h> in event.h and "ev.h" in ev.c. This can
145 be used to virtually rename the ev.h header file in case of
146 conflicts.
147
148 EV_EVENT_H
149
150 Similarly to EV_H, this macro cna be used to override event.c's idea
151 of how the event.h header can be found.
152
153 EV_PROTOTYPES
154
155 If defined to be "0", then "ev.h" will not define any function
156 prototypes, but still define all the structs and other
157 symbols. This is occasionally useful.
158
159 EV_MULTIPLICITY
160
161 If undefined or defined to "1", then all event-loop-specific
162 functions will have the "struct ev_loop *" as first argument, and
163 you can create additional independent event loops. Otherwise there
164 will be no support for multiple event loops and there is no first
165 event loop pointer argument. Instead, all functions act on the
166 single default loop.
167
168 EV_PERIODICS
169
170 If undefined or defined to be "1", then periodic timers are
171 supported, otherwise not. This saves a few kb of code.
126 172
127 EV_COMMON 173 EV_COMMON
128 174
129 By default, all watchers have a "void *data" member. By redefining 175 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 176 this macro to a something else you can include more and other types
… …
135 181
136 #define EV_COMMON \ 182 #define EV_COMMON \
137 SV *self; /* contains this struct */ \ 183 SV *self; /* contains this struct */ \
138 SV *cb_sv, *fh /* note no trailing ";" */ 184 SV *cb_sv, *fh /* note no trailing ";" */
139 185
140 EV_PROTOTYPES 186 EV_CB_DECLARE(type)
187 EV_CB_INVOKE(watcher,revents)
188 ev_set_cb(ev,cb)
141 189
142 If defined to be "0", then "ev.h" will not define any function 190 Can be used to change the callback member declaration in each
143 prototypes, but still define all the structs and other 191 watcher, and the way callbacks are invoked and set. Must expand
144 symbols. This is occasionally useful. 192 to a struct member definition and a statement, respectively. See
145 193 the ev.v header file for their default definitions. One possible
146 EV_MULTIPLICITY 194 use for overriding these is to avoid the ev_loop pointer as first
147 195 argument in all cases, or to use method calls instead of plain
148 If undefined or defined to "1", then all event-loop-specific 196 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 197
155EXAMPLES 198EXAMPLES
156 199
157 For a real-world example of a program the includes libev 200 For a real-world example of a program the includes libev
158 verbatim, you can have a look at the EV perl module 201 verbatim, you can have a look at the EV perl module

Diff Legend

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