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

Comparing libev/README.embed (file contents):
Revision 1.4 by root, Tue Nov 6 16:27:10 2007 UTC vs.
Revision 1.12 by root, Fri Nov 9 17:07:59 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
30 ev_win32.c 38 ev_win32.c
31 39
32 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)
33 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)
34 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)
35 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)
36 44
37 "ev.c" includes the backend files directly when enabled. 45 "ev.c" includes the backend files directly when enabled.
46
47 LIBEVENT COMPATIBILITY API
38 48
39 To include the libevent compatibility API, also include: 49 To include the libevent compatibility API, also include:
40 50
41 #include "event.c" 51 #include "event.c"
42 52
… …
63 other files, and it also defines dummy implementations for some 73 other files, and it also defines dummy implementations for some
64 libevent functions (such as logging, which is not supported). It 74 libevent functions (such as logging, which is not supported). It
65 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"
66 that are not directly supported by libev code alone. 76 that are not directly supported by libev code alone.
67 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 be used
82 to virtually rename the ev.h header file
83
68 EV_USE_MONOTONIC 84 EV_USE_MONOTONIC
69 85
70 If undefined or defined to be "1", libev will try to detect the 86 If undefined or defined to be "1", libev will try to detect the
71 availability of the monotonic clock option at both compiletime and 87 availability of the monotonic clock option at both compiletime and
72 runtime. Otherwise no use of the monotonic clock option will be 88 runtime. Otherwise no use of the monotonic clock option will be
… …
85 101
86 If undefined or defined to be "1", libev will compile in support 102 If undefined or defined to be "1", libev will compile in support
87 for the select(2) backend. No attempt at autodetection will be 103 for the select(2) backend. No attempt at autodetection will be
88 done: if no other method takes over, select will be it. Otherwise 104 done: if no other method takes over, select will be it. Otherwise
89 the select backend will not be compiled in. 105 the select backend will not be compiled in.
106
107 EV_SELECT_USE_WIN32_HANDLES
108
109 When defined to 1, the select backend will assume that select
110 doesn't understand file descriptors but wants osf handles on
111 win32 (this is the case when the select to be used is the winsock
112 select). This means that it will call _get_osfhandle on the fd to
113 convert it to an OS handle. Should not be defined on non-win32
114 platforms.
90 115
91 EV_USE_POLL 116 EV_USE_POLL
92 117
93 If defined to be "1", libev will compile in support for the poll(2) 118 If defined to be "1", libev will compile in support for the poll(2)
94 backend. No attempt at autodetection will be done. poll usually 119 backend. No attempt at autodetection will be done. poll usually
… …
120 145
121 For example, the perl EV module uses this: 146 For example, the perl EV module uses this:
122 147
123 #define EV_COMMON \ 148 #define EV_COMMON \
124 SV *self; /* contains this struct */ \ 149 SV *self; /* contains this struct */ \
125 SV *cb_sv, *fh; 150 SV *cb_sv, *fh /* note no trailing ";" */
126 151
127 EV_PROTOTYPES 152 EV_PROTOTYPES
128 153
129 If defined to be "0", then "ev.h" will not define any function 154 If defined to be "0", then "ev.h" will not define any function
130 prototypes, but still define all the structs and other 155 prototypes, but still define all the structs and other
… …
142EXAMPLES 167EXAMPLES
143 168
144 For a real-world example of a program the includes libev 169 For a real-world example of a program the includes libev
145 verbatim, you can have a look at the EV perl module 170 verbatim, you can have a look at the EV perl module
146 (http://software.schmorp.de/pkg/EV.html). It has the libev files in 171 (http://software.schmorp.de/pkg/EV.html). It has the libev files in
147 the liev/ subdirectory and includes them in the EV/EVAPI.h (public 172 the libev/ subdirectory and includes them in the EV/EVAPI.h (public
148 interface) and EV.xs (implementation) files. Only EV.xs file will be 173 interface) and EV.xs (implementation) files. Only the EV.xs file will
149 compiled. 174 be compiled.
150 175

Diff Legend

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