move event_base predeclaration higher in the file

[software/libev.git] / README.embed

diff --git a/README.embed b/README.embed
index b6322d9ef01bdcc448760ebf470d44884cbf7907..2d2b708bfd58645cbe7bd197304956b69a715891 100644 (file)
--- a/README.embed
+++ b/README.embed
@@ -1,6 +1,6 @@
 EMBEDDING THE LIBEV CODE INTO YOUR OWN PROGRAMS
 
 EMBEDDING THE LIBEV CODE INTO YOUR OWN PROGRAMS
 

-    Instead of building the libev library you cna also include the code
+    Instead of building the libev library you can also include the code

     as-is into your programs. To update, you only have to copy a few files
     into your source tree.
 
     as-is into your programs. To update, you only have to copy a few files
     into your source tree.
 


@@ -8,6 +8,8 @@ EMBEDDING THE LIBEV CODE INTO YOUR OWN PROGRAMS
 
 FILESETS
 
 
 FILESETS
 

+    CORE EVENT LOOP
+

     To include only the libev core (all the ev_* functions):
 
         #define EV_STANDALONE   1
     To include only the libev core (all the ev_* functions):
 
         #define EV_STANDALONE   1


@@ -15,11 +17,17 @@ FILESETS
 
     This will automatically include ev.h, too, and should be done in a
     single C source file only to provide the function implementations. To
 
     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:
+    use it, do the same for ev.h in all files wishing to use this API
+    (best done by writing a wrapper around ev.h that you can include
+    instead and where you can put other configuration options):

 
         #define EV_STANDALONE   1
         #include "ev.h"
 
 
         #define EV_STANDALONE   1
         #include "ev.h"
 

+    Both header files and implementation files can be compiled with a C++
+    compiler (at least, thats a stated goal, and breakage will be treated
+    as a bug).
+

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


@@ -27,6 +35,16 @@ FILESETS
         ev.c
         ev_vars.h
         ev_wrap.h
         ev.c
         ev_vars.h
         ev_wrap.h

+        ev_win32.c
+
+        ev_select.c     only when select backend is enabled (which is 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.
+
+    LIBEVENT COMPATIBILITY API

 
     To include the libevent compatibility API, also include:
 
 
     To include the libevent compatibility API, also include:
 


@@ -57,6 +75,12 @@ PREPROCESSOR SYMBOLS
         will also not define any of the structs usually found in "event.h"
         that are not directly supported by libev code alone.
 
         will also not define any of the structs usually found in "event.h"
         that are not directly supported by libev code alone.
 

+    EV_H
+
+        The name of the ev.h header file used to include it. The default
+        if undefined is <ev.h> in event.h and "ev.h" in ev.c. This can be used
+        to virtually rename the ev.h header file
+

     EV_USE_MONOTONIC
 
         If undefined or defined to be "1", libev will try to detect the
     EV_USE_MONOTONIC
 
         If undefined or defined to be "1", libev will try to detect the


@@ -80,6 +104,15 @@ PREPROCESSOR SYMBOLS
        done: if no other method takes over, select will be it. Otherwise
        the select backend will not be compiled in.
 
        done: if no other method takes over, select will be it. Otherwise
        the select backend will not be compiled in.
 

+    EV_SELECT_USE_WIN32_HANDLES
+
+       When defined to 1, the select backend will assume that select
+       doesn't understand file descriptors but wants osf handles on
+       win32 (this is the case when the select to be used is the winsock
+       select). This means that it will call _get_osfhandle on the fd to
+       convert it to an OS handle. Should not be defined on non-win32
+       platforms.
+

     EV_USE_POLL
 
        If defined to be "1", libev will compile in support for the poll(2)
     EV_USE_POLL
 
        If defined to be "1", libev will compile in support for the poll(2)


@@ -114,7 +147,7 @@ PREPROCESSOR SYMBOLS
 
            #define EV_COMMON                       \
              SV *self; /* contains this struct */  \
 
            #define EV_COMMON                       \
              SV *self; /* contains this struct */  \

-             SV *cb_sv, *fh;
+             SV *cb_sv, *fh /* note no trailing ";" */

 
     EV_PROTOTYPES
 
 
     EV_PROTOTYPES
 


@@ -136,7 +169,7 @@ 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
     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.
+    the libev/ subdirectory and includes them in the EV/EVAPI.h (public
+    interface) and EV.xs (implementation) files. Only the EV.xs file will
+    be compiled.