implement poll method, handle enomem by closing a 'random' fd

[software/libev.git] / ev.h

diff --git a/ev.h b/ev.h
index 0454138c0e4fc152ebe8af8d8240747623752880..66e9bd189a128f86f4941717eeb7809ed0b2338c 100644 (file)
--- a/ev.h
+++ b/ev.h
@@ -30,20 +30,25 @@
 #ifndef EV_H
 #define EV_H
 
 #ifndef EV_H
 #define EV_H
 

+#ifdef __cplusplus
+extern "C" {
+#endif
+

 typedef double ev_tstamp;
 
 /* eventmask, revents, events... */
 typedef double ev_tstamp;
 
 /* eventmask, revents, events... */

-#define EV_UNDEF   -1 /* guaranteed to be invalid */
-#define EV_NONE    0x000000
-#define EV_READ    0x000001
-#define EV_WRITE   0x000002
-#define EV_TIMEOUT 0x000004
-#define EV_SIGNAL  0x000008
-#define EV_IDLE    0x000010
-#define EV_CHECK   0x000020
-#define EV_PREPARE 0x000040
-#define EV_CHILD   0x000080
-#define EV_ERROR   0x800000
+#define EV_UNDEF          -1 /* guaranteed to be invalid */
+#define EV_NONE         0x00
+#define EV_READ         0x01
+#define EV_WRITE        0x02
+#define EV_TIMEOUT  0x000100
+#define EV_PERIODIC 0x000200
+#define EV_SIGNAL   0x000400
+#define EV_IDLE     0x000800
+#define EV_CHECK    0x001000
+#define EV_PREPARE  0x002000
+#define EV_CHILD    0x004000
+#define EV_ERROR    0x800000 /* sent when an error occurs */

 
 /* can be used to add custom fields to all watchers */
 #ifndef EV_COMMON
 
 /* can be used to add custom fields to all watchers */
 #ifndef EV_COMMON


@@ -94,6 +99,7 @@ struct ev_watcher_time {
 };
 
 /* invoked after a specific time, repeatable (based on monotonic clock) */
 };
 
 /* invoked after a specific time, repeatable (based on monotonic clock) */

+/* revent EV_TIMEOUT */

 struct ev_timer
 {
   EV_WATCHER_TIME (ev_timer);
 struct ev_timer
 {
   EV_WATCHER_TIME (ev_timer);


@@ -102,6 +108,7 @@ struct ev_timer
 };
 
 /* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
 };
 
 /* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */

+/* revent EV_PERIODIC */

 struct ev_periodic
 {
   EV_WATCHER_TIME (ev_periodic);
 struct ev_periodic
 {
   EV_WATCHER_TIME (ev_periodic);


@@ -110,6 +117,7 @@ struct ev_periodic
 };
 
 /* invoked when fd is either EV_READable or EV_WRITEable */
 };
 
 /* invoked when fd is either EV_READable or EV_WRITEable */

+/* revent EV_READ, EV_WRITE */

 struct ev_io
 {
   EV_WATCHER_LIST (ev_io);
 struct ev_io
 {
   EV_WATCHER_LIST (ev_io);


@@ -119,6 +127,7 @@ struct ev_io
 };
 
 /* invoked when the given signal has been received */
 };
 
 /* invoked when the given signal has been received */

+/* revent EV_SIGNAL */

 struct ev_signal
 {
   EV_WATCHER_LIST (ev_signal);
 struct ev_signal
 {
   EV_WATCHER_LIST (ev_signal);


@@ -127,6 +136,7 @@ struct ev_signal
 };
 
 /* invoked when the nothing else needs to be done, keeps the process from blocking */
 };
 
 /* invoked when the nothing else needs to be done, keeps the process from blocking */

+/* revent EV_IDLE */

 struct ev_idle
 {
   EV_WATCHER (ev_idle);
 struct ev_idle
 {
   EV_WATCHER (ev_idle);


@@ -134,18 +144,21 @@ struct ev_idle
 
 /* 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 */

+/* revent EV_PREPARE */

 struct ev_prepare
 {
   EV_WATCHER (ev_prepare);
 };
 
 /* invoked for each run of the mainloop, just after the blocking call */
 struct ev_prepare
 {
   EV_WATCHER (ev_prepare);
 };
 
 /* invoked for each run of the mainloop, just after the blocking call */

+/* revent EV_CHECK */

 struct ev_check
 {
   EV_WATCHER (ev_check);
 };
 
 /* invoked when sigchld is received and waitpid indicates the givne pid */
 struct ev_check
 {
   EV_WATCHER (ev_check);
 };
 
 /* invoked when sigchld is received and waitpid indicates the givne pid */

+/* revent EV_CHILD */

 struct ev_child
 {
   EV_WATCHER_LIST (ev_child);
 struct ev_child
 {
   EV_WATCHER_LIST (ev_child);


@@ -154,19 +167,21 @@ struct ev_child
   int status; /* rw, holds the exit status, use the macros from sys/wait.h */
 };
 
   int status; /* rw, holds the exit status, use the macros from sys/wait.h */
 };
 

-#define EVMETHOD_NONE   0
+#define EVMETHOD_AUTO   0 /* consults environment */

 #define EVMETHOD_SELECT 1
 #define EVMETHOD_SELECT 1

-#define EVMETHOD_EPOLL  2
+#define EVMETHOD_POLL   2
+#define EVMETHOD_EPOLL  4
+#define EVMETHOD_ANY    ~0 /* any method, do not consult env */

 #if EV_PROTOTYPES
 extern int ev_method;
 #if EV_PROTOTYPES
 extern int ev_method;

-int ev_init (int flags); /* returns ev_method */
+int ev_init (int methods); /* returns ev_method */

 int ev_version_major (void);
 int ev_version_minor (void);
 
 /* these three calls are suitable for plugging into pthread_atfork */
 int ev_version_major (void);
 int ev_version_minor (void);
 
 /* these three calls are suitable for plugging into pthread_atfork */

-void ev_prefork (void);
-void ev_postfork_parent (void);
-void ev_postfork_child (void);
+void ev_fork_prepare (void);
+void ev_fork_parent (void);
+void ev_fork_child (void);

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


@@ -184,56 +199,60 @@ void ev_once (int fd, int events, ev_tstamp timeout, void (*cb)(int revents, voi
 #endif
 
 /* these may evaluate ev multiple times, and the other arguments at most once */
 #endif
 
 /* these may evaluate ev multiple times, and the other arguments at most once */

-/* either use evw_init + evXXX_set, or the evXXX_init macro, below, to first initialise a watcher */
-#define evw_init(ev,cb_)                   do { (ev)->active = 0; (ev)->pending = 0; (ev)->cb = (cb_); } while (0)
-
-#define evio_set(ev,fd_,events_)           do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0)
-#define evtimer_set(ev,after_,repeat_)     do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)
-#define evperiodic_set(ev,at_,interval_)   do { (ev)->at = (at_); (ev)->interval = (interval_); } while (0)
-#define evsignal_set(ev,signum_)           do { (ev)->signum = (signum_); } while (0)
-#define evidle_set(ev)                     /* nop, yes, this is a serious in-joke */
-#define evprepare_set(ev)                  /* nop, yes, this is a serious in-joke */
-#define evcheck_set(ev)                    /* nop, yes, this is a serious in-joke */
-#define evchild_set(ev,pid_)               do { (ev)->pid = (pid_); } while (0)
-
-#define evio_init(ev,cb,fd,events)         do { evw_init ((ev), (cb)); evio_set ((ev),(fd),(events)); } while (0)
-#define evtimer_init(ev,cb,after,repeat)   do { evw_init ((ev), (cb)); evtimer_set ((ev),(after),(repeat)); } while (0)
-#define evperiodic_init(ev,cb,at,interval) do { evw_init ((ev), (cb)); evperiodic_set ((ev),(at),(interval)); } while (0)
-#define evsignal_init(ev,cb,signum)        do { evw_init ((ev), (cb)); evsignal_set ((ev), (signum)); } while (0)
-#define evidle_init(ev,cb)                 do { evw_init ((ev), (cb)); evidle_set ((ev)); } while (0)
-#define evprepare_init(ev,cb)              do { evw_init ((ev), (cb)); evprepare_set ((ev)); } while (0)
-#define evcheck_init(ev,cb)                do { evw_init ((ev), (cb)); evcheck_set ((ev)); } while (0)
-#define evchild_init(ev,cb,pid)            do { evw_init ((ev), (cb)); evchild_set ((ev),(pid)); } while (0)
+/* 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 = 0; (ev)->pending = 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_periodic_set(ev,at_,interval_)   do { (ev)->at = (at_); (ev)->interval = (interval_); } 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_check_set(ev)                    /* nop, yes, this is a serious in-joke */
+#define ev_child_set(ev,pid_)               do { (ev)->pid = (pid_); } 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_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 */
 
 /* 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
 
 #define ev_is_active(ev) (0 + (ev)->active) /* true when the watcher has been started */
 
 /* 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

-void evio_start       (struct ev_io *w);
-void evio_stop        (struct ev_io *w);
+void ev_io_start       (struct ev_io *w);
+void ev_io_stop        (struct ev_io *w);

 
 

-void evtimer_start    (struct ev_timer *w);
-void evtimer_stop     (struct ev_timer *w);
-void evtimer_again    (struct ev_timer *w); /* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
+void ev_timer_start    (struct ev_timer *w);
+void ev_timer_stop     (struct ev_timer *w);
+void ev_timer_again    (struct ev_timer *w); /* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */

 
 

-void evperiodic_start (struct ev_periodic *w);
-void evperiodic_stop  (struct ev_periodic *w);
+void ev_periodic_start (struct ev_periodic *w);
+void ev_periodic_stop  (struct ev_periodic *w);

 
 

-void evsignal_start   (struct ev_signal *w);
-void evsignal_stop    (struct ev_signal *w);
+void ev_signal_start   (struct ev_signal *w);
+void ev_signal_stop    (struct ev_signal *w);

 
 

-void evidle_start     (struct ev_idle *w);
-void evidle_stop      (struct ev_idle *w);
+void ev_idle_start     (struct ev_idle *w);
+void ev_idle_stop      (struct ev_idle *w);

 
 

-void evprepare_start  (struct ev_prepare *w);
-void evprepare_stop   (struct ev_prepare *w);
+void ev_prepare_start  (struct ev_prepare *w);
+void ev_prepare_stop   (struct ev_prepare *w);

 
 

-void evcheck_start    (struct ev_check *w);
-void evcheck_stop     (struct ev_check *w);
+void ev_check_start    (struct ev_check *w);
+void ev_check_stop     (struct ev_check *w);
+
+void ev_child_start    (struct ev_child *w);
+void ev_child_stop     (struct ev_child *w);
+#endif

 
 

-void evchild_start    (struct ev_child *w);
-void evchild_stop     (struct ev_child *w);
+#ifdef __cplusplus
+}

 #endif
 
 #endif
 #endif
 
 #endif