rewrite seletc backend, port again to msvc

[software/libev.git] / README.embed

diff --git a/README.embed b/README.embed
index b6322d9ef01bdcc448760ebf470d44884cbf7907..d168cc51654d16dc60bb448de2366e890128e582 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):
 


@@ -28,6 +36,17 @@ FILESETS
         ev_vars.h
         ev_wrap.h
 
         ev_vars.h
         ev_wrap.h
 

+        ev_win32.c      required on win32 platforms only
+
+        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:
 
         #include "event.c"
     To include the libevent compatibility API, also include:
 
         #include "event.c"


@@ -43,10 +62,17 @@ FILESETS
         event.h
         event.c
 
         event.h
         event.c
 

+AUTOCONF SUPPORT
+
+    Instead of using EV_STANDALONE=1 and providing your config in whatever
+    way you want, you can also m4_include([libev.m4]) in your configure.ac
+    and leave EV_STANDALONE off. ev.c will then include "config.h" and
+    configure itself accordingly.
+

 PREPROCESSOR SYMBOLS
 
     Libev can be configured via a variety of preprocessor symbols you have to define
 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
+    before including any of its files. The default is not to build for multiplicity

     and only include the select backend.
 
     EV_STANDALONE
     and only include the select backend.
 
     EV_STANDALONE


@@ -80,6 +106,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)


@@ -99,22 +134,26 @@ PREPROCESSOR SYMBOLS
        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
        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
+       preferred backend for BSD and BSD-like systems. Darwin brokenness

        will be detected at runtime and routed around by disabling this
        backend.
 
        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.
+    EV_USE_DEVPOLL
+    EV_USE_PORTS
+    
+       reserved for future expansion, works like the USE symbols above.

 
 

-       For example, the perl EV module uses this:
+    EV_H

 
 

-           #define EV_COMMON                       \
-             SV *self; /* contains this struct */  \
-             SV *cb_sv, *fh;
+        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_PROTOTYPES
 
 
     EV_PROTOTYPES
 


@@ -131,12 +170,42 @@ PREPROCESSOR SYMBOLS
        event loop pointer argument. Instead, all functions act on the
        single default loop.
 
        event loop pointer argument. Instead, all functions act on the
        single default loop.
 

+    EV_PERIODICS
+
+       If undefined or defined to be "1", then periodic timers are
+       supported, otherwise not. This saves a few kb of code.
+
+    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 /* note no trailing ";" */
+
+    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
     verbatim, you can have a look at the EV perl module
     (http://software.schmorp.de/pkg/EV.html).  It has the libev files in
 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.
+    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.