From d62943221d916737d52e83db662e6a1e2f92db0a Mon Sep 17 00:00:00 2001 From: root Date: Tue, 27 Nov 2007 20:38:07 +0000 Subject: *** empty log message *** --- ev.html | 72 +++++++++++++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 50 insertions(+), 22 deletions(-) (limited to 'ev.html') diff --git a/ev.html b/ev.html index 011cda6..a107da8 100644 --- a/ev.html +++ b/ev.html @@ -6,7 +6,7 @@ - + @@ -62,19 +62,19 @@

-

NAME

+

NAME

libev - a high performance full-featured event loop written in C

-

SYNOPSIS

+

SYNOPSIS

  #include <ev.h>

-

EXAMPLE PROGRAM

+

EXAMPLE PROGRAM

  #include <ev.h>
 
@@ -119,7 +119,7 @@

-

DESCRIPTION

+

DESCRIPTION

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 @@ -133,7 +133,7 @@ details of the event, and then hand it over to libev by starting the watcher.

-

FEATURES

+

FEATURES

Libev supports select, poll, the linux-specific epoll, the bsd-specific kqueue and the solaris-specific event port mechanisms @@ -149,7 +149,7 @@ file watchers (ev_stat) and even limited support for fork events for example).

-

CONVENTIONS

+

CONVENTIONS

Libev is very configurable. In this manual the default configuration will be described, which supports multiple event loops. For more info about @@ -159,7 +159,7 @@ loops, then all functions taking an initial argument of name loop (which is always of type struct ev_loop *) will not have this argument.

-

TIME REPRESENTATION

+

TIME REPRESENTATION

Libev represents time as a single floating point number, representing the (fractional) number of seconds since the (POSIX) epoch (somewhere near @@ -169,7 +169,7 @@ to the double type in C, and when you need to do any calculations o it, you should treat it as such.

-

GLOBAL FUNCTIONS

+

GLOBAL FUNCTIONS

These functions can be called anytime, even before initialising the library in any way.

@@ -287,7 +287,7 @@ requested operation, or, if the condition doesn't go away, do bad stuff

-

FUNCTIONS CONTROLLING THE EVENT LOOP

+

FUNCTIONS CONTROLLING THE EVENT LOOP

An event loop is described by a struct ev_loop *. The library knows two types of such loops, the default loop, which supports signals and child @@ -570,7 +570,7 @@ running when nothing else is active.

-

ANATOMY OF A WATCHER

+

ANATOMY OF A WATCHER

A watcher is a structure that you create and register to record your interest in some event. For instance, if you want to wait for STDIN to @@ -743,7 +743,7 @@ is pending (but not active) you must not call an init function on it (but ev_TYPE_set is safe) and you must make sure the watcher is available to libev (e.g. you cnanot free () it).

-

callback = ev_cb (ev_TYPE *watcher)

+

callback ev_cb (ev_TYPE *watcher)

Returns the callback currently set on the watcher.

@@ -785,15 +785,43 @@ can cast it back to your own type:

} -

More interesting and less C-conformant ways of catsing your callback type -have been omitted....

+

More interesting and less C-conformant ways of casting your callback type +instead have been omitted.

+

Another common scenario is having some data structure with multiple +watchers:

+

  struct my_biggy
+  {
+    int some_data;
+    ev_timer t1;
+    ev_timer t2;
+  }
 
+

+

In this case getting the pointer to my_biggy is a bit more complicated, +you need to use offsetof:

+

  #include <stddef.h>
 
+  static void
+  t1_cb (EV_P_ struct ev_timer *w, int revents)
+  {
+    struct my_biggy big = (struct my_biggy *
+      (((char *)w) - offsetof (struct my_biggy, t1));
+  }
+
+  static void
+  t2_cb (EV_P_ struct ev_timer *w, int revents)
+  {
+    struct my_biggy big = (struct my_biggy *
+      (((char *)w) - offsetof (struct my_biggy, t2));
+  }
 
 
 
+
+

+

-

WATCHER TYPES

+

WATCHER TYPES

This section describes each watcher in detail, but will not repeat information given in the last section. Any initialisation/set macros, @@ -1562,7 +1590,7 @@ believe me.

-

OTHER FUNCTIONS

+

OTHER FUNCTIONS

There are some other functions of possible interest. Described. Here. Now.

@@ -1619,7 +1647,7 @@ loop!).

-

LIBEVENT EMULATION

+

LIBEVENT EMULATION

Libev offers a compatibility emulation layer for libevent. It cannot emulate the internals of libevent, so here are some usage hints:

@@ -1639,7 +1667,7 @@ to use the libev header file and library.

-

C++ SUPPORT

+

C++ SUPPORT

Libev comes with some simplistic wrapper classes for C++ that mainly allow you to use some convinience methods to start/stop watchers and also change @@ -1744,7 +1772,7 @@ the constructor.

-

MACRO MAGIC

+

MACRO MAGIC

Libev can be compiled with a variety of options, the most fundemantal is EV_MULTIPLICITY. This option determines wether (most) functions and @@ -1805,7 +1833,7 @@ wether multiple loops are supported or not.

-

EMBEDDING

+

EMBEDDING

Libev can (and often is) directly embedded into host applications. Examples of applications that embed it include the Deliantra @@ -2109,7 +2137,7 @@ that everybody includes and which overrides some autoconf choices:

-

COMPLEXITIES

+

COMPLEXITIES

In this section the complexities of (many of) the algorithms used inside libev will be explained. For complexity discussions about backends see the @@ -2132,7 +2160,7 @@ documentation for ev_default_init.

-

AUTHOR

+

AUTHOR

Marc Lehmann <libev@schmorp.de>.

-- cgit v1.2.3