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

Comparing libev/README.embed (file contents):
Revision 1.1 by root, Sun Nov 4 18:15:16 2007 UTC vs.
Revision 1.23 by root, Sun Nov 11 17:59:25 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
9FILESETS 9FILESETS
10 10
11 CORE EVENT LOOP
12
11 To include only the libev core (all the ev_* functions): 13 To include only the libev core (all the ev_* functions):
12 14
13 #define EV_STANDALONE 1 15 #define EV_STANDALONE 1
14 #include "ev.c" 16 #include "ev.c"
15 17
16 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
17 single C source file only to provide the function implementations. To 19 single C source file only to provide the function implementations. To
18 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):
19 23
20 #define EV_STANDALONE 1 24 #define EV_STANDALONE 1
21 #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).
22 30
23 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
24 in your include path (e.g. in libev/ when using -Ilibev): 32 in your include path (e.g. in libev/ when using -Ilibev):
25 33
26 ev.h 34 ev.h
27 ev.c 35 ev.c
28 ev_vars.h 36 ev_vars.h
29 ev_wrap.h 37 ev_wrap.h
30 38
39 ev_win32.c required on win32 platforms only
40
41 ev_select.c only when select backend is enabled (which is is by default)
42 ev_poll.c only when poll backend is enabled (disabled by default)
43 ev_epoll.c only when the epoll backend is enabled (disabled by default)
44 ev_kqueue.c only when the kqueue backend is enabled (disabled by default)
45
46 "ev.c" includes the backend files directly when enabled.
47
48 LIBEVENT COMPATIBILITY API
49
31 To include the libevent compatibility API, also include: 50 To include the libevent compatibility API, also include:
32 51
33 #include "event.c" 52 #include "event.c"
34 53
35 in the file including "ev.c", and: 54 in the file including "ev.c", and:
… …
41 You need the following additional files for this: 60 You need the following additional files for this:
42 61
43 event.h 62 event.h
44 event.c 63 event.c
45 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
46PREPROCESSOR SYMBOLS 72PREPROCESSOR SYMBOLS
47 73
48 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
49 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
50 and only include the select backend. 76 and only include the select backend.
51 77
52 EV_STANDALONE 78 EV_STANDALONE
53 79
54 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
… …
78 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
79 for the select(2) backend. No attempt at autodetection will be 105 for the select(2) backend. No attempt at autodetection will be
80 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
81 the select backend will not be compiled in. 107 the select backend will not be compiled in.
82 108
109 EV_SELECT_USE_WIN32_HANDLES
110
111 When defined to 1, the select backend will assume that select
112 doesn't understand file descriptors but wants osf handles on
113 win32 (this is the case when the select to be used is the winsock
114 select). This means that it will call _get_osfhandle on the fd to
115 convert it to an OS handle. Should not be defined on non-win32
116 platforms.
117
83 EV_USE_POLL 118 EV_USE_POLL
84 119
85 If defined to be "1", libev will compile in support for the poll(2) 120 If defined to be "1", libev will compile in support for the poll(2)
86 backend. No attempt at autodetection will be done. poll usually 121 backend. No attempt at autodetection will be done. poll usually
87 performs worse than select, so its not enabled by default (it is 122 performs worse than select, so its not enabled by default (it is
… …
97 EV_USE_KQUEUE 132 EV_USE_KQUEUE
98 133
99 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
100 style kqueue backend. Its availability will be detected at runtime, 135 style kqueue backend. Its availability will be detected at runtime,
101 otherwise another method will be used as fallback. This is the 136 otherwise another method will be used as fallback. This is the
102 preferred backend for BSD and BSd-like systems. Darwin brokenness 137 preferred backend for BSD and BSD-like systems. Darwin brokenness
103 will be detected at runtime and routed around by disabling this 138 will be detected at runtime and routed around by disabling this
104 backend. 139 backend.
140
141 EV_USE_DEVPOLL
142 EV_USE_PORTS
143
144 reserved for future expansion, works like the USE symbols above.
145
146 EV_H
147
148 The name of the ev.h header file used to include it. The default
149 if undefined is <ev.h> in event.h and "ev.h" in ev.c. This can
150 be used to virtually rename the ev.h header file in case of
151 conflicts.
152
153 EV_EVENT_H
154
155 Similarly to EV_H, this macro cna be used to override event.c's idea
156 of how the event.h header can be found.
157
158 EV_PROTOTYPES
159
160 If defined to be "0", then "ev.h" will not define any function
161 prototypes, but still define all the structs and other
162 symbols. This is occasionally useful.
163
164 EV_MULTIPLICITY
165
166 If undefined or defined to "1", then all event-loop-specific
167 functions will have the "struct ev_loop *" as first argument, and
168 you can create additional independent event loops. Otherwise there
169 will be no support for multiple event loops and there is no first
170 event loop pointer argument. Instead, all functions act on the
171 single default loop.
172
173 EV_PERIODICS
174
175 If undefined or defined to be "1", then periodic timers are
176 supported, otherwise not. This saves a few kb of code.
105 177
106 EV_COMMON 178 EV_COMMON
107 179
108 By default, all watchers have a "void *data" member. By redefining 180 By default, all watchers have a "void *data" member. By redefining
109 this macro to a something else you can include more and other types 181 this macro to a something else you can include more and other types
… …
112 184
113 For example, the perl EV module uses this: 185 For example, the perl EV module uses this:
114 186
115 #define EV_COMMON \ 187 #define EV_COMMON \
116 SV *self; /* contains this struct */ \ 188 SV *self; /* contains this struct */ \
117 SV *cb_sv, *fh; 189 SV *cb_sv, *fh /* note no trailing ";" */
118 190
119 EV_PROTOTYPES 191 EV_CB_DECLARE(type)
192 EV_CB_INVOKE(watcher,revents)
193 ev_set_cb(ev,cb)
120 194
121 If defined to be "0", then "ev.h" will not define any function 195 Can be used to change the callback member declaration in each
122 prototypes, but still define all the structs and other 196 watcher, and the way callbacks are invoked and set. Must expand
123 symbols. This is occasionally useful. 197 to a struct member definition and a statement, respectively. See
124 198 the ev.v header file for their default definitions. One possible
125 EV_MULTIPLICITY 199 use for overriding these is to avoid the ev_loop pointer as first
126 200 argument in all cases, or to use method calls instead of plain
127 If undefined or defined to "1", then all event-loop-specific 201 function calls in C++.
128 functions will have the "struct ev_loop *" as first argument, and
129 you can create additional independent event loops. Otherwise there
130 will be no support for multiple event loops and there is no first
131 event loop pointer argument. Instead, all functions act on the
132 single default loop.
133 202
134EXAMPLES 203EXAMPLES
135 204
136 For a real-world example of a program the includes libev verbatim, you 205 For a real-world example of a program the includes libev
137 can have a look at the EV perl module (http://software.schmorp.de/pkg/EV.html). 206 verbatim, you can have a look at the EV perl module
138 It has the libev files in the liev/ subdirectory and includes them in the 207 (http://software.schmorp.de/pkg/EV.html). It has the libev files in
139 EV.xs files. Only this file will be compiled. 208 the libev/ subdirectory and includes them in the EV/EVAPI.h (public
209 interface) and EV.xs (implementation) files. Only the EV.xs file will
210 be compiled.
140 211

Diff Legend

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