libev/README.embed

EMBEDDING THE LIBEV CODE INTO YOUR OWN PROGRAMS

    Instead of building the libev library you cna also include the code
    as-is into your programs. To update, you only have to copy a few files
    into your source tree.

    This is how it works:

FILESETS

    To include only the libev core (all the ev_* functions):

        #define EV_STANDALONE   1
        #include "ev.c"

    This will automatically include ev.h, too, and should be done in a
    single C source file only to provide the function implementations. To
    use it, do the same for ev.h in all users:

        #define EV_STANDALONE   1
        #include "ev.h"

    You need the following files in your source tree, or in a directory
    in your include path (e.g. in libev/ when using -Ilibev):

        ev.h
        ev.c
        ev_vars.h
        ev_wrap.h
        ev_win32.c

        ev_select.c     only when select backend is enabled (which is by default)
        ev_poll.c       only when poll backend is enabled (disabled by default)
        ev_epoll.c      only when the epoll backend is enabled (disabled by default)
        ev_kqueue.c     only when the kqueue backend is enabled (disabled by default)

    "ev.c" includes the backend files directly when enabled.

    To include the libevent compatibility API, also include:

        #include "event.c"

    in the file including "ev.c", and:

        #include "event.h"

    in the files that want to use the libevent API. This also includes "ev.h".

    You need the following additional files for this:

        event.h
        event.c

PREPROCESSOR SYMBOLS

    Libev can be configured via a variety of preprocessor symbols you have to define
    before including any of its files. The default is not to build for mulciplicity
    and only include the select backend.

    EV_STANDALONE

        Must always be "1", which keeps libev from including config.h or
        other files, and it also defines dummy implementations for some
        libevent functions (such as logging, which is not supported). It
        will also not define any of the structs usually found in "event.h"
        that are not directly supported by libev code alone.

    EV_USE_MONOTONIC

        If undefined or defined to be "1", libev will try to detect the
        availability of the monotonic clock option at both compiletime and
        runtime. Otherwise no use of the monotonic clock option will be
        attempted.

    EV_USE_REALTIME

        If defined to be "1", libev will try to detect the availability
        of the realtime clock option at compiletime (and assume its
        availability at runtime if successful). Otherwise no use of the
        realtime clock option will be attempted. This effectively replaces
        gettimeofday by clock_get (CLOCK_REALTIME, ...) and will not normally
        affect correctness.

    EV_USE_SELECT

       If undefined or defined to be "1", libev will compile in support
       for the select(2) backend. No attempt at autodetection will be
       done: if no other method takes over, select will be it. Otherwise
       the select backend will not be compiled in.

    EV_USE_POLL

       If defined to be "1", libev will compile in support for the poll(2)
       backend. No attempt at autodetection will be done. poll usually
       performs worse than select, so its not enabled by default (it is
       also slightly less portable).

    EV_USE_EPOLL

       If defined to be "1", libev will compile in support for the Linux
       epoll backend. Its availability will be detected at runtime,
       otherwise another method will be used as fallback. This is the
       preferred backend for GNU/Linux systems.

    EV_USE_KQUEUE

       If defined to be "1", libev will compile in support for the BSD
       style kqueue backend. Its availability will be detected at runtime,
       otherwise another method will be used as fallback. This is the
       preferred backend for BSD and BSd-like systems. Darwin brokenness
       will be detected at runtime and routed around by disabling this
       backend.

    EV_COMMON
 
       By default, all watchers have a "void *data" member. By redefining
       this macro to a something else you can include more and other types
       of members. You have to define it each time you include one of the
       files, though, and it must be identical each time.

       For example, the perl EV module uses this:

           #define EV_COMMON                       \
             SV *self; /* contains this struct */  \
             SV *cb_sv, *fh;

    EV_PROTOTYPES

       If defined to be "0", then "ev.h" will not define any function
       prototypes, but still define all the structs and other
       symbols. This is occasionally useful.

    EV_MULTIPLICITY

       If undefined or defined to "1", then all event-loop-specific
       functions will have the "struct ev_loop *" as first argument, and
       you can create additional independent event loops. Otherwise there
       will be no support for multiple event loops and there is no first
       event loop pointer argument. Instead, all functions act on the
       single default loop.

EXAMPLES

    For a real-world example of a program the includes libev
    verbatim, you can have a look at the EV perl module
    (http://software.schmorp.de/pkg/EV.html).  It has the libev files in
    the liev/ subdirectory and includes them in the EV/EVAPI.h (public
    interface) and EV.xs (implementation) files. Only EV.xs file will be
    compiled.

Revision:	1.4
Committed:	Tue Nov 6 16:27:10 2007 UTC (16 years, 6 months ago) by root
Branch:	MAIN
CVS Tags:	rel-0_51, rel-0_5
Changes since 1.3:	+2 -0 lines
Log Message:	big win32 check-in
#	Content
1	EMBEDDING THE LIBEV CODE INTO YOUR OWN PROGRAMS
2
3	Instead of building the libev library you cna also include the code
4	as-is into your programs. To update, you only have to copy a few files
5	into your source tree.
6
7	This is how it works:
8
9	FILESETS
10
11	To include only the libev core (all the ev_* functions):
12
13	#define EV_STANDALONE 1
14	#include "ev.c"
15
16	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
18	use it, do the same for ev.h in all users:
19
20	#define EV_STANDALONE 1
21	#include "ev.h"
22
23	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):
25
26	ev.h
27	ev.c
28	ev_vars.h
29	ev_wrap.h
30	ev_win32.c
31
32	ev_select.c only when select backend is enabled (which is by default)
33	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)
35	ev_kqueue.c only when the kqueue backend is enabled (disabled by default)
36
37	"ev.c" includes the backend files directly when enabled.
38
39	To include the libevent compatibility API, also include:
40
41	#include "event.c"
42
43	in the file including "ev.c", and:
44
45	#include "event.h"
46
47	in the files that want to use the libevent API. This also includes "ev.h".
48
49	You need the following additional files for this:
50
51	event.h
52	event.c
53
54	PREPROCESSOR SYMBOLS
55
56	Libev can be configured via a variety of preprocessor symbols you have to define
57	before including any of its files. The default is not to build for mulciplicity
58	and only include the select backend.
59
60	EV_STANDALONE
61
62	Must always be "1", which keeps libev from including config.h or
63	other files, and it also defines dummy implementations for some
64	libevent functions (such as logging, which is not supported). It
65	will also not define any of the structs usually found in "event.h"
66	that are not directly supported by libev code alone.
67
68	EV_USE_MONOTONIC
69
70	If undefined or defined to be "1", libev will try to detect the
71	availability of the monotonic clock option at both compiletime and
72	runtime. Otherwise no use of the monotonic clock option will be
73	attempted.
74
75	EV_USE_REALTIME
76
77	If defined to be "1", libev will try to detect the availability
78	of the realtime clock option at compiletime (and assume its
79	availability at runtime if successful). Otherwise no use of the
80	realtime clock option will be attempted. This effectively replaces
81	gettimeofday by clock_get (CLOCK_REALTIME, ...) and will not normally
82	affect correctness.
83
84	EV_USE_SELECT
85
86	If undefined or defined to be "1", libev will compile in support
87	for the select(2) backend. No attempt at autodetection will be
88	done: if no other method takes over, select will be it. Otherwise
89	the select backend will not be compiled in.
90
91	EV_USE_POLL
92
93	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
95	performs worse than select, so its not enabled by default (it is
96	also slightly less portable).
97
98	EV_USE_EPOLL
99
100	If defined to be "1", libev will compile in support for the Linux
101	epoll backend. Its availability will be detected at runtime,
102	otherwise another method will be used as fallback. This is the
103	preferred backend for GNU/Linux systems.
104
105	EV_USE_KQUEUE
106
107	If defined to be "1", libev will compile in support for the BSD
108	style kqueue backend. Its availability will be detected at runtime,
109	otherwise another method will be used as fallback. This is the
110	preferred backend for BSD and BSd-like systems. Darwin brokenness
111	will be detected at runtime and routed around by disabling this
112	backend.
113
114	EV_COMMON
115
116	By default, all watchers have a "void *data" member. By redefining
117	this macro to a something else you can include more and other types
118	of members. You have to define it each time you include one of the
119	files, though, and it must be identical each time.
120
121	For example, the perl EV module uses this:
122
123	#define EV_COMMON \
124	SV self; / contains this struct */ \
125	SV cb_sv, fh;
126
127	EV_PROTOTYPES
128
129	If defined to be "0", then "ev.h" will not define any function
130	prototypes, but still define all the structs and other
131	symbols. This is occasionally useful.
132
133	EV_MULTIPLICITY
134
135	If undefined or defined to "1", then all event-loop-specific
136	functions will have the "struct ev_loop *" as first argument, and
137	you can create additional independent event loops. Otherwise there
138	will be no support for multiple event loops and there is no first
139	event loop pointer argument. Instead, all functions act on the
140	single default loop.
141
142	EXAMPLES
143
144	For a real-world example of a program the includes libev
145	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
147	the liev/ subdirectory and includes them in the EV/EVAPI.h (public
148	interface) and EV.xs (implementation) files. Only EV.xs file will be
149	compiled.
150