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

Comparing libev/README.embed (file contents):
Revision 1.2 by root, Sun Nov 4 18:16:52 2007 UTC vs.
Revision 1.17 by root, Fri Nov 9 21:48:22 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
11 CORE EVENT LOOP
10 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
38 ev_win32.c
39
40 ev_select.c only when select backend is enabled (which is is by default)
41 ev_poll.c only when poll backend is enabled (disabled by default)
42 ev_epoll.c only when the epoll backend is enabled (disabled by default)
43 ev_kqueue.c only when the kqueue backend is enabled (disabled by default)
44
45 "ev.c" includes the backend files directly when enabled.
46
47 LIBEVENT COMPATIBILITY API
30 48
31 To include the libevent compatibility API, also include: 49 To include the libevent compatibility API, also include:
32 50
33 #include "event.c" 51 #include "event.c"
34 52
… …
78 If undefined or defined to be "1", libev will compile in support 96 If undefined or defined to be "1", libev will compile in support
79 for the select(2) backend. No attempt at autodetection will be 97 for the select(2) backend. No attempt at autodetection will be
80 done: if no other method takes over, select will be it. Otherwise 98 done: if no other method takes over, select will be it. Otherwise
81 the select backend will not be compiled in. 99 the select backend will not be compiled in.
82 100
101 EV_SELECT_USE_WIN32_HANDLES
102
103 When defined to 1, the select backend will assume that select
104 doesn't understand file descriptors but wants osf handles on
105 win32 (this is the case when the select to be used is the winsock
106 select). This means that it will call _get_osfhandle on the fd to
107 convert it to an OS handle. Should not be defined on non-win32
108 platforms.
109
83 EV_USE_POLL 110 EV_USE_POLL
84 111
85 If defined to be "1", libev will compile in support for the poll(2) 112 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 113 backend. No attempt at autodetection will be done. poll usually
87 performs worse than select, so its not enabled by default (it is 114 performs worse than select, so its not enabled by default (it is
… …
101 otherwise another method will be used as fallback. This is the 128 otherwise another method will be used as fallback. This is the
102 preferred backend for BSD and BSd-like systems. Darwin brokenness 129 preferred backend for BSD and BSd-like systems. Darwin brokenness
103 will be detected at runtime and routed around by disabling this 130 will be detected at runtime and routed around by disabling this
104 backend. 131 backend.
105 132
133 EV_H
134
135 The name of the ev.h header file used to include it. The default
136 if undefined is <ev.h> in event.h and "ev.h" in ev.c. This can
137 be used to virtually rename the ev.h header file in case of
138 conflicts.
139
140 EV_EVENT_H
141
142 Similarly to EV_H, this macro cna be used to override event.c's idea
143 of how the event.h header can be found.
144
106 EV_COMMON 145 EV_COMMON
107 146
108 By default, all watchers have a "void *data" member. By redefining 147 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 148 this macro to a something else you can include more and other types
110 of members. You have to define it each time you include one of the 149 of members. You have to define it each time you include one of the
… …
112 151
113 For example, the perl EV module uses this: 152 For example, the perl EV module uses this:
114 153
115 #define EV_COMMON \ 154 #define EV_COMMON \
116 SV *self; /* contains this struct */ \ 155 SV *self; /* contains this struct */ \
117 SV *cb_sv, *fh; 156 SV *cb_sv, *fh /* note no trailing ";" */
118 157
119 EV_PROTOTYPES 158 EV_PROTOTYPES
120 159
121 If defined to be "0", then "ev.h" will not define any function 160 If defined to be "0", then "ev.h" will not define any function
122 prototypes, but still define all the structs and other 161 prototypes, but still define all the structs and other
… …
129 you can create additional independent event loops. Otherwise there 168 you can create additional independent event loops. Otherwise there
130 will be no support for multiple event loops and there is no first 169 will be no support for multiple event loops and there is no first
131 event loop pointer argument. Instead, all functions act on the 170 event loop pointer argument. Instead, all functions act on the
132 single default loop. 171 single default loop.
133 172
173 EV_CB_DECLARE(type)
174 EV_CB_INVOKE(watcher,revents)
175 ev_set_cb(ev,cb)
176
177 Can be used to change the callback member declaration in each
178 watcher, and the way callbacks are invoked and set. Must expand
179 to a struct member definition and a statement, respectively. See
180 the ev.v header file for their default definitions. One possible
181 use for overriding these is to avoid the ev_loop pointer as first
182 argument in all cases, or to use method calls instead of plain
183 function calls in C++.
184
134EXAMPLES 185EXAMPLES
135 186
136 For a real-world example of a program the includes libev 187 For a real-world example of a program the includes libev
137 verbatim, you can have a look at the EV perl module 188 verbatim, you can have a look at the EV perl module
138 (http://software.schmorp.de/pkg/EV.html). It has the libev files in 189 (http://software.schmorp.de/pkg/EV.html). It has the libev files in
139 the liev/ subdirectory and includes them in the EV/EVAPI.h (public 190 the libev/ subdirectory and includes them in the EV/EVAPI.h (public
140 interface) and EV.xs (implementation) files. Only EV.xs file will be 191 interface) and EV.xs (implementation) files. Only the EV.xs file will
141 compiled. 192 be compiled.
142 193

Diff Legend

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