*** empty log message ***

[software/libev.git] / README.embed

diff --git a/README.embed b/README.embed
index caf11451912beecc7d5e58a2198655af40683969..815e8b44a24044d9506352415664ec0a7c475c01 100644 (file)
--- a/README.embed
+++ b/README.embed
@@ -1,6 +1,6 @@
 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.
 
@@ -17,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
-    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"
 
+    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):
 
@@ -31,7 +37,7 @@ FILESETS
         ev_wrap.h
         ev_win32.c
 
-        ev_select.c     only when select backend is enabled (which is by default)
+        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)
@@ -92,6 +98,15 @@ PREPROCESSOR SYMBOLS
        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)
@@ -115,6 +130,18 @@ PREPROCESSOR SYMBOLS
        will be detected at runtime and routed around by disabling this
        backend.
 
+    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 in case of
+        conflicts.
+
+    EV_EVENT_H
+
+        Similarly to EV_H, this macro cna be used to override event.c's idea
+        of how the event.h header can be found.
+
     EV_COMMON
  
        By default, all watchers have a "void *data" member. By redefining
@@ -126,7 +153,7 @@ PREPROCESSOR SYMBOLS
 
            #define EV_COMMON                       \
              SV *self; /* contains this struct */  \
-             SV *cb_sv, *fh;
+             SV *cb_sv, *fh /* note no trailing ";" */
 
     EV_PROTOTYPES
 
@@ -143,6 +170,18 @@ PREPROCESSOR SYMBOLS
        event loop pointer argument. Instead, all functions act on the
        single default loop.
 
+    EV_CB_DECLARE(type)
+    EV_CB_INVOKE(watcher,revents)
+    ev_set_cb(ev,cb)
+
+       Can be used to change the callback member declaration in each
+       watcher, and the way callbacks are invoked and set. Must expand
+       to a struct member definition and a statement, respectively. See
+       the ev.v header file for their default definitions. One possible
+       use for overriding these is to avoid the ev_loop pointer as first
+       argument in all cases, or to use method calls instead of plain
+       function calls in C++.
+
 EXAMPLES
 
     For a real-world example of a program the includes libev