--- libev/ev.html 2007/11/24 16:31:45 1.43 +++ libev/ev.html 2007/11/28 18:29:29 1.60 @@ -6,7 +6,7 @@ - + @@ -16,6 +16,7 @@
  • OTHER FUNCTIONS
  • LIBEVENT EMULATION
  • C++ SUPPORT
  • +
  • MACRO MAGIC
  • EMBEDDING
    -

    NAME

    Top

    +

    NAME

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

    -

    SYNOPSIS

    Top

    +

    SYNOPSIS

      #include <ev.h>
     
     
    -

    DESCRIPTION

    Top

    +

    EXAMPLE PROGRAM

    +
    +
      #include <ev.h>
    +
    +  ev_io stdin_watcher;
    +  ev_timer timeout_watcher;
    +
    +  /* called when data readable on stdin */
    +  static void
    +  stdin_cb (EV_P_ struct ev_io *w, int revents)
    +  {
    +    /* puts ("stdin ready"); */
    +    ev_io_stop (EV_A_ w); /* just a syntax example */
    +    ev_unloop (EV_A_ EVUNLOOP_ALL); /* leave all loop calls */
    +  }
    +
    +  static void
    +  timeout_cb (EV_P_ struct ev_timer *w, int revents)
    +  {
    +    /* puts ("timeout"); */
    +    ev_unloop (EV_A_ EVUNLOOP_ONE); /* leave one loop call */
    +  }
    +
    +  int
    +  main (void)
    +  {
    +    struct ev_loop *loop = ev_default_loop (0);
    +
    +    /* initialise an io watcher, then start it */
    +    ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);
    +    ev_io_start (loop, &stdin_watcher);
    +
    +    /* simple non-repeating 5.5 second timeout */
    +    ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
    +    ev_timer_start (loop, &timeout_watcher);
    +
    +    /* loop till timeout or data ready */
    +    ev_loop (loop, 0);
    +
    +    return 0;
    +  }
    +
    +
    + +
    +

    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 @@ -83,29 +133,34 @@ watcher.

    -

    FEATURES

    Top

    +

    FEATURES

    -

    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 -loop mechanism itself (idle, prepare and check watchers). It also is quite -fast (see this benchmark comparing -it to libevent for example).

    +

    Libev supports select, poll, the Linux-specific epoll, the +BSD-specific kqueue and the Solaris-specific event port mechanisms +for file descriptor events (ev_io), the Linux inotify interface +(for ev_stat), relative timers (ev_timer), absolute timers +with customised rescheduling (ev_periodic), synchronous signals +(ev_signal), process status change events (ev_child), and event +watchers dealing with the event loop mechanism itself (ev_idle, +ev_embed, ev_prepare and ev_check watchers) as well as +file watchers (ev_stat) and even limited support for fork events +(ev_fork).

    +

    It also is quite fast (see this +benchmark comparing it to libevent +for example).

    -

    CONVENTIONS

    Top

    +

    CONVENTIONS

    -

    Libev is very configurable. In this manual the default configuration -will be described, which supports multiple event loops. For more info -about various configuration options please have a look at the file -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 loop (which is always of type struct ev_loop *) -will not have this argument.

    +

    Libev is very configurable. In this manual the default configuration will +be described, which supports multiple event loops. For more info about +various configuration options please have a look at EMBED section in +this manual. If libev was configured without support for multiple event +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

    Top

    +

    TIME REPRESENTATION

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

    - - - -
    -

    GLOBAL FUNCTIONS

    Top

    +

    GLOBAL FUNCTIONS

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

    @@ -142,8 +193,8 @@ 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.

    -

    Example: make sure we haven't accidentally been linked against the wrong -version:

    +

    Example: Make sure we haven't accidentally been linked against the wrong +version.

      assert (("libev version mismatch",
                ev_version_major () == EV_VERSION_MAJOR
                && ev_version_minor () >= EV_VERSION_MINOR));
    @@ -183,18 +234,19 @@
     	
     	
    ev_set_allocator (void *(*cb)(void *ptr, long size))
    -

    Sets the allocation function to use (the prototype is similar to the -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.

    +

    Sets the allocation function to use (the prototype is similar - the +semantics is identical - to the realloc C 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.

    You could override this function in high-availability programs to, say, free some memory if it cannot allocate memory, to use a special allocator, or even to sleep a while and retry until some memory is available.

    -

    Example: replace the libev allocator with one that waits a bit and then -retries: better than mine).

    +

    Example: Replace the libev allocator with one that waits a bit and then +retries).

       static void *
    -   persistent_realloc (void *ptr, long size)
    +   persistent_realloc (void *ptr, size_t size)
        {
          for (;;)
            {
    @@ -221,7 +273,7 @@
     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).

    -

    Example: do the same thing as libev does internally:

    +

    Example: This is basically the same thing that libev does internally, too.

       static void
        fatal_error (const char *msg)
        {
    @@ -237,7 +289,7 @@
     
     
     
    -

    FUNCTIONS CONTROLLING THE EVENT LOOP

    Top

    +

    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 @@ -367,7 +419,7 @@ always distinct from the default loop. Unlike the default loop, it cannot handle signal and child watchers, and attempts to do so will be greeted by undefined behaviour (or a failed assertion if assertions are enabled).

    -

    Example: try to create a event loop that uses epoll and nothing else.

    +

    Example: Try to create a event loop that uses epoll and nothing else.

      struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
       if (!epoller)
         fatal ("no epoll found here, maybe it hides under your chair");
    @@ -470,7 +522,7 @@
          were used, return, otherwise continue with step *.
     
     
    -

    Example: queue some jobs and then loop until no events are outsanding +

    Example: Queue some jobs and then loop until no events are outsanding anymore.

       ... queue jobs here, make sure they register event watchers as long
        ... as they still have work to do (even an idle watcher will do..)
    @@ -499,17 +551,17 @@
     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 unref after start and ref before stop.

    -

    Example: create a signal watcher, but keep it from keeping ev_loop +

    Example: Create a signal watcher, but keep it from keeping ev_loop running when nothing else is active.

    -
      struct dv_signal exitsig;
    +
      struct ev_signal exitsig;
       ev_signal_init (&exitsig, sig_cb, SIGINT);
    -  ev_signal_start (myloop, &exitsig);
    -  evf_unref (myloop);
    +  ev_signal_start (loop, &exitsig);
    +  evf_unref (loop);
     
     
    -

    Example: for some weird reason, unregister the above signal handler again.

    -
      ev_ref (myloop);
    -  ev_signal_stop (myloop, &exitsig);
    +		

    Example: For some weird reason, unregister the above signal handler again.

    +
      ev_ref (loop);
    +  ev_signal_stop (loop, &exitsig);
     
     
    @@ -520,7 +572,7 @@
    -

    ANATOMY OF A WATCHER

    Top

    +

    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 @@ -587,6 +639,10 @@

    The pid specified in the ev_child watcher has received a status change.

    +
    EV_STAT
    +
    +

    The path specified in the ev_stat watcher changed its attributes somehow.

    +
    EV_IDLE

    The ev_idle watcher has determined that you have nothing better to do.

    @@ -602,6 +658,15 @@ (for example, a ev_prepare watcher might start an idle watcher to keep ev_loop from blocking).

    +
    EV_EMBED
    +
    +

    The embedded event loop specified in the ev_embed watcher needs attention.

    +
    +
    EV_FORK
    +
    +

    The event loop has been resumed in the child process after fork (see +ev_fork).

    +
    EV_ERROR

    An unspecified error has occured, the watcher has been stopped. This might @@ -680,7 +745,7 @@ 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.

    @@ -722,18 +787,55 @@ } -

    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

    Top

    +

    WATCHER TYPES

    This section describes each watcher in detail, but will not repeat -information given in the last section.

    +information given in the last section. Any initialisation/set macros, +functions and members specific to the watcher type are explained.

    +

    Members are additionally marked with either [read-only], meaning that, +while the watcher is active, you can look at the member and expect some +sensible content, but you must not modify it (you can modify it while the +watcher is stopped to your hearts content), or [read-write], which +means you can expect it to have some sensible content while the watcher +is active, but you can also modify it. Modifying it may not do something +sensible or take immediate effect (or do anything at all), but libev will +not crash or malfunction in any way.

    @@ -782,10 +884,18 @@ rceeive events for and events is either EV_READ, EV_WRITE or EV_READ | EV_WRITE to receive the given events.

    +
    int fd [read-only]
    +
    +

    The file descriptor being watched.

    +
    +
    int events [read-only]
    +
    +

    The events being watched.

    +
    -

    Example: call stdin_readable_cb when STDIN_FILENO has become, well +

    Example: Call stdin_readable_cb when STDIN_FILENO has become, well readable, but only once. Since it is likely line-buffered, you could -attempt to read a whole line in the callback:

    +attempt to read a whole line in the callback.

      static void
       stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents)
       {
    @@ -848,16 +958,37 @@
     		

    If the timer is repeating, either start it if necessary (with the repeat value), or reset the running timer to the repeat value.

    This sounds a bit complicated, but here is a useful and typical -example: Imagine you have a tcp connection and you want a so-called idle -timeout, that is, you want to be called when there have been, say, 60 -seconds of inactivity on the socket. The easiest way to do this is to -configure an ev_timer with after=repeat=60 and calling ev_timer_again each -time you successfully read or write some data. If you go into an idle -state where you do not expect data to travel on the socket, you can stop -the timer, and again will automatically restart it if need be.

    +example: Imagine you have a tcp connection and you want a so-called +idle timeout, that is, you want to be called when there have been, +say, 60 seconds of inactivity on the socket. The easiest way to do +this is to configure an ev_timer with after=repeat=60 and calling +ev_timer_again each time you successfully read or write some data. If +you go into an idle state where you do not expect data to travel on the +socket, you can stop the timer, and again will automatically restart it if +need be.

    +

    You can also ignore the after value and ev_timer_start altogether +and only ever use the repeat value:

    +
       ev_timer_init (timer, callback, 0., 5.);
    +   ev_timer_again (loop, timer);
    +   ...
    +   timer->again = 17.;
    +   ev_timer_again (loop, timer);
    +   ...
    +   timer->again = 10.;
    +   ev_timer_again (loop, timer);
    +
    +
    +

    This is more efficient then stopping/starting the timer eahc time you want +to modify its timeout value.

    + +
    ev_tstamp repeat [read-write]
    +
    +

    The current repeat value. Will be used each time the watcher times out +or ev_timer_again is called and determines the next timeout (if any), +which is also when any modifications are taken into account.

    -

    Example: create a timer that fires after 60 seconds.

    +

    Example: Create a timer that fires after 60 seconds.

      static void
       one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents)
       {
    @@ -869,7 +1000,7 @@
       ev_timer_start (loop, &mytimer);
     
     
    -

    Example: create a timeout timer that times out after 10 seconds of +

    Example: Create a timeout timer that times out after 10 seconds of inactivity.

      static void
       timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents)
    @@ -982,8 +1113,20 @@
     a different time than the last time it was called (e.g. in a crond like
     program when the crontabs have changed).

    +
    ev_tstamp interval [read-write]
    +
    +

    The current interval value. Can be modified any time, but changes only +take effect when the periodic timer fires or ev_periodic_again is being +called.

    +
    +
    ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read-write]
    +
    +

    The current reschedule callback, or 0, if this functionality is +switched off. Can be changed any time, but changes only take effect when +the periodic timer fires or ev_periodic_again is being called.

    +
    -

    Example: call a callback every hour, or, more precisely, whenever the +

    Example: Call a callback every hour, or, more precisely, whenever the system clock is divisible by 3600. The callback invocation times have potentially a lot of jittering, but good long-term stability.

      static void
    @@ -997,7 +1140,7 @@
       ev_periodic_start (loop, &hourly_tick);
     
     
    -

    Example: the same as above, but use a reschedule callback to do it:

    +

    Example: The same as above, but use a reschedule callback to do it:

      #include <math.h>
     
       static ev_tstamp
    @@ -1009,7 +1152,7 @@
       ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);
     
     
    -

    Example: call a callback every hour, starting now:

    +

    Example: Call a callback every hour, starting now:

      struct ev_periodic hourly_tick;
       ev_periodic_init (&hourly_tick, clock_cb,
                         fmod (ev_now (loop), 3600.), 3600., 0);
    @@ -1040,6 +1183,10 @@
     		

    Configures the watcher to trigger on the given signal number (usually one of the SIGxxx constants).

    +
    int signum [read-only]
    +
    +

    The signal the watcher watches out for.

    +
    @@ -1062,8 +1209,21 @@ waitpid documentation). The rpid member contains the pid of the process causing the status change.

    +
    int pid [read-only]
    +
    +

    The process id this watcher watches out for, or 0, meaning any process id.

    +
    +
    int rpid [read-write]
    +
    +

    The process id that detected a status change.

    +
    +
    int rstatus [read-write]
    +
    +

    The process exit/trace status caused by rpid (see your systems +waitpid and sys/wait.h documentation for details).

    +
    -

    Example: try to exit cleanly on SIGINT and SIGTERM.

    +

    Example: Try to exit cleanly on SIGINT and SIGTERM.

      static void
       sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)
       {
    @@ -1080,6 +1240,106 @@
     
    +

    ev_stat - did the file attributes just change?

    +
    +

    This watches a filesystem path for attribute changes. That is, it calls +stat regularly (or when the OS says it changed) and sees if it changed +compared to the last time, invoking the callback if it did.

    +

    The path does not need to exist: changing from "path exists" to "path does +not exist" is a status change like any other. The condition "path does +not exist" is signified by the st_nlink field being zero (which is +otherwise always forced to be at least one) and all the other fields of +the stat buffer having unspecified contents.

    +

    The path should be absolute and must not end in a slash. If it is +relative and your working directory changes, the behaviour is undefined.

    +

    Since there is no standard to do this, the portable implementation simply +calls stat (2) regularly on the path to see if it changed somehow. You +can specify a recommended polling interval for this case. If you specify +a polling interval of 0 (highly recommended!) then a suitable, +unspecified default value will be used (which you can expect to be around +five seconds, although this might change dynamically). Libev will also +impose a minimum interval which is currently around 0.1, but thats +usually overkill.

    +

    This watcher type is not meant for massive numbers of stat watchers, +as even with OS-supported change notifications, this can be +resource-intensive.

    +

    At the time of this writing, only the Linux inotify interface is +implemented (implementing kqueue support is left as an exercise for the +reader). Inotify will be used to give hints only and should not change the +semantics of ev_stat watchers, which means that libev sometimes needs +to fall back to regular polling again even with inotify, but changes are +usually detected immediately, and if the file exists there will be no +polling.

    +
    +
    ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)
    +
    ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)
    +
    +

    Configures the watcher to wait for status changes of the given +path. The interval is a hint on how quickly a change is expected to +be detected and should normally be specified as 0 to let libev choose +a suitable value. The memory pointed to by path must point to the same +path for as long as the watcher is active.

    +

    The callback will be receive EV_STAT when a change was detected, +relative to the attributes at the time the watcher was started (or the +last change was detected).

    +
    +
    ev_stat_stat (ev_stat *)
    +
    +

    Updates the stat buffer immediately with new values. If you change the +watched path in your callback, you could call this fucntion to avoid +detecting this change (while introducing a race condition). Can also be +useful simply to find out the new values.

    +
    +
    ev_statdata attr [read-only]
    +
    +

    The most-recently detected attributes of the file. Although the type is of +ev_statdata, this is usually the (or one of the) struct stat types +suitable for your system. If the st_nlink member is 0, then there +was some error while stating the file.

    +
    +
    ev_statdata prev [read-only]
    +
    +

    The previous attributes of the file. The callback gets invoked whenever +prev != attr.

    +
    +
    ev_tstamp interval [read-only]
    +
    +

    The specified interval.

    +
    +
    const char *path [read-only]
    +
    +

    The filesystem path that is being watched.

    +
    +
    +

    Example: Watch /etc/passwd for attribute changes.

    +
      static void
    +  passwd_cb (struct ev_loop *loop, ev_stat *w, int revents)
    +  {
    +    /* /etc/passwd changed in some way */
    +    if (w->attr.st_nlink)
    +      {
    +        printf ("passwd current size  %ld\n", (long)w->attr.st_size);
    +        printf ("passwd current atime %ld\n", (long)w->attr.st_mtime);
    +        printf ("passwd current mtime %ld\n", (long)w->attr.st_mtime);
    +      }
    +    else
    +      /* you shalt not abuse printf for puts */
    +      puts ("wow, /etc/passwd is not there, expect problems. "
    +            "if this is windows, they already arrived\n");
    +  }
    +
    +  ...
    +  ev_stat passwd;
    +
    +  ev_stat_init (&passwd, passwd_cb, "/etc/passwd");
    +  ev_stat_start (loop, &passwd);
    +
    +
    +
    +
    +
    + +

    ev_idle - when you've got nothing better to do...

    Idle watchers trigger events when there are no other events are pending @@ -1103,8 +1363,8 @@ believe me.

    -

    Example: dynamically allocate an ev_idle, start it, and in the -callback, free it. Alos, use no error checking, as usual.

    +

    Example: Dynamically allocate an ev_idle watcher, start it, and in the +callback, free it. Also, use no error checking, as usual.

      static void
       idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents)
       {
    @@ -1128,10 +1388,20 @@
     

    Prepare and check watchers are usually (but not always) used in tandem: prepare watchers get invoked before the process blocks and check watchers afterwards.

    +

    You must not call ev_loop or similar functions that enter +the current event loop from either ev_prepare or ev_check +watchers. Other loops than the current one are fine, however. The +rationale behind this is that you do not need to check for recursion in +those watchers, i.e. the sequence will always be ev_prepare, blocking, +ev_check so if you have one watcher of each kind they will always be +called in pairs bracketing the blocking call.

    Their main purpose is to integrate other event mechanisms into libev and their use is somewhat advanced. This could be used, for example, to track variable changes, implement your own watchers, integrate net-snmp or a -coroutine library and lots more.

    +coroutine library and lots more. They are also occasionally useful if +you cache some data and want to flush it before blocking (for example, +in X programs you might want to do an XFlush () in an ev_prepare +watcher).

    This is done by examining in each prepare call which file descriptors need to be watched by the other library, registering ev_io watchers for them and starting an ev_timer watcher for any timeouts (many libraries @@ -1157,11 +1427,64 @@ macros, but using them is utterly, utterly and completely pointless.

    -

    Example: *TODO*.

    +

    Example: To include a library such as adns, you would add IO watchers +and a timeout watcher in a prepare handler, as required by libadns, and +in a check watcher, destroy them and call into libadns. What follows is +pseudo-code only of course:

    +
      static ev_io iow [nfd];
    +  static ev_timer tw;
    +
    +  static void
    +  io_cb (ev_loop *loop, ev_io *w, int revents)
    +  {
    +    // set the relevant poll flags
    +    // could also call adns_processreadable etc. here
    +    struct pollfd *fd = (struct pollfd *)w->data;
    +    if (revents & EV_READ ) fd->revents |= fd->events & POLLIN;
    +    if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT;
    +  }
    +
    +  // create io watchers for each fd and a timer before blocking
    +  static void
    +  adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents)
    +  {
    +    int timeout = 3600000;truct pollfd fds [nfd];
    +    // actual code will need to loop here and realloc etc.
    +    adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
    +
    +    /* the callback is illegal, but won't be called as we stop during check */
    +    ev_timer_init (&tw, 0, timeout * 1e-3);
    +    ev_timer_start (loop, &tw);
    +
    +    // create on ev_io per pollfd
    +    for (int i = 0; i < nfd; ++i)
    +      {
    +        ev_io_init (iow + i, io_cb, fds [i].fd,
    +          ((fds [i].events & POLLIN ? EV_READ : 0)
    +           | (fds [i].events & POLLOUT ? EV_WRITE : 0)));
    +
    +        fds [i].revents = 0;
    +        iow [i].data = fds + i;
    +        ev_io_start (loop, iow + i);
    +      }
    +  }
    +
    +  // stop all watchers after blocking
    +  static void
    +  adns_check_cb (ev_loop *loop, ev_check *w, int revents)
    +  {
    +    ev_timer_stop (loop, &tw);
    +
    +    for (int i = 0; i < nfd; ++i)
    +      ev_io_stop (loop, iow + i);
    +
    +    adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));
    +  }
     
     
     
     
    +

    ev_embed - when one backend isn't enough...

    @@ -1242,6 +1565,10 @@ similarly to ev_loop (embedded_loop, EVLOOP_NONBLOCK), but in the most apropriate way for embedded loops.

    +
    struct ev_loop *loop [read-only]
    +
    +

    The embedded event loop.

    +
    @@ -1249,7 +1576,30 @@ -

    OTHER FUNCTIONS

    Top

    +

    ev_fork - the audacity to resume the event loop after a fork

    +
    +

    Fork watchers are called when a fork () was detected (usually because +whoever is a good citizen cared to tell libev about it by calling +ev_default_fork or ev_loop_fork). The invocation is done before the +event loop blocks next and before ev_check watchers are being called, +and only in the child after the fork. If whoever good citizen calling +ev_default_fork cheats and calls it in the wrong process, the fork +handlers will be invoked, too, of course.

    +
    +
    ev_fork_init (ev_signal *, callback)
    +
    +

    Initialises and configures the fork watcher - it has no parameters of any +kind. There is a ev_fork_set macro, but using it is utterly pointless, +believe me.

    +
    +
    + + + + + +
    +

    OTHER FUNCTIONS

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

    @@ -1306,7 +1656,7 @@
    -

    LIBEVENT EMULATION

    Top

    +

    LIBEVENT EMULATION

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

    @@ -1326,7 +1676,7 @@
    -

    C++ SUPPORT

    Top

    +

    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 @@ -1400,6 +1750,10 @@

    Invokes ev_embed_sweep.

    +
    w->update () ev::stat only
    +
    +

    Invokes ev_stat_stat.

    +

    @@ -1421,10 +1775,74 @@ io.start (fd, ev::READ); } + + + + + +
    +

    MACRO MAGIC

    +
    +

    Libev can be compiled with a variety of options, the most fundemantal is +EV_MULTIPLICITY. This option determines wether (most) functions and +callbacks have an initial struct ev_loop * argument.

    +

    To make it easier to write programs that cope with either variant, the +following macros are defined:

    +
    +
    EV_A, EV_A_
    +
    +

    This provides the loop argument for functions, if one is required ("ev +loop argument"). The EV_A form is used when this is the sole argument, +EV_A_ is used when other arguments are following. Example:

    +
      ev_unref (EV_A);
    +  ev_timer_add (EV_A_ watcher);
    +  ev_loop (EV_A_ 0);
    +
    +
    +

    It assumes the variable loop of type struct ev_loop * is in scope, +which is often provided by the following macro.

    +
    +
    EV_P, EV_P_
    +
    +

    This provides the loop parameter for functions, if one is required ("ev +loop parameter"). The EV_P form is used when this is the sole parameter, +EV_P_ is used when other parameters are following. Example:

    +
      // this is how ev_unref is being declared
    +  static void ev_unref (EV_P);
    +
    +  // this is how you can declare your typical callback
    +  static void cb (EV_P_ ev_timer *w, int revents)
    +
    +
    +

    It declares a parameter loop of type struct ev_loop *, quite +suitable for use with EV_A.

    +
    +
    EV_DEFAULT, EV_DEFAULT_
    +
    +

    Similar to the other two macros, this gives you the value of the default +loop, if multiple loops are supported ("ev loop default").

    +
    +
    +

    Example: Declare and initialise a check watcher, working regardless of +wether multiple loops are supported or not.

    +
      static void
    +  check_cb (EV_P_ ev_timer *w, int revents)
    +  {
    +    ev_check_stop (EV_A_ w);
    +  }
    +
    +  ev_check check;
    +  ev_check_init (&check, check_cb);
    +  ev_check_start (EV_DEFAULT_ &check);
    +  ev_loop (EV_DEFAULT_ 0);
    +
    +
    +
    +
     
    -

    EMBEDDING

    Top

    +

    EMBEDDING

    Libev can (and often is) directly embedded into host applications. Examples of applications that embed it include the Deliantra @@ -1471,7 +1889,7 @@ ev_win32.c required on win32 platforms only - ev_select.c only when select backend is enabled (which is is by default) + ev_select.c only when select backend is enabled (which 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) @@ -1479,7 +1897,7 @@

    ev.c includes the backend files directly when enabled, so you only need -to compile a single file.

    +to compile this single file.

    LIBEVENT COMPATIBILITY API

    @@ -1504,8 +1922,8 @@

    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.

    +configure.ac and leave EV_STANDALONE undefined. ev.c will then +include config.h and configure itself accordingly.

    For this of course you need the m4 file:

      libev.m4
     
    @@ -1608,6 +2026,12 @@
     	

    reserved for future expansion, works like the USE symbols above.

    +
    EV_USE_INOTIFY
    +
    +

    If defined to be 1, libev will compile in support for the Linux inotify +interface to speed up ev_stat watchers. Its actual availability will +be detected at runtime.

    +
    EV_H

    The name of the ev.h header file used to include it. The default if @@ -1640,10 +2064,47 @@ for multiple event loops and there is no first event loop pointer argument. Instead, all functions act on the single default loop.

    -
    EV_PERIODICS
    +
    EV_PERIODIC_ENABLE
    +
    +

    If undefined or defined to be 1, then periodic timers are supported. If +defined to be 0, then they are not. Disabling them saves a few kB of +code.

    +
    +
    EV_EMBED_ENABLE
    +
    +

    If undefined or defined to be 1, then embed watchers are supported. If +defined to be 0, then they are not.

    +
    +
    EV_STAT_ENABLE
    -

    If undefined or defined to be 1, then periodic timers are supported, -otherwise not. This saves a few kb of code.

    +

    If undefined or defined to be 1, then stat watchers are supported. If +defined to be 0, then they are not.

    +
    +
    EV_FORK_ENABLE
    +
    +

    If undefined or defined to be 1, then fork watchers are supported. If +defined to be 0, then they are not.

    +
    +
    EV_MINIMAL
    +
    +

    If you need to shave off some kilobytes of code at the expense of some +speed, define this symbol to 1. Currently only used for gcc to override +some inlining decisions, saves roughly 30% codesize of amd64.

    +
    +
    EV_PID_HASHSIZE
    +
    +

    ev_child watchers use a small hash table to distribute workload by +pid. The default size is 16 (or 1 with EV_MINIMAL), usually more +than enough. If you need to manage thousands of children you might want to +increase this value (must be a power of two).

    +
    +
    EV_INOTIFY_HASHSIZE
    +
    +

    ev_staz watchers use a small hash table to distribute workload by +inotify watch id. The default size is 16 (or 1 with EV_MINIMAL), +usually more than enough. If you need to manage thousands of ev_stat +watchers you might want to increase this value (must be a power of +two).

    EV_COMMON
    @@ -1658,16 +2119,16 @@
    -
    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)

    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++.

    +avoid the struct ev_loop * as first argument in all cases, or to use +method calls instead of plain function calls in C++.

    EXAMPLES

    @@ -1693,10 +2154,36 @@
      #include "ev_cpp.h"
       #include "ev.c"
     
    +
    +
    +
     
    -

    AUTHOR

    Top

    +

    COMPLEXITIES

    +
    +

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

    +

    +

    +
    Starting and stopping timer/periodic watchers: O(log skipped_other_timers)
    +
    Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)
    +
    Starting io/check/prepare/idle/signal/child watchers: O(1)
    +
    Stopping check/prepare/idle watchers: O(1)
    +
    Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))
    +
    Finding the next timer per loop iteration: O(1)
    +
    Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)
    +
    Activating one watcher: O(1)
    +
    +

    + + + + + +
    +

    AUTHOR

    Marc Lehmann <libev@schmorp.de>.