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

Comparing cvsroot/libev/README.embed (file contents):
Revision 1.1 by root, Sun Nov 4 18:15:16 2007 UTC vs.
Revision 1.6 by root, Tue Nov 6 19:46:15 2007 UTC

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"
25 27
26 ev.h 28 ev.h
27 ev.c 29 ev.c
28 ev_vars.h 30 ev_vars.h
29 ev_wrap.h 31 ev_wrap.h
32 ev_win32.c
33
34 ev_select.c only when select backend is enabled (which is by default)
35 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)
37 ev_kqueue.c only when the kqueue backend is enabled (disabled by default)
38
39 "ev.c" includes the backend files directly when enabled.
40
41 LIBEVENT COMPATIBILITY API
30 42
31 To include the libevent compatibility API, also include: 43 To include the libevent compatibility API, also include:
32 44
33 #include "event.c" 45 #include "event.c"
34 46
112 124
113 For example, the perl EV module uses this: 125 For example, the perl EV module uses this:
114 126
115 #define EV_COMMON \ 127 #define EV_COMMON \
116 SV *self; /* contains this struct */ \ 128 SV *self; /* contains this struct */ \
117 SV *cb_sv, *fh; 129 SV *cb_sv, *fh /* note no trailing ";" */
118 130
119 EV_PROTOTYPES 131 EV_PROTOTYPES
120 132
121 If defined to be "0", then "ev.h" will not define any function 133 If defined to be "0", then "ev.h" will not define any function
122 prototypes, but still define all the structs and other 134 prototypes, but still define all the structs and other
131 event loop pointer argument. Instead, all functions act on the 143 event loop pointer argument. Instead, all functions act on the
132 single default loop. 144 single default loop.
133 145
134EXAMPLES 146EXAMPLES
135 147
136 For a real-world example of a program the includes libev verbatim, you 148 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). 149 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 150 (http://software.schmorp.de/pkg/EV.html). It has the libev files in
139 EV.xs files. Only this file will be compiled. 151 the libev/ subdirectory and includes them in the EV/EVAPI.h (public
152 interface) and EV.xs (implementation) files. Only the EV.xs file will
153 be compiled.
140 154

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines