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.18 by root, Sat Nov 10 15:02:07 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 38 ev_win32.c
33 39
34 ev_select.c only when select backend is enabled (which is by default) 40 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) 41 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) 42 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) 43 ev_kqueue.c only when the kqueue backend is enabled (disabled by default)
38 44
39 "ev.c" includes the backend files directly when enabled. 45 "ev.c" includes the backend files directly when enabled.
… …
53 You need the following additional files for this: 59 You need the following additional files for this:
54 60
55 event.h 61 event.h
56 event.c 62 event.c
57 63
64AUTOCONF SUPPORT
65
66 Instead of using EV_STANDALONE=1 and providing your config in whatever
67 way you want, you can also m4_include([ev.m4]) in your configure.ac
68 and leave EV_STANDALONE off. ev.c will then include "config.h" and
69 configure itself accordingly.
70
58PREPROCESSOR SYMBOLS 71PREPROCESSOR SYMBOLS
59 72
60 Libev can be configured via a variety of preprocessor symbols you have to define 73 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 74 before including any of its files. The default is not to build for multiplicity
62 and only include the select backend. 75 and only include the select backend.
63 76
64 EV_STANDALONE 77 EV_STANDALONE
65 78
66 Must always be "1", which keeps libev from including config.h or 79 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 103 If undefined or defined to be "1", libev will compile in support
91 for the select(2) backend. No attempt at autodetection will be 104 for the select(2) backend. No attempt at autodetection will be
92 done: if no other method takes over, select will be it. Otherwise 105 done: if no other method takes over, select will be it. Otherwise
93 the select backend will not be compiled in. 106 the select backend will not be compiled in.
94 107
108 EV_SELECT_USE_WIN32_HANDLES
109
110 When defined to 1, the select backend will assume that select
111 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
113 select). This means that it will call _get_osfhandle on the fd to
114 convert it to an OS handle. Should not be defined on non-win32
115 platforms.
116
95 EV_USE_POLL 117 EV_USE_POLL
96 118
97 If defined to be "1", libev will compile in support for the poll(2) 119 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 120 backend. No attempt at autodetection will be done. poll usually
99 performs worse than select, so its not enabled by default (it is 121 performs worse than select, so its not enabled by default (it is
… …
113 otherwise another method will be used as fallback. This is the 135 otherwise another method will be used as fallback. This is the
114 preferred backend for BSD and BSd-like systems. Darwin brokenness 136 preferred backend for BSD and BSd-like systems. Darwin brokenness
115 will be detected at runtime and routed around by disabling this 137 will be detected at runtime and routed around by disabling this
116 backend. 138 backend.
117 139
140 EV_H
141
142 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
144 be used to virtually rename the ev.h header file in case of
145 conflicts.
146
147 EV_EVENT_H
148
149 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.
151
118 EV_COMMON 152 EV_COMMON
119 153
120 By default, all watchers have a "void *data" member. By redefining 154 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 155 this macro to a something else you can include more and other types
122 of members. You have to define it each time you include one of the 156 of members. You have to define it each time you include one of the
… …
124 158
125 For example, the perl EV module uses this: 159 For example, the perl EV module uses this:
126 160
127 #define EV_COMMON \ 161 #define EV_COMMON \
128 SV *self; /* contains this struct */ \ 162 SV *self; /* contains this struct */ \
129 SV *cb_sv, *fh; 163 SV *cb_sv, *fh /* note no trailing ";" */
130 164
131 EV_PROTOTYPES 165 EV_PROTOTYPES
132 166
133 If defined to be "0", then "ev.h" will not define any function 167 If defined to be "0", then "ev.h" will not define any function
134 prototypes, but still define all the structs and other 168 prototypes, but still define all the structs and other
… …
141 you can create additional independent event loops. Otherwise there 175 you can create additional independent event loops. Otherwise there
142 will be no support for multiple event loops and there is no first 176 will be no support for multiple event loops and there is no first
143 event loop pointer argument. Instead, all functions act on the 177 event loop pointer argument. Instead, all functions act on the
144 single default loop. 178 single default loop.
145 179
180 EV_CB_DECLARE(type)
181 EV_CB_INVOKE(watcher,revents)
182 ev_set_cb(ev,cb)
183
184 Can be used to change the callback member declaration in each
185 watcher, and the way callbacks are invoked and set. Must expand
186 to a struct member definition and a statement, respectively. See
187 the ev.v header file for their default definitions. One possible
188 use for overriding these is to avoid the ev_loop pointer as first
189 argument in all cases, or to use method calls instead of plain
190 function calls in C++.
191
146EXAMPLES 192EXAMPLES
147 193
148 For a real-world example of a program the includes libev 194 For a real-world example of a program the includes libev
149 verbatim, you can have a look at the EV perl module 195 verbatim, you can have a look at the EV perl module
150 (http://software.schmorp.de/pkg/EV.html). It has the libev files in 196 (http://software.schmorp.de/pkg/EV.html). It has the libev files in

Diff Legend

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