*** empty log message ***

[software/libev.git] / ev.h

diff --git a/ev.h b/ev.h
index 26ffe7804d526f1df69579c2b99385e4a4370e05..1909055ae1702039c15fa644157492075fdbaf9b 100644 (file)
--- a/ev.h
+++ b/ev.h
@@ -1,30 +1,40 @@
 /*
 /*

+ * libev native API header
+ *

  * Copyright (c) 2007 Marc Alexander Lehmann <libev@schmorp.de>
  * All rights reserved.
  *
  * Copyright (c) 2007 Marc Alexander Lehmann <libev@schmorp.de>
  * All rights reserved.
  *

- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are
- * met:
- *
- *     * Redistributions of source code must retain the above copyright
- *       notice, this list of conditions and the following disclaimer.
+ * Redistribution and use in source and binary forms, with or without modifica-
+ * tion, are permitted provided that the following conditions are met:
+ * 
+ *   1.  Redistributions of source code must retain the above copyright notice,
+ *       this list of conditions and the following disclaimer.
+ * 
+ *   2.  Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in the
+ *       documentation and/or other materials provided with the distribution.
+ * 
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
+ * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MER-
+ * CHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO
+ * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPE-
+ * CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
+ * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+ * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTH-
+ * ERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+ * OF THE POSSIBILITY OF SUCH DAMAGE.

  *
  *

- *     * Redistributions in binary form must reproduce the above
- *       copyright notice, this list of conditions and the following
- *       disclaimer in the documentation and/or other materials provided
- *       with the distribution.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
- * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
- * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ * Alternatively, the contents of this file may be used under the terms of
+ * the GNU General Public License ("GPL") version 2 or any later version,
+ * in which case the provisions of the GPL are applicable instead of
+ * the above. If you wish to allow the use of your version of this file
+ * only under the terms of the GPL and not to allow others to use your
+ * version of this file under the BSD license, indicate your decision
+ * by deleting the provisions above and replace them with the notice
+ * and other provisions required by the GPL. If you do not delete the
+ * provisions above, a recipient may use your version of this file under
+ * either the BSD or the GPL.

  */
 
 #ifndef EV_H__
  */
 
 #ifndef EV_H__


@@ -56,6 +66,10 @@ typedef double ev_tstamp;
 # define EV_STAT_ENABLE 1
 #endif
 
 # define EV_STAT_ENABLE 1
 #endif
 

+#ifndef EV_IDLE_ENABLE
+# define EV_IDLE_ENABLE 1
+#endif
+

 #ifndef EV_FORK_ENABLE
 # define EV_FORK_ENABLE 1
 #endif
 #ifndef EV_FORK_ENABLE
 # define EV_FORK_ENABLE 1
 #endif


@@ -95,6 +109,7 @@ struct ev_loop;
 #define EV_NONE           0x00L /* no events */
 #define EV_READ           0x01L /* ev_io detected read will not block */
 #define EV_WRITE          0x02L /* ev_io detected write will not block */
 #define EV_NONE           0x00L /* no events */
 #define EV_READ           0x01L /* ev_io detected read will not block */
 #define EV_WRITE          0x02L /* ev_io detected write will not block */

+#define EV_IOFDSET        0x80L /* internal use only */

 #define EV_TIMEOUT  0x00000100L /* timer timed out */
 #define EV_PERIODIC 0x00000200L /* periodic timer timed out */
 #define EV_SIGNAL   0x00000400L /* signal was received */
 #define EV_TIMEOUT  0x00000100L /* timer timed out */
 #define EV_PERIODIC 0x00000200L /* periodic timer timed out */
 #define EV_SIGNAL   0x00000400L /* signal was received */


@@ -115,8 +130,8 @@ struct ev_loop;
 # define EV_PROTOTYPES 1
 #endif
 
 # define EV_PROTOTYPES 1
 #endif
 

-#define EV_VERSION_MAJOR 1
-#define EV_VERSION_MINOR 1
+#define EV_VERSION_MAJOR 2
+#define EV_VERSION_MINOR 0

 
 #ifndef EV_CB_DECLARE
 # define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents);
 
 #ifndef EV_CB_DECLARE
 # define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents);


@@ -191,6 +206,7 @@ typedef struct ev_periodic
 {
   EV_WATCHER_TIME (ev_periodic)
 
 {
   EV_WATCHER_TIME (ev_periodic)
 

+  ev_tstamp offset; /* rw */

   ev_tstamp interval; /* rw */
   ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */
 } ev_periodic;
   ev_tstamp interval; /* rw */
   ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */
 } ev_periodic;


@@ -218,32 +234,36 @@ typedef struct ev_child
 
 #if EV_STAT_ENABLE
 /* st_nlink = 0 means missing file or other error */
 
 #if EV_STAT_ENABLE
 /* st_nlink = 0 means missing file or other error */

-#ifdef _WIN32
+# ifdef _WIN32

 typedef struct _stati64 ev_statdata;
 typedef struct _stati64 ev_statdata;

-#else
+# else

 typedef struct stat ev_statdata;
 typedef struct stat ev_statdata;

-#endif
+# endif

 
 /* invoked each time the stat data changes for a given path */
 /* revent EV_STAT */
 typedef struct ev_stat
 {
 
 /* invoked each time the stat data changes for a given path */
 /* revent EV_STAT */
 typedef struct ev_stat
 {

-  EV_WATCHER (ev_stat)
+  EV_WATCHER_LIST (ev_stat)

 
   ev_timer timer;     /* private */
   ev_tstamp interval; /* ro */
   const char *path;   /* ro */
   ev_statdata prev;   /* ro */
   ev_statdata attr;   /* ro */
 
   ev_timer timer;     /* private */
   ev_tstamp interval; /* ro */
   const char *path;   /* ro */
   ev_statdata prev;   /* ro */
   ev_statdata attr;   /* ro */

+
+  int wd; /* wd for inotify, fd for kqueue */

 } ev_stat;
 #endif
 
 } ev_stat;
 #endif
 

+#if EV_IDLE_ENABLE

 /* invoked when the nothing else needs to be done, keeps the process from blocking */
 /* revent EV_IDLE */
 typedef struct ev_idle
 {
   EV_WATCHER (ev_idle)
 } ev_idle;
 /* invoked when the nothing else needs to be done, keeps the process from blocking */
 /* revent EV_IDLE */
 typedef struct ev_idle
 {
   EV_WATCHER (ev_idle)
 } ev_idle;

+#endif

 
 /* invoked for each run of the mainloop, just before the blocking call */
 /* you can still change events in any way you like */
 
 /* invoked for each run of the mainloop, just before the blocking call */
 /* you can still change events in any way you like */


@@ -275,8 +295,14 @@ typedef struct ev_embed
 {
   EV_WATCHER (ev_embed)
 
 {
   EV_WATCHER (ev_embed)
 

-  ev_io io; /* private */
-  struct ev_loop *loop; /* ro */
+  struct ev_loop *other; /* ro */
+  ev_io io;              /* private */
+  ev_prepare prepare;    /* private */
+  ev_check check;        /* unused */
+  ev_timer timer;        /* unused */
+  ev_periodic periodic;  /* unused */
+  ev_idle idle;          /* unused */
+  ev_fork fork;          /* unused */

 } ev_embed;
 #endif
 
 } ev_embed;
 #endif
 


@@ -294,7 +320,9 @@ union ev_any_watcher
 #if EV_STAT_ENABLE
   struct ev_stat stat;
 #endif
 #if EV_STAT_ENABLE
   struct ev_stat stat;
 #endif

+#if EV_IDLE_ENABLE

   struct ev_idle idle;
   struct ev_idle idle;

+#endif

   struct ev_prepare prepare;
   struct ev_check check;
 #if EV_FORK_ENABLE
   struct ev_prepare prepare;
   struct ev_check check;
 #if EV_FORK_ENABLE


@@ -310,6 +338,7 @@ union ev_any_watcher
 #define EVFLAG_AUTO       0x00000000UL /* not quite a mask */
 /* flag bits */
 #define EVFLAG_NOENV      0x01000000UL /* do NOT consult environment */
 #define EVFLAG_AUTO       0x00000000UL /* not quite a mask */
 /* flag bits */
 #define EVFLAG_NOENV      0x01000000UL /* do NOT consult environment */

+#define EVFLAG_FORKCHECK  0x02000000UL /* check for a fork in each iteration */

 /* method bits to be ored together */
 #define EVBACKEND_SELECT  0x00000001UL /* about anywhere */
 #define EVBACKEND_POLL    0x00000002UL /* !win */
 /* method bits to be ored together */
 #define EVBACKEND_SELECT  0x00000001UL /* about anywhere */
 #define EVBACKEND_POLL    0x00000002UL /* !win */


@@ -327,6 +356,7 @@ unsigned int ev_recommended_backends (void);
 unsigned int ev_embeddable_backends (void);
 
 ev_tstamp ev_time (void);
 unsigned int ev_embeddable_backends (void);
 
 ev_tstamp ev_time (void);

+void ev_sleep (ev_tstamp delay); /* sleep for a while */

 
 /* Sets the allocation function to use, works like realloc.
  * It is used to allocate and free memory.
 
 /* Sets the allocation function to use, works like realloc.
  * It is used to allocate and free memory.


@@ -384,7 +414,8 @@ void ev_default_destroy (void); /* destroy the default loop */
 /* you can actually call it at any time, anywhere :) */
 void ev_default_fork (void);
 
 /* you can actually call it at any time, anywhere :) */
 void ev_default_fork (void);
 

-unsigned int ev_backend (EV_P);
+unsigned int ev_backend (EV_P);    /* backend in use by loop */
+unsigned int ev_loop_count (EV_P); /* number of loop iterations */

 #endif
 
 #define EVLOOP_NONBLOCK        1 /* do not block/wait */
 #endif
 
 #define EVLOOP_NONBLOCK        1 /* do not block/wait */


@@ -397,6 +428,9 @@ unsigned int ev_backend (EV_P);
 void ev_loop (EV_P_ int flags);
 void ev_unloop (EV_P_ int how); /* set to 1 to break out of event loop, set to 2 to break out of all event loops */
 
 void ev_loop (EV_P_ int flags);
 void ev_unloop (EV_P_ int how); /* set to 1 to break out of event loop, set to 2 to break out of all event loops */
 

+void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
+void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
+

 /*
  * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
  * keeps one reference. if you have a long-runing watcher you never unregister that
 /*
  * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
  * keeps one reference. if you have a long-runing watcher you never unregister that


@@ -412,23 +446,23 @@ void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revent
 
 /* these may evaluate ev multiple times, and the other arguments at most once */
 /* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
 
 /* these may evaluate ev multiple times, and the other arguments at most once */
 /* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */

-#define ev_init(ev,cb_) do {                           \
+#define ev_init(ev,cb_) do {                   \

   ((ev_watcher *)(void *)(ev))->active   =     \
   ((ev_watcher *)(void *)(ev))->pending  =     \
   ((ev_watcher *)(void *)(ev))->priority = 0;  \
   ((ev_watcher *)(void *)(ev))->active   =     \
   ((ev_watcher *)(void *)(ev))->pending  =     \
   ((ev_watcher *)(void *)(ev))->priority = 0;  \

-  ev_set_cb ((ev), cb_);                                       \
+  ev_set_cb ((ev), cb_);                       \

 } while (0)
 
 } while (0)
 

-#define ev_io_set(ev,fd_,events_)           do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0)
+#define ev_io_set(ev,fd_,events_)           do { (ev)->fd = (fd_); (ev)->events = (events_) | EV_IOFDSET; } while (0)

 #define ev_timer_set(ev,after_,repeat_)     do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)
 #define ev_timer_set(ev,after_,repeat_)     do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)

-#define ev_periodic_set(ev,at_,ival_,res_)  do { (ev)->at = (at_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0)
+#define ev_periodic_set(ev,ofs_,ival_,res_) do { (ev)->offset = (ofs_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0)

 #define ev_signal_set(ev,signum_)           do { (ev)->signum = (signum_); } while (0)
 #define ev_child_set(ev,pid_)               do { (ev)->pid = (pid_); } while (0)
 #define ev_signal_set(ev,signum_)           do { (ev)->signum = (signum_); } while (0)
 #define ev_child_set(ev,pid_)               do { (ev)->pid = (pid_); } while (0)

-#define ev_stat_set(ev,path_,interval_)     do { (ev)->path = (path_); (ev)->interval = (interval_); } while (0)
+#define ev_stat_set(ev,path_,interval_)     do { (ev)->path = (path_); (ev)->interval = (interval_); (ev)->wd = -2; } while (0)

 #define ev_idle_set(ev)                     /* nop, yes, this is a serious in-joke */
 #define ev_prepare_set(ev)                  /* nop, yes, this is a serious in-joke */
 #define ev_check_set(ev)                    /* nop, yes, this is a serious in-joke */
 #define ev_idle_set(ev)                     /* nop, yes, this is a serious in-joke */
 #define ev_prepare_set(ev)                  /* nop, yes, this is a serious in-joke */
 #define ev_check_set(ev)                    /* nop, yes, this is a serious in-joke */

-#define ev_embed_set(ev,loop_)              do { (ev)->loop = (loop_); } while (0)
+#define ev_embed_set(ev,other_)             do { (ev)->other = (other_); } while (0)

 #define ev_fork_set(ev)                     /* nop, yes, this is a serious in-joke */
 
 #define ev_io_init(ev,cb,fd,events)         do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
 #define ev_fork_set(ev)                     /* nop, yes, this is a serious in-joke */
 
 #define ev_io_init(ev,cb,fd,events)         do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)


@@ -436,19 +470,19 @@ void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revent
 #define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0)
 #define ev_signal_init(ev,cb,signum)        do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
 #define ev_child_init(ev,cb,pid)            do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)
 #define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0)
 #define ev_signal_init(ev,cb,signum)        do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
 #define ev_child_init(ev,cb,pid)            do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)

-#define ev_stat_init(ev,cb,path,interval)   do { ev_init ((ev), (cb)); ev_path_set ((ev),(path),(interval)); } while (0)
+#define ev_stat_init(ev,cb,path,interval)   do { ev_init ((ev), (cb)); ev_stat_set ((ev),(path),(interval)); } while (0)

 #define ev_idle_init(ev,cb)                 do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
 #define ev_prepare_init(ev,cb)              do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
 #define ev_check_init(ev,cb)                do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
 #define ev_idle_init(ev,cb)                 do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
 #define ev_prepare_init(ev,cb)              do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
 #define ev_check_init(ev,cb)                do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)

-#define ev_embed_init(ev,cb,loop)           do { ev_init ((ev), (cb)); ev_embed_set ((ev),(loop)); } while (0)
+#define ev_embed_init(ev,cb,other)          do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0)

 #define ev_fork_init(ev,cb)                 do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0)
 
 #define ev_is_pending(ev)                   (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
 #define ev_is_active(ev)                    (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
 
 #define ev_fork_init(ev,cb)                 do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0)
 
 #define ev_is_pending(ev)                   (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
 #define ev_is_active(ev)                    (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
 

-#define ev_priority(ev)                     ((ev_watcher *)(void *)(ev))->priority /* rw */
+#define ev_priority(ev)                     ((((ev_watcher *)(void *)(ev))->priority) + 0)

 #define ev_cb(ev)                           (ev)->cb /* rw */
 #define ev_cb(ev)                           (ev)->cb /* rw */

-#define ev_set_priority(ev,pri)             ev_priority (ev) = (pri)
+#define ev_set_priority(ev,pri)             ((ev_watcher *)(void *)(ev))->priority = (pri)

 
 #ifndef ev_set_cb
 # define ev_set_cb(ev,cb_)                  ev_cb (ev) = (cb_)
 
 #ifndef ev_set_cb
 # define ev_set_cb(ev,cb_)                  ev_cb (ev) = (cb_)


@@ -463,6 +497,8 @@ void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revent
 void ev_feed_event     (EV_P_ void *w, int revents);
 void ev_feed_fd_event  (EV_P_ int fd, int revents);
 void ev_feed_signal_event (EV_P_ int signum);
 void ev_feed_event     (EV_P_ void *w, int revents);
 void ev_feed_fd_event  (EV_P_ int fd, int revents);
 void ev_feed_signal_event (EV_P_ int signum);

+void ev_invoke         (EV_P_ void *w, int revents);
+int  ev_clear_pending  (EV_P_ void *w);

 
 void ev_io_start       (EV_P_ ev_io *w);
 void ev_io_stop        (EV_P_ ev_io *w);
 
 void ev_io_start       (EV_P_ ev_io *w);
 void ev_io_stop        (EV_P_ ev_io *w);


@@ -492,8 +528,10 @@ void ev_stat_stop      (EV_P_ ev_stat *w);
 void ev_stat_stat      (EV_P_ ev_stat *w);
 # endif
 
 void ev_stat_stat      (EV_P_ ev_stat *w);
 # endif
 

+# if EV_IDLE_ENABLE

 void ev_idle_start     (EV_P_ ev_idle *w);
 void ev_idle_stop      (EV_P_ ev_idle *w);
 void ev_idle_start     (EV_P_ ev_idle *w);
 void ev_idle_stop      (EV_P_ ev_idle *w);

+# endif

 
 void ev_prepare_start  (EV_P_ ev_prepare *w);
 void ev_prepare_stop   (EV_P_ ev_prepare *w);
 
 void ev_prepare_start  (EV_P_ ev_prepare *w);
 void ev_prepare_stop   (EV_P_ ev_prepare *w);