renamed METHODs to BACKENDs

[software/libev.git] / README.embed

diff --git a/README.embed b/README.embed
index ef8fb3e4fde71a101626c25f6a36148996239b04..b80a23a92af9f1a8c2773b27b66f7614aeb9f6c9 100644 (file)
--- a/README.embed
+++ b/README.embed
@@ -35,12 +35,14 @@ FILESETS
         ev.c
         ev_vars.h
         ev_wrap.h
         ev.c
         ev_vars.h
         ev_wrap.h

-        ev_win32.c
+
+        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_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_port.c       only when the solaris port backend is enabled (disabled by default)

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


@@ -64,7 +66,7 @@ FILESETS
 AUTOCONF SUPPORT
 
     Instead of using EV_STANDALONE=1 and providing your config in whatever
 AUTOCONF SUPPORT
 
     Instead of using EV_STANDALONE=1 and providing your config in whatever

-    way you want, you can also m4_include([ev.m4]) in your configure.ac
+    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.
 
     and leave EV_STANDALONE off. ev.c will then include "config.h" and
     configure itself accordingly.
 


@@ -84,10 +86,12 @@ PREPROCESSOR SYMBOLS
 
     EV_USE_MONOTONIC
 
 
     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
+        If 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
         runtime. Otherwise no use of the monotonic clock option will be

-        attempted.
+        attempted. If you enable this, you usually have to link against
+        librt or something similar. Enabling it when the functionality
+        isn't available is safe, though.

 
     EV_USE_REALTIME
 
 
     EV_USE_REALTIME
 


@@ -105,21 +109,31 @@ 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
+    EV_SELECT_USE_FD_SET
+
+       If defined to 1, then the select backend will use the system fd_set
+       structure. This is useful if libev doesn't compile due to a missing
+       NFDBITS or fd_mask definition or it misguesses the bitset layout on
+       exotic systems. This usually limits the range of file descriptors
+       to some low limit such as 1024 or might have other limitations
+       (winsocket only allows 64 sockets). The FD_SETSIZE macro, set
+       before compilation, might influence the size of the fd_set used.

 
 

-       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_SELECT_IS_WINSOCKET
+
+       When defined to 1, the select backend will assume that
+       select/socket/connect etc. don'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. Otherwise,
+       it is assumed that all these functions actually work on fds, even
+       on win32. 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)

-       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).
+       backend. Otherwise it will be enabled on non-win32 platforms. It
+       takes precedence over select.

 
     EV_USE_EPOLL
 
 
     EV_USE_EPOLL
 


@@ -133,10 +147,21 @@ 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_USE_PORT
+
+       If defined to be "1", libev will compile in support for the Solaris
+       10 port style backend. Its availability will be detected at runtime,
+       otherwise another method will be used as fallback. This is the
+       preferred backend for Solaris 10 systems.
+
+    EV_USE_DEVPOLL
+    
+       reserved for future expansion, works like the USE symbols above.
+

     EV_H
 
         The name of the ev.h header file used to include it. The default
     EV_H
 
         The name of the ev.h header file used to include it. The default


@@ -149,19 +174,6 @@ PREPROCESSOR SYMBOLS
         Similarly to EV_H, this macro cna be used to override event.c's idea
         of how the event.h header can be found.
 
         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
-       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_PROTOTYPES
 
        If defined to be "0", then "ev.h" will not define any function
     EV_PROTOTYPES
 
        If defined to be "0", then "ev.h" will not define any function


@@ -177,6 +189,24 @@ 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)
     EV_CB_DECLARE(type)
     EV_CB_INVOKE(watcher,revents)
     ev_set_cb(ev,cb)