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.10 by root, Thu Nov 8 18:52:45 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"
22 26
23 You need the following files in your source tree, or in a directory 27 You need the following files in your source tree, or in a directory
… …
25 29
26 ev.h 30 ev.h
27 ev.c 31 ev.c
28 ev_vars.h 32 ev_vars.h
29 ev_wrap.h 33 ev_wrap.h
34 ev_win32.c
35
36 ev_select.c only when select backend is enabled (which is is by default)
37 ev_poll.c only when poll backend is enabled (disabled by default)
38 ev_epoll.c only when the epoll backend is enabled (disabled by default)
39 ev_kqueue.c only when the kqueue backend is enabled (disabled by default)
40
41 "ev.c" includes the backend files directly when enabled.
42
43 LIBEVENT COMPATIBILITY API
30 44
31 To include the libevent compatibility API, also include: 45 To include the libevent compatibility API, also include:
32 46
33 #include "event.c" 47 #include "event.c"
34 48
… …
78 If undefined or defined to be "1", libev will compile in support 92 If undefined or defined to be "1", libev will compile in support
79 for the select(2) backend. No attempt at autodetection will be 93 for the select(2) backend. No attempt at autodetection will be
80 done: if no other method takes over, select will be it. Otherwise 94 done: if no other method takes over, select will be it. Otherwise
81 the select backend will not be compiled in. 95 the select backend will not be compiled in.
82 96
97 EV_SELECT_USE_WIN32_HANDLES
98
99 When defined to 1, the select backend will assume that select
100 doesn't understand file descriptors but wants osf handles on
101 win32 (this is the case when the select to be used is the winsock
102 select). This means that it will call _get_osfhandle on the fd to
103 convert it to an OS handle. Should not be defined on non-win32
104 platforms.
105
83 EV_USE_POLL 106 EV_USE_POLL
84 107
85 If defined to be "1", libev will compile in support for the poll(2) 108 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 109 backend. No attempt at autodetection will be done. poll usually
87 performs worse than select, so its not enabled by default (it is 110 performs worse than select, so its not enabled by default (it is
… …
112 135
113 For example, the perl EV module uses this: 136 For example, the perl EV module uses this:
114 137
115 #define EV_COMMON \ 138 #define EV_COMMON \
116 SV *self; /* contains this struct */ \ 139 SV *self; /* contains this struct */ \
117 SV *cb_sv, *fh; 140 SV *cb_sv, *fh /* note no trailing ";" */
118 141
119 EV_PROTOTYPES 142 EV_PROTOTYPES
120 143
121 If defined to be "0", then "ev.h" will not define any function 144 If defined to be "0", then "ev.h" will not define any function
122 prototypes, but still define all the structs and other 145 prototypes, but still define all the structs and other
… …
131 event loop pointer argument. Instead, all functions act on the 154 event loop pointer argument. Instead, all functions act on the
132 single default loop. 155 single default loop.
133 156
134EXAMPLES 157EXAMPLES
135 158
136 For a real-world example of a program the includes libev verbatim, you 159 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). 160 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 161 (http://software.schmorp.de/pkg/EV.html). It has the libev files in
139 EV.xs files. Only this file will be compiled. 162 the libev/ subdirectory and includes them in the EV/EVAPI.h (public
163 interface) and EV.xs (implementation) files. Only the EV.xs file will
164 be compiled.
140 165

Diff Legend

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