*** empty log message ***

[software/libev.git] / ev.pod

diff --git a/ev.pod b/ev.pod
index c162b216f66b3d563389785ddc096ccc41c17139..616fea2eb2a534d430f188b51fc1db0efc35b841 100644 (file)
--- a/ev.pod
+++ b/ev.pod
@@ -419,7 +419,7 @@ level-triggering because you keep receiving events as long as the
 condition persists. Remember you can stop the watcher if you don't want to
 act on the event and neither want to receive future events).
 
 condition persists. Remember you can stop the watcher if you don't want to
 act on the event and neither want to receive future events).
 

-In general you can register as many read and/or write event watchers oer
+In general you can register as many read and/or write event watchers per

 fd as you want (as long as you don't confuse yourself). Setting all file
 descriptors to non-blocking mode is also usually a good idea (but not
 required if you know what you are doing).
 fd as you want (as long as you don't confuse yourself). Setting all file
 descriptors to non-blocking mode is also usually a good idea (but not
 required if you know what you are doing).


@@ -427,8 +427,8 @@ required if you know what you are doing).
 You have to be careful with dup'ed file descriptors, though. Some backends
 (the linux epoll backend is a notable example) cannot handle dup'ed file
 descriptors correctly if you register interest in two or more fds pointing
 You have to be careful with dup'ed file descriptors, though. Some backends
 (the linux epoll backend is a notable example) cannot handle dup'ed file
 descriptors correctly if you register interest in two or more fds pointing

-to the same file/socket etc. description (that is, they share the same
-underlying "file open").
+to the same underlying file/socket etc. description (that is, they share
+the same underlying "file open").

 
 If you must do this, then force the use of a known-to-be-good backend
 (at the time of this writing, this includes only EVMETHOD_SELECT and
 
 If you must do this, then force the use of a known-to-be-good backend
 (at the time of this writing, this includes only EVMETHOD_SELECT and


@@ -774,7 +774,30 @@ Feed an event as if the given signal occured (loop must be the default loop!).
 
 =head1 LIBEVENT EMULATION
 
 
 =head1 LIBEVENT EMULATION
 

-TBD.
+Libev offers a compatibility emulation layer for libevent. It cannot
+emulate the internals of libevent, so here are some usage hints:
+
+=over 4
+
+=item * Use it by including <event.h>, as usual.
+
+=item * The following members are fully supported: ev_base, ev_callback,
+ev_arg, ev_fd, ev_res, ev_events.
+
+=item * Avoid using ev_flags and the EVLIST_*-macros, while it is
+maintained by libev, it does not work exactly the same way as in libevent (consider
+it a private API).
+
+=item * Priorities are not currently supported. Initialising priorities
+will fail and all watchers will have the same priority, even though there
+is an ev_pri field.
+
+=item * Other members are not supported.
+
+=item * The libev emulation is I<not> ABI compatible to libevent, you need
+to use the libev header file and library.
+
+=back

 
 =head1 C++ SUPPORT
 
 
 =head1 C++ SUPPORT