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

    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.xs files. Only this file will be compiled.

Revision:	1.1
Committed:	Sun Nov 4 18:15:16 2007 UTC (16 years, 6 months ago) by root
Branch:	MAIN
Log Message:	* empty log message *
#	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
31	To include the libevent compatibility API, also include:
32
33	#include "event.c"
34
35	in the file including "ev.c", and:
36
37	#include "event.h"
38
39	in the files that want to use the libevent API. This also includes "ev.h".
40
41	You need the following additional files for this:
42
43	event.h
44	event.c
45
46	PREPROCESSOR SYMBOLS
47
48	Libev can be configured via a variety of preprocessor symbols you have to define
49	before including any of its files. The default is not to build for mulciplicity
50	and only include the select backend.
51
52	EV_STANDALONE
53
54	Must always be "1", which keeps libev from including config.h or
55	other files, and it also defines dummy implementations for some
56	libevent functions (such as logging, which is not supported). It
57	will also not define any of the structs usually found in "event.h"
58	that are not directly supported by libev code alone.
59
60	EV_USE_MONOTONIC
61
62	If undefined or defined to be "1", libev will try to detect the
63	availability of the monotonic clock option at both compiletime and
64	runtime. Otherwise no use of the monotonic clock option will be
65	attempted.
66
67	EV_USE_REALTIME
68
69	If defined to be "1", libev will try to detect the availability
70	of the realtime clock option at compiletime (and assume its
71	availability at runtime if successful). Otherwise no use of the
72	realtime clock option will be attempted. This effectively replaces
73	gettimeofday by clock_get (CLOCK_REALTIME, ...) and will not normally
74	affect correctness.
75
76	EV_USE_SELECT
77
78	If undefined or defined to be "1", libev will compile in support
79	for the select(2) backend. No attempt at autodetection will be
80	done: if no other method takes over, select will be it. Otherwise
81	the select backend will not be compiled in.
82
83	EV_USE_POLL
84
85	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
87	performs worse than select, so its not enabled by default (it is
88	also slightly less portable).
89
90	EV_USE_EPOLL
91
92	If defined to be "1", libev will compile in support for the Linux
93	epoll backend. Its availability will be detected at runtime,
94	otherwise another method will be used as fallback. This is the
95	preferred backend for GNU/Linux systems.
96
97	EV_USE_KQUEUE
98
99	If defined to be "1", libev will compile in support for the BSD
100	style kqueue backend. Its availability will be detected at runtime,
101	otherwise another method will be used as fallback. This is the
102	preferred backend for BSD and BSd-like systems. Darwin brokenness
103	will be detected at runtime and routed around by disabling this
104	backend.
105
106	EV_COMMON
107
108	By default, all watchers have a "void *data" member. By redefining
109	this macro to a something else you can include more and other types
110	of members. You have to define it each time you include one of the
111	files, though, and it must be identical each time.
112
113	For example, the perl EV module uses this:
114
115	#define EV_COMMON \
116	SV self; / contains this struct */ \
117	SV cb_sv, fh;
118
119	EV_PROTOTYPES
120
121	If defined to be "0", then "ev.h" will not define any function
122	prototypes, but still define all the structs and other
123	symbols. This is occasionally useful.
124
125	EV_MULTIPLICITY
126
127	If undefined or defined to "1", then all event-loop-specific
128	functions will have the "struct ev_loop *" as first argument, and
129	you can create additional independent event loops. Otherwise there
130	will be no support for multiple event loops and there is no first
131	event loop pointer argument. Instead, all functions act on the
132	single default loop.
133
134	EXAMPLES
135
136	For a real-world example of a program the includes libev verbatim, you
137	can have a look at the EV perl module (http://software.schmorp.de/pkg/EV.html).
138	It has the libev files in the liev/ subdirectory and includes them in the
139	EV.xs files. Only this file will be compiled.
140