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.13 by root, Fri Nov 9 19:14:37 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
… …
55 other files, and it also defines dummy implementations for some 73 other files, and it also defines dummy implementations for some
56 libevent functions (such as logging, which is not supported). It 74 libevent functions (such as logging, which is not supported). It
57 will also not define any of the structs usually found in "event.h" 75 will also not define any of the structs usually found in "event.h"
58 that are not directly supported by libev code alone. 76 that are not directly supported by libev code alone.
59 77
78 EV_H
79
80 The name of the ev.h header file used to include it. The default
81 if undefined is <ev.h> in event.h and "ev.h" in ev.c. This can
82 be used to virtually rename the ev.h header file in case of
83 conflicts.
84
85 EV_EVENT_H
86
87 Similarly to EV_H, this macro cna be used to override event.c's idea
88 of where the event.h header can be found.
89
60 EV_USE_MONOTONIC 90 EV_USE_MONOTONIC
61 91
62 If undefined or defined to be "1", libev will try to detect the 92 If undefined or defined to be "1", libev will try to detect the
63 availability of the monotonic clock option at both compiletime and 93 availability of the monotonic clock option at both compiletime and
64 runtime. Otherwise no use of the monotonic clock option will be 94 runtime. Otherwise no use of the monotonic clock option will be
… …
77 107
78 If undefined or defined to be "1", libev will compile in support 108 If undefined or defined to be "1", libev will compile in support
79 for the select(2) backend. No attempt at autodetection will be 109 for the select(2) backend. No attempt at autodetection will be
80 done: if no other method takes over, select will be it. Otherwise 110 done: if no other method takes over, select will be it. Otherwise
81 the select backend will not be compiled in. 111 the select backend will not be compiled in.
112
113 EV_SELECT_USE_WIN32_HANDLES
114
115 When defined to 1, the select backend will assume that select
116 doesn't understand file descriptors but wants osf handles on
117 win32 (this is the case when the select to be used is the winsock
118 select). This means that it will call _get_osfhandle on the fd to
119 convert it to an OS handle. Should not be defined on non-win32
120 platforms.
82 121
83 EV_USE_POLL 122 EV_USE_POLL
84 123
85 If defined to be "1", libev will compile in support for the poll(2) 124 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 125 backend. No attempt at autodetection will be done. poll usually
… …
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
… …
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
134EXAMPLES 173EXAMPLES
135 174
136 For a real-world example of a program the includes libev verbatim, you 175 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). 176 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 177 (http://software.schmorp.de/pkg/EV.html). It has the libev files in
139 EV.xs files. Only this file will be compiled. 178 the libev/ subdirectory and includes them in the EV/EVAPI.h (public
179 interface) and EV.xs (implementation) files. Only the EV.xs file will
180 be compiled.
140 181

Diff Legend

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