*** empty log message ***

[software/libev.git] / ev.pod

diff --git a/ev.pod b/ev.pod
index 075d6727ca64754bbf0657c97dd052ff5a7efac0..81da7eac02530a176f5edfeae4d0e85fa83770d1 100644 (file)
--- a/ev.pod
+++ b/ev.pod
@@ -10,7 +10,7 @@ libev - a high performance full-featured event loop written in C
 
 Libev is an event loop: you register interest in certain events (such as a
 file descriptor being readable or a timeout occuring), and it will manage
 
 Libev is an event loop: you register interest in certain events (such as a
 file descriptor being readable or a timeout occuring), and it will manage

-these event sources and provide your program events.
+these event sources and provide your program with events.

 
 To do this, it must take more or less complete control over your process
 (or thread) by executing the I<event loop> handler, and will then
 
 To do this, it must take more or less complete control over your process
 (or thread) by executing the I<event loop> handler, and will then


@@ -27,13 +27,15 @@ Libev supports select, poll, the linux-specific epoll and the bsd-specific
 kqueue mechanisms for file descriptor events, relative timers, absolute
 timers with customised rescheduling, signal events, process status change
 events (related to SIGCHLD), and event watchers dealing with the event
 kqueue mechanisms for file descriptor events, relative timers, absolute
 timers with customised rescheduling, signal events, process status change
 events (related to SIGCHLD), and event watchers dealing with the event

-loop mechanism itself (idle, prepare and check watchers).
+loop mechanism itself (idle, prepare and check watchers). It also is quite
+fast (see this L<benchmark|http://libev.schmorp.de/bench.html> comparing
+it to libevent for example).

 
 =head1 CONVENTIONS
 
 Libev is very configurable. In this manual the default configuration
 will be described, which supports multiple event loops. For more info
 
 =head1 CONVENTIONS
 
 Libev is very configurable. In this manual the default configuration
 will be described, which supports multiple event loops. For more info

-about various configuraiton options please have a look at the file
+about various configuration options please have a look at the file

 F<README.embed> in the libev distribution. If libev was configured without
 support for multiple event loops, then all functions taking an initial
 argument of name C<loop> (which is always of type C<struct ev_loop *>)
 F<README.embed> in the libev distribution. If libev was configured without
 support for multiple event loops, then all functions taking an initial
 argument of name C<loop> (which is always of type C<struct ev_loop *>)


@@ -63,7 +65,7 @@ C<ev_version_minor>. If you want, you can compare against the global
 symbols C<EV_VERSION_MAJOR> and C<EV_VERSION_MINOR>, which specify the
 version of the library your program was compiled against.
 
 symbols C<EV_VERSION_MAJOR> and C<EV_VERSION_MINOR>, which specify the
 version of the library your program was compiled against.
 

-Usually, its a good idea to terminate if the major versions mismatch,
+Usually, it's a good idea to terminate if the major versions mismatch,

 as this indicates an incompatible change.  Minor versions are usually
 compatible to older versions, so a larger minor version alone is usually
 not a problem.
 as this indicates an incompatible change.  Minor versions are usually
 compatible to older versions, so a larger minor version alone is usually
 not a problem.


@@ -71,10 +73,10 @@ not a problem.
 =item ev_set_allocator (void *(*cb)(void *ptr, long size))
 
 Sets the allocation function to use (the prototype is similar to the
 =item ev_set_allocator (void *(*cb)(void *ptr, long size))
 
 Sets the allocation function to use (the prototype is similar to the

-realloc function). It is used to allocate and free memory (no surprises
-here). If it returns zero when memory needs to be allocated, the library
-might abort or take some potentially destructive action. The default is
-your system realloc function.
+realloc C function, the semantics are identical). It is used to allocate
+and free memory (no surprises here). If it returns zero when memory
+needs to be allocated, the library might abort or take some potentially
+destructive action. The default is your system realloc function.

 
 You could override this function in high-availability programs to, say,
 free some memory if it cannot allocate memory, to use a special allocator,
 
 You could override this function in high-availability programs to, say,
 free some memory if it cannot allocate memory, to use a special allocator,


@@ -86,7 +88,7 @@ Set the callback function to call on a retryable syscall error (such
 as failed select, poll, epoll_wait). The message is a printable string
 indicating the system call or subsystem causing the problem. If this
 callback is set, then libev will expect it to remedy the sitution, no
 as failed select, poll, epoll_wait). The message is a printable string
 indicating the system call or subsystem causing the problem. If this
 callback is set, then libev will expect it to remedy the sitution, no

-matter what, when it returns. That is, libev will geenrally retry the
+matter what, when it returns. That is, libev will generally retry the

 requested operation, or, if the condition doesn't go away, do bad stuff
 (such as abort).
 
 requested operation, or, if the condition doesn't go away, do bad stuff
 (such as abort).
 


@@ -100,9 +102,10 @@ events, and dynamically created loops which do not.
 
 If you use threads, a common model is to run the default event loop
 in your main thread (or in a separate thrad) and for each thread you
 
 If you use threads, a common model is to run the default event loop
 in your main thread (or in a separate thrad) and for each thread you

-create, you also create another event loop. Libev itself does no lockign
-whatsoever, so if you mix calls to different event loops, make sure you
-lock (this is usually a bad idea, though, even if done right).
+create, you also create another event loop. Libev itself does no locking
+whatsoever, so if you mix calls to the same event loop in different
+threads, make sure you lock (this is usually a bad idea, though, even if
+done correctly, because it's hideous and inefficient).

 
 =over 4
 
 
 =over 4
 


@@ -117,7 +120,7 @@ If you don't know what event loop to use, use the one returned from this
 function.
 
 The flags argument can be used to specify special behaviour or specific
 function.
 
 The flags argument can be used to specify special behaviour or specific

-backends to use, and is usually specified as 0 (or EVFLAG_AUTO)
+backends to use, and is usually specified as 0 (or EVFLAG_AUTO).

 
 It supports the following flags:
 
 
 It supports the following flags:
 


@@ -125,28 +128,29 @@ It supports the following flags:
 
 =item EVFLAG_AUTO
 
 
 =item EVFLAG_AUTO
 

-The default flags value. Use this if you have no clue (its the right
+The default flags value. Use this if you have no clue (it's the right

 thing, believe me).
 
 =item EVFLAG_NOENV
 
 thing, believe me).
 
 =item EVFLAG_NOENV
 

-If this flag bit is ored into the flag value then libev will I<not> look
-at the environment variable C<LIBEV_FLAGS>. Otherwise (the default), this
-environment variable will override the flags completely. This is useful
-to try out specific backends to tets their performance, or to work around
-bugs.
+If this flag bit is ored into the flag value (or the program runs setuid
+or setgid) then libev will I<not> look at the environment variable
+C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will
+override the flags completely if it is found in the environment. This is
+useful to try out specific backends to test their performance, or to work
+around bugs.

 
 

-=item EVMETHOD_SELECT  portable select backend
+=item EVMETHOD_SELECT  (portable select backend)

 
 

-=item EVMETHOD_POLL    poll backend (everywhere except windows)
+=item EVMETHOD_POLL    (poll backend, available everywhere except on windows)

 
 

-=item EVMETHOD_EPOLL   linux only
+=item EVMETHOD_EPOLL   (linux only)

 
 

-=item EVMETHOD_KQUEUE  some bsds only
+=item EVMETHOD_KQUEUE  (some bsds only)

 
 

-=item EVMETHOD_DEVPOLL solaris 8 only
+=item EVMETHOD_DEVPOLL (solaris 8 only)

 
 

-=item EVMETHOD_PORT    solaris 10 only
+=item EVMETHOD_PORT    (solaris 10 only)

 
 If one or more of these are ored into the flags value, then only these
 backends will be tried (in the reverse order as given here). If one are
 
 If one or more of these are ored into the flags value, then only these
 backends will be tried (in the reverse order as given here). If one are


@@ -165,7 +169,7 @@ undefined behaviour (or a failed assertion if assertions are enabled).
 
 Destroys the default loop again (frees all memory and kernel state
 etc.). This stops all registered event watchers (by not touching them in
 
 Destroys the default loop again (frees all memory and kernel state
 etc.). This stops all registered event watchers (by not touching them in

-any way whatsoever, although you cnanot rely on this :).
+any way whatsoever, although you cannot rely on this :).

 
 =item ev_loop_destroy (loop)
 
 
 =item ev_loop_destroy (loop)
 


@@ -183,7 +187,7 @@ You I<must> call this function after forking if and only if you want to
 use the event library in both processes. If you just fork+exec, you don't
 have to call it.
 
 use the event library in both processes. If you just fork+exec, you don't
 have to call it.
 

-The function itself is quite fast and its usually not a problem to call
+The function itself is quite fast and it's usually not a problem to call

 it just in case after a fork. To make this easy, the function will fit in
 quite nicely into a call to C<pthread_atfork>:
 
 it just in case after a fork. To make this easy, the function will fit in
 quite nicely into a call to C<pthread_atfork>:
 


@@ -200,7 +204,7 @@ after fork, and how you do this is entirely your own problem.
 Returns one of the C<EVMETHOD_*> flags indicating the event backend in
 use.
 
 Returns one of the C<EVMETHOD_*> flags indicating the event backend in
 use.
 

-=item ev_tstamp = ev_now (loop)
+=item ev_tstamp ev_now (loop)

 
 Returns the current "event loop time", which is the time the event loop
 got events and started processing them. This timestamp does not change
 
 Returns the current "event loop time", which is the time the event loop
 got events and started processing them. This timestamp does not change


@@ -219,11 +223,12 @@ no event watchers are active anymore or C<ev_unloop> was called.
 
 A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle
 those events and any outstanding ones, but will not block your process in
 
 A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle
 those events and any outstanding ones, but will not block your process in

-case there are no events.
+case there are no events and will return after one iteration of the loop.

 
 A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if
 neccessary) and will handle those and any outstanding ones. It will block
 
 A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if
 neccessary) and will handle those and any outstanding ones. It will block

-your process until at least one new event arrives.
+your process until at least one new event arrives, and will return after
+one iteration of the loop.

 
 This flags value could be used to implement alternative looping
 constructs, but the C<prepare> and C<check> watchers provide a better and
 
 This flags value could be used to implement alternative looping
 constructs, but the C<prepare> and C<check> watchers provide a better and


@@ -231,24 +236,25 @@ more generic mechanism.
 
 =item ev_unloop (loop, how)
 
 
 =item ev_unloop (loop, how)
 

-Can be used to make a call to C<ev_loop> return early. The C<how> argument
-must be either C<EVUNLOOP_ONCE>, which will make the innermost C<ev_loop>
-call return, or C<EVUNLOOP_ALL>, which will make all nested C<ev_loop>
-calls return.
+Can be used to make a call to C<ev_loop> return early (but only after it
+has processed all outstanding events). The C<how> argument must be either
+C<EVUNLOOP_ONCE>, which will make the innermost C<ev_loop> call return, or
+C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return.

 
 =item ev_ref (loop)
 
 =item ev_unref (loop)
 
 
 =item ev_ref (loop)
 
 =item ev_unref (loop)
 

-Ref/unref can be used to add or remove a refcount on the event loop: Every
-watcher keeps one reference. If you have a long-runing watcher you never
-unregister that should not keep ev_loop from running, ev_unref() after
-starting, and ev_ref() before stopping it. Libev itself uses this for
-example for its internal signal pipe: It is not visible to you as a user
-and should not keep C<ev_loop> from exiting if the work is done. It is
-also an excellent way to do this for generic recurring timers or from
-within third-party libraries. Just remember to unref after start and ref
-before stop.
+Ref/unref can be used to add or remove a reference count on the event
+loop: Every watcher keeps one reference, and as long as the reference
+count is nonzero, C<ev_loop> will not return on its own. If you have
+a watcher you never unregister that should not keep C<ev_loop> from
+returning, ev_unref() after starting, and ev_ref() before stopping it. For
+example, libev itself uses this for its internal signal pipe: It is not
+visible to the libev user and should not keep C<ev_loop> from exiting if
+no event watchers registered by it are active. It is also an excellent
+way to do this for generic recurring timers or from within third-party
+libraries. Just remember to I<unref after start> and I<ref before stop>.

 
 =back
 
 
 =back
 


@@ -295,8 +301,8 @@ As long as your watcher is active (has been started but not stopped) you
 must not touch the values stored in it. Most specifically you must never
 reinitialise it or call its set method.
 
 must not touch the values stored in it. Most specifically you must never
 reinitialise it or call its set method.
 

-You cna check wether an event is active by calling the C<ev_is_active
-(watcher *)> macro. To see wether an event is outstanding (but the
+You cna check whether an event is active by calling the C<ev_is_active
+(watcher *)> macro. To see whether an event is outstanding (but the

 callback for it has not been called yet) you cna use the C<ev_is_pending
 (watcher *)> macro.
 
 callback for it has not been called yet) you cna use the C<ev_is_pending
 (watcher *)> macro.
 


@@ -402,12 +408,26 @@ information given in the last section.
 
 =head2 struct ev_io - is my file descriptor readable or writable
 
 
 =head2 struct ev_io - is my file descriptor readable or writable
 

-I/O watchers check wether a file descriptor is readable or writable
+I/O watchers check whether a file descriptor is readable or writable

 in each iteration of the event loop (This behaviour is called
 level-triggering because you keep receiving events as long as the
 condition persists. Remember you cna stop the watcher if you don't want to
 act on the event and neither want to receive future events).
 
 in each iteration of the event loop (This behaviour is called
 level-triggering because you keep receiving events as long as the
 condition persists. Remember you cna 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
+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).
+
+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.
+
+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
+EVMETHOD_POLL).
+

 =over 4
 
 =item ev_io_init (ev_io *, callback, int fd, int events)
 =over 4
 
 =item ev_io_init (ev_io *, callback, int fd, int events)


@@ -431,6 +451,14 @@ time, it will still time out after (roughly) and hour. "Roughly" because
 detecting time jumps is hard, and soem inaccuracies are unavoidable (the
 monotonic clock option helps a lot here).
 
 detecting time jumps is hard, and soem inaccuracies are unavoidable (the
 monotonic clock option helps a lot here).
 

+The relative timeouts are calculated relative to the C<ev_now ()>
+time. This is usually the right thing as this timestamp refers to the time
+of the event triggering whatever timeout you are modifying/starting.  If
+you suspect event processing to be delayed and you *need* to base the timeout
+ion the current time, use something like this to adjust for this:
+
+   ev_timer_set (&timer, after + ev_now () - ev_time (), 0.);
+

 =over 4
 
 =item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
 =over 4
 
 =item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)


@@ -569,7 +597,7 @@ program when the crontabs have changed).
 
 Signal watchers will trigger an event when the process receives a specific
 signal one or more times. Even though signals are very asynchronous, libev
 
 Signal watchers will trigger an event when the process receives a specific
 signal one or more times. Even though signals are very asynchronous, libev

-will try its best to deliver signals synchronously, i.e. as part of the
+will try it's best to deliver signals synchronously, i.e. as part of the

 normal event processing, like any other event.
 
 You cna configure as many watchers as you like per signal. Only when the
 normal event processing, like any other event.
 
 You cna configure as many watchers as you like per signal. Only when the