*** empty log message ***

[software/libev.git] / ev.h

diff --git a/ev.h b/ev.h
index f8112b0aebe2a386062c5a57759152a7d18a820a..a6065d08f6d0e1983b89cfc646759bab07b64bcb 100644 (file)
--- a/ev.h
+++ b/ev.h
@@ -27,8 +27,8 @@
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 

-#ifndef EV_H
-#define EV_H
+#ifndef EV_H__
+#define EV_H__

 
 #ifdef __cplusplus
 extern "C" {
 
 #ifdef __cplusplus
 extern "C" {


@@ -44,10 +44,23 @@ typedef double ev_tstamp;
 # define EV_MAXPRI +2
 #endif
 
 # define EV_MAXPRI +2
 #endif
 

-#define EV_P void
-#define EV_P_
-#define EV_A
-#define EV_A_
+#ifndef EV_MULTIPLICITY
+# define EV_MULTIPLICITY 1
+#endif
+
+/* support multiple event loops? */
+#if EV_MULTIPLICITY
+struct ev_loop;
+# define EV_P struct ev_loop *loop
+# define EV_P_ EV_P,
+# define EV_A loop
+# define EV_A_ EV_A,
+#else
+# define EV_P void
+# define EV_P_
+# define EV_A
+# define EV_A_
+#endif

 
 /* eventmask, revents, events... */
 #define EV_UNDEF          -1 /* guaranteed to be invalid */
 
 /* eventmask, revents, events... */
 #define EV_UNDEF          -1 /* guaranteed to be invalid */


@@ -85,9 +98,9 @@ typedef double ev_tstamp;
 #define EV_WATCHER(type)                       \
   int active; /* private */                    \
   int pending; /* private */                   \
 #define EV_WATCHER(type)                       \
   int active; /* private */                    \
   int pending; /* private */                   \

-  int priority; /* ro */                       \
+  int priority; /* private */                  \

   EV_COMMON; /* rw */                          \
   EV_COMMON; /* rw */                          \

-  void (*cb)(EV_P_ struct type *, int revents); /* rw */ /* gets invoked with an eventmask */
+  void (*cb)(EV_P_ struct type *, int revents) /* private */ /* gets invoked with an eventmask */

 
 #define EV_WATCHER_LIST(type)                  \
   EV_WATCHER (type);                           \
 
 #define EV_WATCHER_LIST(type)                  \
   EV_WATCHER (type);                           \


@@ -128,6 +141,7 @@ struct ev_periodic
   EV_WATCHER_TIME (ev_periodic);
 
   ev_tstamp interval; /* rw */
   EV_WATCHER_TIME (ev_periodic);
 
   ev_tstamp interval; /* rw */

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

 };
 
 /* invoked when fd is either EV_READable or EV_WRITEable */
 };
 
 /* invoked when fd is either EV_READable or EV_WRITEable */


@@ -183,6 +197,21 @@ struct ev_child
   int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
 };
 
   int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
 };
 

+/* the presence of this union forces similar struct layout */
+union ev_any_watcher
+{
+  struct ev_watcher w;
+  struct ev_watcher_list wl;
+  struct ev_io io;
+  struct ev_timer timer;
+  struct ev_periodic periodic;
+  struct ev_signal signal;
+  struct ev_idle idle;
+  struct ev_child child;
+  struct ev_prepare prepare;
+  struct ev_check check;
+};
+

 #define EVMETHOD_AUTO     0 /* consults environment */
 #define EVMETHOD_SELECT   1
 #define EVMETHOD_POLL     2
 #define EVMETHOD_AUTO     0 /* consults environment */
 #define EVMETHOD_SELECT   1
 #define EVMETHOD_POLL     2


@@ -190,26 +219,60 @@ struct ev_child
 #define EVMETHOD_KQUEUE   8
 #define EVMETHOD_DEVPOLL 16 /* NYI */
 #define EVMETHOD_PORT    32 /* NYI */
 #define EVMETHOD_KQUEUE   8
 #define EVMETHOD_DEVPOLL 16 /* NYI */
 #define EVMETHOD_PORT    32 /* NYI */

+#define EVMETHOD_WIN32   64 /* NYI */

 #define EVMETHOD_ANY     ~0 /* any method, do not consult env */
 #define EVMETHOD_ANY     ~0 /* any method, do not consult env */

+

 #if EV_PROTOTYPES
 #if EV_PROTOTYPES

-int ev_method (EV_P);
-int ev_init (EV_P_ int methods); /* returns ev_method */

 int ev_version_major (void);
 int ev_version_minor (void);
 
 int ev_version_major (void);
 int ev_version_minor (void);
 

-/* these three calls are suitable for plugging into pthread_atfork */
-void ev_fork_prepare (void);
-void ev_fork_parent (void);
-void ev_fork_child (void);
-

 ev_tstamp ev_time (void);
 ev_tstamp ev_time (void);

+
+/* Sets the allocation function to use, works like realloc.
+ * It is used to allocate and free memory.
+ * 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.
+ */
+void ev_set_allocator (void *(*cb)(void *ptr, long size));
+
+/* set the callback function to call on a
+ * retryable syscall error
+ * (such as failed select, poll, epoll_wait)
+ */
+void ev_set_syserr_cb (void (*cb)(const char *msg));
+
+# if EV_MULTIPLICITY
+/* the default loop is the only one that handles signals and child watchers */
+/* you can call this as often as you like */
+struct ev_loop *ev_default_loop (int methods); /* returns default loop */
+
+/* create and destroy alternative loops that don't handle signals */
+struct ev_loop *ev_loop_new (int methods);
+void ev_loop_destroy (EV_P);
+void ev_loop_fork (EV_P);
+# else
+int ev_default_loop (int methods); /* returns true when successful */
+# endif
+
+void ev_default_destroy (void); /* destroy the default loop */
+/* this needs to be called after fork, to duplicate the default loop */
+/* if you create alternative loops you have to call ev_loop_fork on them */
+/* you can call it in either the parent or the child */
+/* you can actually call it at any time, anywhere :) */
+void ev_default_fork (void);
+
+int ev_method (EV_P);

 #endif
 
 #define EVLOOP_NONBLOCK        1 /* do not block/wait */
 #define EVLOOP_ONESHOT 2 /* block *once* only */
 #endif
 
 #define EVLOOP_NONBLOCK        1 /* do not block/wait */
 #define EVLOOP_ONESHOT 2 /* block *once* only */

+#define EVUNLOOP_ONCE   1 /* unloop once */
+#define EVUNLOOP_ALL    2 /* unloop all loops */
+

 #if EV_PROTOTYPES
 void ev_loop (EV_P_ int flags);
 #if EV_PROTOTYPES
 void ev_loop (EV_P_ int flags);

-void ev_unloop (EV_P_ int status); /* set to 1 to break out of event loop, set to 2 to break out of all event loops */
+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 */

 
 ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
 
 
 ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
 


@@ -228,11 +291,16 @@ 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_watcher_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_watcher_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */

-#define ev_watcher_init(ev,cb_)             do { (ev)->active = (ev)->pending = (ev)->priority = 0; (ev)->cb = (cb_); } while (0)
+#define ev_watcher_init(ev,cb_) do {           \
+  ((struct ev_watcher *)(void *)(ev))->active   =      \
+  ((struct ev_watcher *)(void *)(ev))->pending  =      \
+  ((struct ev_watcher *)(void *)(ev))->priority = 0;   \
+  (ev)->cb = (cb_);                            \
+} while (0)

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

-#define ev_periodic_set(ev,at_,interval_)   do { (ev)->at = (at_); (ev)->interval = (interval_); } 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_signal_set(ev,signum_)           do { (ev)->signum = (signum_); } 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_signal_set(ev,signum_)           do { (ev)->signum = (signum_); } 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 */


@@ -241,31 +309,42 @@ void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revent
 
 #define ev_io_init(ev,cb,fd,events)         do { ev_watcher_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
 #define ev_timer_init(ev,cb,after,repeat)   do { ev_watcher_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
 
 #define ev_io_init(ev,cb,fd,events)         do { ev_watcher_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
 #define ev_timer_init(ev,cb,after,repeat)   do { ev_watcher_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)

-#define ev_periodic_init(ev,cb,at,interval) do { ev_watcher_init ((ev), (cb)); ev_periodic_set ((ev),(at),(interval)); } while (0)
+#define ev_periodic_init(ev,cb,at,ival,res) do { ev_watcher_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0)

 #define ev_signal_init(ev,cb,signum)        do { ev_watcher_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
 #define ev_idle_init(ev,cb)                 do { ev_watcher_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
 #define ev_prepare_init(ev,cb)              do { ev_watcher_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
 #define ev_check_init(ev,cb)                do { ev_watcher_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
 #define ev_child_init(ev,cb,pid)            do { ev_watcher_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)
 
 #define ev_signal_init(ev,cb,signum)        do { ev_watcher_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
 #define ev_idle_init(ev,cb)                 do { ev_watcher_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
 #define ev_prepare_init(ev,cb)              do { ev_watcher_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
 #define ev_check_init(ev,cb)                do { ev_watcher_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
 #define ev_child_init(ev,cb,pid)            do { ev_watcher_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)
 

-#define ev_is_active(ev)                    (0 + (ev)->active) /* true when the watcher has been started */
-#define ev_set_priority(ev,pri)             (ev)->priority = pri
+#define ev_is_pending(ev)                   (0 + ((struct ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
+#define ev_is_active(ev)                    (0 + ((struct ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
+
+#define ev_priority(ev)                     ((struct ev_watcher *)(void *)(ev))->priority /* rw */
+#define ev_cb(ev)                           (ev)->cb /* rw */
+#define ev_set_priority(ev,pri)             ev_priority (ev) = (pri)
+#define ev_set_cb(ev,cb_)                   ev_cb (ev) = (cb_)

 
 /* stopping (enabling, adding) a watcher does nothing if it is already running */
 /* stopping (disabling, deleting) a watcher does nothing unless its already running */
 #if EV_PROTOTYPES
 
 /* stopping (enabling, adding) a watcher does nothing if it is already running */
 /* stopping (disabling, deleting) a watcher does nothing unless its already running */
 #if EV_PROTOTYPES

+
+/* feeds an event into a watcher as if the event actually occured */
+/* accepts any ev_watcher type */
+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_io_start       (EV_P_ struct ev_io *w);
 void ev_io_stop        (EV_P_ struct ev_io *w);
 
 void ev_timer_start    (EV_P_ struct ev_timer *w);
 void ev_timer_stop     (EV_P_ struct ev_timer *w);
 void ev_io_start       (EV_P_ struct ev_io *w);
 void ev_io_stop        (EV_P_ struct ev_io *w);
 
 void ev_timer_start    (EV_P_ struct ev_timer *w);
 void ev_timer_stop     (EV_P_ struct ev_timer *w);

-void ev_timer_again    (EV_P_ struct ev_timer *w); /* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
+/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
+void ev_timer_again    (EV_P_ struct ev_timer *w);

 
 void ev_periodic_start (EV_P_ struct ev_periodic *w);
 void ev_periodic_stop  (EV_P_ struct ev_periodic *w);
 
 void ev_periodic_start (EV_P_ struct ev_periodic *w);
 void ev_periodic_stop  (EV_P_ struct ev_periodic *w);

-
-void ev_signal_start   (EV_P_ struct ev_signal *w);
-void ev_signal_stop    (EV_P_ struct ev_signal *w);
+void ev_periodic_again (EV_P_ struct ev_periodic *w);

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


@@ -276,6 +355,11 @@ void ev_prepare_stop   (EV_P_ struct ev_prepare *w);
 void ev_check_start    (EV_P_ struct ev_check *w);
 void ev_check_stop     (EV_P_ struct ev_check *w);
 
 void ev_check_start    (EV_P_ struct ev_check *w);
 void ev_check_stop     (EV_P_ struct ev_check *w);
 

+/* only supported in the default loop */
+void ev_signal_start   (EV_P_ struct ev_signal *w);
+void ev_signal_stop    (EV_P_ struct ev_signal *w);
+
+/* only supported in the default loop */

 void ev_child_start    (EV_P_ struct ev_child *w);
 void ev_child_stop     (EV_P_ struct ev_child *w);
 #endif
 void ev_child_start    (EV_P_ struct ev_child *w);
 void ev_child_stop     (EV_P_ struct ev_child *w);
 #endif