libev/ev.h

/*
 * 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.
 *
 *     * 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.
 */

#ifndef EV_H__
#define EV_H__

#ifdef __cplusplus
extern "C" {
#endif

typedef double ev_tstamp;

/* these priorities are inclusive, higher priorities will be called earlier */
#ifndef EV_MINPRI
# define EV_MINPRI -2
#endif
#ifndef EV_MAXPRI
# define EV_MAXPRI +2
#endif

#ifndef EV_MULTIPLICITY
# define EV_MULTIPLICITY 1
#endif

#ifndef EV_PERIODIC_ENABLE
# define EV_PERIODIC_ENABLE 1
#endif

#ifndef EV_STAT_ENABLE
# 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_EMBED_ENABLE
# define EV_EMBED_ENABLE 1
#endif

/*****************************************************************************/

#if EV_STAT_ENABLE
# include <sys/stat.h>
#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,
# define EV_DEFAULT ev_default_loop (0)
# define EV_DEFAULT_ EV_DEFAULT,
#else
# define EV_P void
# define EV_P_
# define EV_A
# define EV_A_
# define EV_DEFAULT
# define EV_DEFAULT_

# undef EV_EMBED_ENABLE
#endif

/* eventmask, revents, events... */
#define EV_UNDEF            -1L /* guaranteed to be invalid */
#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_CHILD    0x00000800L /* child/pid had status change */
#define EV_STAT     0x00001000L /* stat data changed */
#define EV_IDLE     0x00002000L /* event loop is idling */
#define EV_PREPARE  0x00004000L /* event loop about to poll */
#define EV_CHECK    0x00008000L /* event loop finished poll */
#define EV_EMBED    0x00010000L /* embedded event loop needs sweep */
#define EV_FORK     0x00020000L /* event loop resumed in child */
#define EV_ERROR    0x80000000L /* sent when an error occurs */

/* can be used to add custom fields to all watchers, while losing binary compatibility */
#ifndef EV_COMMON
# define EV_COMMON void *data;
#endif
#ifndef EV_PROTOTYPES
# define EV_PROTOTYPES 1
#endif

#define EV_VERSION_MAJOR 1
#define EV_VERSION_MINOR 0

#ifndef EV_CB_DECLARE
# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents);
#endif
#ifndef EV_CB_INVOKE
# define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents))
#endif

/*
 * struct member types:
 * private: you can look at them, but not change them, and they might not mean anything to you.
 * ro: can be read anytime, but only changed when the watcher isn't active
 * rw: can be read and modified anytime, even when the watcher is active
 */

/* shared by all watchers */
#define EV_WATCHER(type)                        \
  int active; /* private */                     \
  int pending; /* private */                    \
  int priority; /* private */                   \
  EV_COMMON /* rw */                            \
  EV_CB_DECLARE (type) /* private */

#define EV_WATCHER_LIST(type)                   \
  EV_WATCHER (type)                             \
  struct ev_watcher_list *next; /* private */

#define EV_WATCHER_TIME(type)                   \
  EV_WATCHER (type)                             \
  ev_tstamp at;     /* private */

/* base class, nothing to see here unless you subclass */
typedef struct ev_watcher
{
  EV_WATCHER (ev_watcher)
} ev_watcher;

/* base class, nothing to see here unless you subclass */
typedef struct ev_watcher_list
{
  EV_WATCHER_LIST (ev_watcher_list)
} ev_watcher_list;

/* base class, nothing to see here unless you subclass */
typedef struct ev_watcher_time
{
  EV_WATCHER_TIME (ev_watcher_time)
} ev_watcher_time;

/* invoked when fd is either EV_READable or EV_WRITEable */
/* revent EV_READ, EV_WRITE */
typedef struct ev_io
{
  EV_WATCHER_LIST (ev_io)

  int fd;     /* ro */
  int events; /* ro */
} ev_io;

/* invoked after a specific time, repeatable (based on monotonic clock) */
/* revent EV_TIMEOUT */
typedef struct ev_timer
{
  EV_WATCHER_TIME (ev_timer)

  ev_tstamp repeat; /* rw */
} ev_timer;

/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
/* revent EV_PERIODIC */
typedef struct 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;

/* invoked when the given signal has been received */
/* revent EV_SIGNAL */
typedef struct ev_signal
{
  EV_WATCHER_LIST (ev_signal)

  int signum; /* ro */
} ev_signal;

/* invoked when sigchld is received and waitpid indicates the given pid */
/* revent EV_CHILD */
/* does not support priorities */
typedef struct ev_child
{
  EV_WATCHER_LIST (ev_child)

  int pid;     /* ro */
  int rpid;    /* rw, holds the received pid */
  int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
} ev_child;

#if EV_STAT_ENABLE
/* st_nlink = 0 means missing file or other error */
# ifdef _WIN32
typedef struct _stati64 ev_statdata;
# else
typedef struct stat ev_statdata;
# endif

/* invoked each time the stat data changes for a given path */
/* revent EV_STAT */
typedef struct 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 */

  int wd; /* wd for inotify, fd for kqueue */
} 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;
#endif

/* 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 */
typedef struct ev_prepare
{
  EV_WATCHER (ev_prepare)
} ev_prepare;

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

#if EV_FORK_ENABLE
/* the callback gets invoked before check in the child process when a fork was detected */
typedef struct ev_fork
{
  EV_WATCHER (ev_fork)
} ev_fork;
#endif

#if EV_EMBED_ENABLE
/* used to embed an event loop inside another */
/* the callback gets invoked when the event loop has handled events, and can be 0 */
typedef struct ev_embed
{
  EV_WATCHER (ev_embed)

  ev_io io; /* private */
  struct ev_loop *other; /* ro */
} ev_embed;
#endif

/* 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_child child;
#if EV_STAT_ENABLE
  struct ev_stat stat;
#endif
#if EV_IDLE_ENABLE
  struct ev_idle idle;
#endif
  struct ev_prepare prepare;
  struct ev_check check;
#if EV_FORK_ENABLE
  struct ev_fork fork;
#endif
#if EV_EMBED_ENABLE
  struct ev_embed embed;
#endif
};

/* bits for ev_default_loop and ev_loop_new */
/* the default */
#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 */
#define EVBACKEND_EPOLL   0x00000004UL /* linux */
#define EVBACKEND_KQUEUE  0x00000008UL /* bsd */
#define EVBACKEND_DEVPOLL 0x00000010UL /* solaris 8 */ /* NYI */
#define EVBACKEND_PORT    0x00000020UL /* solaris 10 */

#if EV_PROTOTYPES
int ev_version_major (void);
int ev_version_minor (void);

unsigned int ev_supported_backends (void);
unsigned int ev_recommended_backends (void);
unsigned int ev_embeddable_backends (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 */
static struct ev_loop *
ev_default_loop (unsigned int flags)
{
  extern struct ev_loop *ev_default_loop_ptr;
  extern struct ev_loop *ev_default_loop_init (unsigned int flags);

  if (!ev_default_loop_ptr)
    ev_default_loop_init (flags);

  return ev_default_loop_ptr;
}

/* create and destroy alternative loops that don't handle signals */
struct ev_loop *ev_loop_new (unsigned int flags);
void ev_loop_destroy (EV_P);
void ev_loop_fork (EV_P);

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

# else

int ev_default_loop (unsigned int flags); /* returns true when successful */

static ev_tstamp
ev_now (void)
{
  extern ev_tstamp ev_rt_now;

  return ev_rt_now;
}
# 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);

unsigned int ev_backend (EV_P);
unsigned int ev_loop_count (EV_P);
#endif

#define EVLOOP_NONBLOCK 1 /* do not block/wait */
#define EVLOOP_ONESHOT  2 /* block *once* only */
#define EVUNLOOP_CANCEL 0 /* undo unloop */
#define EVUNLOOP_ONE    1 /* unloop once */
#define EVUNLOOP_ALL    2 /* unloop all loops */

#if EV_PROTOTYPES
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 */

/*
 * 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
 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
 */
void ev_ref   (EV_P);
void ev_unref (EV_P);

/* convinience function, wait for a single event, without registering an event watcher */
/* if timeout is < 0, do wait indefinitely */
void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
#endif

/* 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 {                    \
  ((ev_watcher *)(void *)(ev))->active   =      \
  ((ev_watcher *)(void *)(ev))->pending  =      \
  ((ev_watcher *)(void *)(ev))->priority = 0;   \
  ev_set_cb ((ev), cb_);                        \
} 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_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_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_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_timer_init(ev,cb,after,repeat)   do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } 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_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,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_priority(ev)                     ((((ev_watcher *)(void *)(ev))->priority) + 0)
#define ev_cb(ev)                           (ev)->cb /* rw */
#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_)
#endif

/* 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_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_timer_start    (EV_P_ ev_timer *w);
void ev_timer_stop     (EV_P_ ev_timer *w);
/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
void ev_timer_again    (EV_P_ ev_timer *w);

#if EV_PERIODIC_ENABLE
void ev_periodic_start (EV_P_ ev_periodic *w);
void ev_periodic_stop  (EV_P_ ev_periodic *w);
void ev_periodic_again (EV_P_ ev_periodic *w);
#endif

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

/* only supported in the default loop */
void ev_child_start    (EV_P_ ev_child *w);
void ev_child_stop     (EV_P_ ev_child *w);

# if EV_STAT_ENABLE
void ev_stat_start     (EV_P_ ev_stat *w);
void ev_stat_stop      (EV_P_ ev_stat *w);
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);
# endif

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

void ev_check_start    (EV_P_ ev_check *w);
void ev_check_stop     (EV_P_ ev_check *w);

# if EV_FORK_ENABLE
void ev_fork_start     (EV_P_ ev_fork *w);
void ev_fork_stop      (EV_P_ ev_fork *w);
# endif

# if EV_EMBED_ENABLE
/* only supported when loop to be embedded is in fact embeddable */
void ev_embed_start    (EV_P_ ev_embed *w);
void ev_embed_stop     (EV_P_ ev_embed *w);
void ev_embed_sweep    (EV_P_ ev_embed *w);
# endif

#endif

#ifdef __cplusplus
}
#endif

#endif

Revision:	1.86
Committed:	Thu Dec 20 07:12:57 2007 UTC (16 years, 4 months ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.85:	+3 -3 lines
Log Message:	* empty log message *
#	User	Rev	Content
1	root	1.10	/*
2			* Copyright (c) 2007 Marc Alexander Lehmann <libev@schmorp.de>
3			* All rights reserved.
4			*
5			* Redistribution and use in source and binary forms, with or without
6			* modification, are permitted provided that the following conditions are
7			* met:
8			*
9			* * Redistributions of source code must retain the above copyright
10			* notice, this list of conditions and the following disclaimer.
11			*
12			* * Redistributions in binary form must reproduce the above
13			* copyright notice, this list of conditions and the following
14			* disclaimer in the documentation and/or other materials provided
15			* with the distribution.
16			*
17			* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18			* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19			* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20			* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21			* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22			* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23			* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24			* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25			* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26			* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27			* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28			*/
29
30	root	1.43	#ifndef EV_H__
31			#define EV_H__
32	root	1.1
33	root	1.19	#ifdef __cplusplus
34			extern "C" {
35			#endif
36
37	root	1.1	typedef double ev_tstamp;
38
39	root	1.21	/* these priorities are inclusive, higher priorities will be called earlier */
40			#ifndef EV_MINPRI
41			# define EV_MINPRI -2
42			#endif
43			#ifndef EV_MAXPRI
44			# define EV_MAXPRI +2
45			#endif
46
47	root	1.29	#ifndef EV_MULTIPLICITY
48			# define EV_MULTIPLICITY 1
49			#endif
50
51	root	1.69	#ifndef EV_PERIODIC_ENABLE
52			# define EV_PERIODIC_ENABLE 1
53			#endif
54
55			#ifndef EV_STAT_ENABLE
56			# define EV_STAT_ENABLE 1
57			#endif
58
59	root	1.78	#ifndef EV_IDLE_ENABLE
60			# define EV_IDLE_ENABLE 1
61			#endif
62
63	root	1.72	#ifndef EV_FORK_ENABLE
64			# define EV_FORK_ENABLE 1
65			#endif
66
67	root	1.69	#ifndef EV_EMBED_ENABLE
68			# define EV_EMBED_ENABLE 1
69			#endif
70
71			/*****************************************************************************/
72
73			#if EV_STAT_ENABLE
74			# include <sys/stat.h>
75	root	1.50	#endif
76
77	root	1.28	/* support multiple event loops? */
78	root	1.29	#if EV_MULTIPLICITY
79	root	1.28	struct ev_loop;
80			# define EV_P struct ev_loop *loop
81			# define EV_P_ EV_P,
82			# define EV_A loop
83			# define EV_A_ EV_A,
84	root	1.72	# define EV_DEFAULT ev_default_loop (0)
85			# define EV_DEFAULT_ EV_DEFAULT,
86	root	1.28	#else
87			# define EV_P void
88			# define EV_P_
89			# define EV_A
90			# define EV_A_
91	root	1.72	# define EV_DEFAULT
92			# define EV_DEFAULT_
93	root	1.69
94			# undef EV_EMBED_ENABLE
95	root	1.28	#endif
96	root	1.27
97	root	1.1	/* eventmask, revents, events... */
98	root	1.69	#define EV_UNDEF -1L /* guaranteed to be invalid */
99			#define EV_NONE 0x00L /* no events */
100			#define EV_READ 0x01L /* ev_io detected read will not block */
101			#define EV_WRITE 0x02L /* ev_io detected write will not block */
102	root	1.84	#define EV_IOFDSET 0x80L /* internal use only */
103	root	1.69	#define EV_TIMEOUT 0x00000100L /* timer timed out */
104			#define EV_PERIODIC 0x00000200L /* periodic timer timed out */
105			#define EV_SIGNAL 0x00000400L /* signal was received */
106	root	1.72	#define EV_CHILD 0x00000800L /* child/pid had status change */
107			#define EV_STAT 0x00001000L /* stat data changed */
108			#define EV_IDLE 0x00002000L /* event loop is idling */
109			#define EV_PREPARE 0x00004000L /* event loop about to poll */
110			#define EV_CHECK 0x00008000L /* event loop finished poll */
111			#define EV_EMBED 0x00010000L /* embedded event loop needs sweep */
112			#define EV_FORK 0x00020000L /* event loop resumed in child */
113	root	1.69	#define EV_ERROR 0x80000000L /* sent when an error occurs */
114	root	1.1
115	root	1.51	/* can be used to add custom fields to all watchers, while losing binary compatibility */
116	root	1.6	#ifndef EV_COMMON
117	root	1.52	# define EV_COMMON void *data;
118	root	1.6	#endif
119	root	1.9	#ifndef EV_PROTOTYPES
120			# define EV_PROTOTYPES 1
121			#endif
122	root	1.6
123	root	1.85	#define EV_VERSION_MAJOR 1
124	root	1.83	#define EV_VERSION_MINOR 0
125	root	1.14
126	root	1.44	#ifndef EV_CB_DECLARE
127	root	1.46	# define EV_CB_DECLARE(type) void (cb)(EV_P_ struct type w, int revents);
128	root	1.44	#endif
129			#ifndef EV_CB_INVOKE
130			# define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents))
131			#endif
132
133	root	1.6	/*
134			* struct member types:
135			* private: you can look at them, but not change them, and they might not mean anything to you.
136			* ro: can be read anytime, but only changed when the watcher isn't active
137			* rw: can be read and modified anytime, even when the watcher is active
138			*/
139
140	root	1.1	/* shared by all watchers */
141			#define EV_WATCHER(type) \
142			int active; /* private */ \
143			int pending; /* private */ \
144	root	1.32	int priority; /* private */ \
145	root	1.52	EV_COMMON /* rw */ \
146	root	1.44	EV_CB_DECLARE (type) /* private */
147	root	1.1
148			#define EV_WATCHER_LIST(type) \
149	root	1.52	EV_WATCHER (type) \
150			struct ev_watcher_list next; / private */
151	root	1.1
152	root	1.6	#define EV_WATCHER_TIME(type) \
153	root	1.52	EV_WATCHER (type) \
154			ev_tstamp at; /* private */
155	root	1.6
156	root	1.7	/* base class, nothing to see here unless you subclass */
157	root	1.66	typedef struct ev_watcher
158	root	1.44	{
159	root	1.52	EV_WATCHER (ev_watcher)
160	root	1.66	} ev_watcher;
161	root	1.7
162			/* base class, nothing to see here unless you subclass */
163	root	1.66	typedef struct ev_watcher_list
164	root	1.44	{
165	root	1.52	EV_WATCHER_LIST (ev_watcher_list)
166	root	1.66	} ev_watcher_list;
167	root	1.7
168			/* base class, nothing to see here unless you subclass */
169	root	1.66	typedef struct ev_watcher_time
170	root	1.44	{
171	root	1.52	EV_WATCHER_TIME (ev_watcher_time)
172	root	1.66	} ev_watcher_time;
173	root	1.7
174	root	1.70	/* invoked when fd is either EV_READable or EV_WRITEable */
175			/* revent EV_READ, EV_WRITE */
176			typedef struct ev_io
177			{
178			EV_WATCHER_LIST (ev_io)
179
180			int fd; /* ro */
181			int events; /* ro */
182			} ev_io;
183
184	root	1.6	/* invoked after a specific time, repeatable (based on monotonic clock) */
185	root	1.17	/* revent EV_TIMEOUT */
186	root	1.66	typedef struct ev_timer
187	root	1.1	{
188	root	1.52	EV_WATCHER_TIME (ev_timer)
189	root	1.1
190			ev_tstamp repeat; /* rw */
191	root	1.66	} ev_timer;
192	root	1.6
193			/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
194	root	1.17	/* revent EV_PERIODIC */
195	root	1.66	typedef struct ev_periodic
196	root	1.6	{
197	root	1.52	EV_WATCHER_TIME (ev_periodic)
198	root	1.6
199	root	1.82	ev_tstamp offset; /* rw */
200	root	1.6	ev_tstamp interval; /* rw */
201	root	1.40	ev_tstamp (reschedule_cb)(struct ev_periodic w, ev_tstamp now); /* rw */
202	root	1.66	} ev_periodic;
203	root	1.1
204	root	1.5	/* invoked when the given signal has been received */
205	root	1.17	/* revent EV_SIGNAL */
206	root	1.66	typedef struct ev_signal
207	root	1.1	{
208	root	1.52	EV_WATCHER_LIST (ev_signal)
209	root	1.1
210			int signum; /* ro */
211	root	1.66	} ev_signal;
212	root	1.1
213	root	1.70	/* invoked when sigchld is received and waitpid indicates the given pid */
214			/* revent EV_CHILD */
215			/* does not support priorities */
216			typedef struct ev_child
217			{
218			EV_WATCHER_LIST (ev_child)
219
220			int pid; /* ro */
221			int rpid; /* rw, holds the received pid */
222			int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
223			} ev_child;
224
225			#if EV_STAT_ENABLE
226			/* st_nlink = 0 means missing file or other error */
227	root	1.74	# ifdef _WIN32
228	root	1.71	typedef struct _stati64 ev_statdata;
229	root	1.74	# else
230	root	1.70	typedef struct stat ev_statdata;
231	root	1.74	# endif
232	root	1.70
233			/* invoked each time the stat data changes for a given path */
234			/* revent EV_STAT */
235			typedef struct ev_stat
236			{
237	root	1.74	EV_WATCHER_LIST (ev_stat)
238	root	1.70
239			ev_timer timer; /* private */
240			ev_tstamp interval; /* ro */
241			const char path; / ro */
242			ev_statdata prev; /* ro */
243			ev_statdata attr; /* ro */
244	root	1.74
245			int wd; /* wd for inotify, fd for kqueue */
246	root	1.70	} ev_stat;
247			#endif
248
249	root	1.78	#if EV_IDLE_ENABLE
250	root	1.5	/* invoked when the nothing else needs to be done, keeps the process from blocking */
251	root	1.17	/* revent EV_IDLE */
252	root	1.66	typedef struct ev_idle
253	root	1.5	{
254	root	1.52	EV_WATCHER (ev_idle)
255	root	1.66	} ev_idle;
256	root	1.78	#endif
257	root	1.5
258	root	1.11	/* invoked for each run of the mainloop, just before the blocking call */
259			/* you can still change events in any way you like */
260	root	1.17	/* revent EV_PREPARE */
261	root	1.66	typedef struct ev_prepare
262	root	1.11	{
263	root	1.52	EV_WATCHER (ev_prepare)
264	root	1.66	} ev_prepare;
265	root	1.11
266			/* invoked for each run of the mainloop, just after the blocking call */
267	root	1.17	/* revent EV_CHECK */
268	root	1.66	typedef struct ev_check
269	root	1.5	{
270	root	1.52	EV_WATCHER (ev_check)
271	root	1.66	} ev_check;
272	root	1.5
273	root	1.72	#if EV_FORK_ENABLE
274			/* the callback gets invoked before check in the child process when a fork was detected */
275			typedef struct ev_fork
276			{
277			EV_WATCHER (ev_fork)
278			} ev_fork;
279			#endif
280
281	root	1.69	#if EV_EMBED_ENABLE
282	root	1.64	/* used to embed an event loop inside another */
283			/* the callback gets invoked when the event loop has handled events, and can be 0 */
284	root	1.66	typedef struct ev_embed
285	root	1.64	{
286			EV_WATCHER (ev_embed)
287
288	root	1.66	ev_io io; /* private */
289	root	1.86	struct ev_loop other; / ro */
290	root	1.66	} ev_embed;
291	root	1.64	#endif
292
293	root	1.41	/* the presence of this union forces similar struct layout */
294	root	1.35	union ev_any_watcher
295			{
296			struct ev_watcher w;
297			struct ev_watcher_list wl;
298	root	1.46
299	root	1.35	struct ev_io io;
300			struct ev_timer timer;
301			struct ev_periodic periodic;
302	root	1.72	struct ev_signal signal;
303	root	1.70	struct ev_child child;
304			#if EV_STAT_ENABLE
305			struct ev_stat stat;
306			#endif
307	root	1.78	#if EV_IDLE_ENABLE
308	root	1.35	struct ev_idle idle;
309	root	1.78	#endif
310	root	1.35	struct ev_prepare prepare;
311			struct ev_check check;
312	root	1.72	#if EV_FORK_ENABLE
313			struct ev_fork fork;
314			#endif
315	root	1.69	#if EV_EMBED_ENABLE
316	root	1.64	struct ev_embed embed;
317	root	1.67	#endif
318	root	1.35	};
319
320	root	1.53	/* bits for ev_default_loop and ev_loop_new */
321			/* the default */
322	root	1.63	#define EVFLAG_AUTO 0x00000000UL /* not quite a mask */
323			/* flag bits */
324			#define EVFLAG_NOENV 0x01000000UL /* do NOT consult environment */
325	root	1.76	#define EVFLAG_FORKCHECK 0x02000000UL /* check for a fork in each iteration */
326	root	1.53	/* method bits to be ored together */
327	root	1.63	#define EVBACKEND_SELECT 0x00000001UL /* about anywhere */
328			#define EVBACKEND_POLL 0x00000002UL /* !win */
329			#define EVBACKEND_EPOLL 0x00000004UL /* linux */
330			#define EVBACKEND_KQUEUE 0x00000008UL /* bsd */
331			#define EVBACKEND_DEVPOLL 0x00000010UL /* solaris 8 / / NYI */
332			#define EVBACKEND_PORT 0x00000020UL /* solaris 10 */
333	root	1.29
334	root	1.9	#if EV_PROTOTYPES
335	root	1.14	int ev_version_major (void);
336			int ev_version_minor (void);
337	root	1.1
338	root	1.63	unsigned int ev_supported_backends (void);
339			unsigned int ev_recommended_backends (void);
340	root	1.64	unsigned int ev_embeddable_backends (void);
341	root	1.63
342	root	1.1	ev_tstamp ev_time (void);
343	root	1.29
344	root	1.36	/* Sets the allocation function to use, works like realloc.
345			* It is used to allocate and free memory.
346			* If it returns zero when memory needs to be allocated, the library might abort
347			* or take some potentially destructive action.
348			* The default is your system realloc function.
349			*/
350	root	1.75	void ev_set_allocator (void (cb)(void *ptr, long size));
351	root	1.36
352			/* set the callback function to call on a
353			* retryable syscall error
354			* (such as failed select, poll, epoll_wait)
355			*/
356	root	1.37	void ev_set_syserr_cb (void (cb)(const char msg));
357	root	1.36
358	root	1.29	# if EV_MULTIPLICITY
359	root	1.30	/* the default loop is the only one that handles signals and child watchers */
360			/* you can call this as often as you like */
361	root	1.58	static struct ev_loop *
362			ev_default_loop (unsigned int flags)
363			{
364			extern struct ev_loop *ev_default_loop_ptr;
365	root	1.61	extern struct ev_loop *ev_default_loop_init (unsigned int flags);
366	root	1.58
367			if (!ev_default_loop_ptr)
368	root	1.60	ev_default_loop_init (flags);
369	root	1.58
370			return ev_default_loop_ptr;
371			}
372	root	1.30
373			/* create and destroy alternative loops that don't handle signals */
374	root	1.53	struct ev_loop *ev_loop_new (unsigned int flags);
375	root	1.30	void ev_loop_destroy (EV_P);
376			void ev_loop_fork (EV_P);
377	root	1.47
378			ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
379
380	root	1.29	# else
381	root	1.47
382	root	1.54	int ev_default_loop (unsigned int flags); /* returns true when successful */
383	root	1.47
384			static ev_tstamp
385	root	1.52	ev_now (void)
386	root	1.47	{
387	root	1.48	extern ev_tstamp ev_rt_now;
388	root	1.47
389			return ev_rt_now;
390			}
391	root	1.29	# endif
392
393	root	1.30	void ev_default_destroy (void); /* destroy the default loop */
394			/* this needs to be called after fork, to duplicate the default loop */
395			/* if you create alternative loops you have to call ev_loop_fork on them */
396			/* you can call it in either the parent or the child */
397			/* you can actually call it at any time, anywhere :) */
398			void ev_default_fork (void);
399
400	root	1.63	unsigned int ev_backend (EV_P);
401	root	1.77	unsigned int ev_loop_count (EV_P);
402	root	1.9	#endif
403	root	1.1
404			#define EVLOOP_NONBLOCK 1 /* do not block/wait */
405			#define EVLOOP_ONESHOT 2 /* block once only */
406	root	1.65	#define EVUNLOOP_CANCEL 0 /* undo unloop */
407	root	1.57	#define EVUNLOOP_ONE 1 /* unloop once */
408	root	1.29	#define EVUNLOOP_ALL 2 /* unloop all loops */
409
410	root	1.9	#if EV_PROTOTYPES
411	root	1.27	void ev_loop (EV_P_ int flags);
412	root	1.29	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 */
413	root	1.27
414			/*
415			* ref/unref can be used to add or remove a refcount on the mainloop. every watcher
416			* keeps one reference. if you have a long-runing watcher you never unregister that
417			* should not keep ev_loop from running, unref() after starting, and ref() before stopping.
418			*/
419			void ev_ref (EV_P);
420			void ev_unref (EV_P);
421	root	1.1
422	root	1.9	/* convinience function, wait for a single event, without registering an event watcher */
423			/* if timeout is < 0, do wait indefinitely */
424	root	1.27	void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (cb)(int revents, void arg), void *arg);
425	root	1.9	#endif
426
427	root	1.2	/* these may evaluate ev multiple times, and the other arguments at most once */
428	root	1.45	/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
429	root	1.78	#define ev_init(ev,cb_) do { \
430	root	1.66	((ev_watcher )(void )(ev))->active = \
431			((ev_watcher )(void )(ev))->pending = \
432			((ev_watcher )(void )(ev))->priority = 0; \
433	root	1.78	ev_set_cb ((ev), cb_); \
434	root	1.32	} while (0)
435	root	1.3
436	root	1.84	#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) \| EV_IOFDSET; } while (0)
437	root	1.16	#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)
438	root	1.82	#define ev_periodic_set(ev,ofs_,ival_,res_) do { (ev)->offset = (ofs_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0)
439	root	1.16	#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
440	root	1.70	#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0)
441	root	1.74	#define ev_stat_set(ev,path_,interval_) do { (ev)->path = (path_); (ev)->interval = (interval_); (ev)->wd = -2; } while (0)
442	root	1.16	#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
443			#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
444			#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
445	root	1.86	#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0)
446	root	1.72	#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */
447	root	1.16
448	root	1.45	#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
449			#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
450			#define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0)
451			#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
452	root	1.70	#define ev_child_init(ev,cb,pid) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)
453			#define ev_stat_init(ev,cb,path,interval) do { ev_init ((ev), (cb)); ev_path_set ((ev),(path),(interval)); } while (0)
454	root	1.45	#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
455			#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
456			#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
457	root	1.86	#define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0)
458	root	1.72	#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0)
459	root	1.1
460	root	1.66	#define ev_is_pending(ev) (0 + ((ev_watcher )(void )(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
461			#define ev_is_active(ev) (0 + ((ev_watcher )(void )(ev))->active) /* ro, true when the watcher has been started */
462	root	1.32
463	root	1.78	#define ev_priority(ev) ((((ev_watcher )(void )(ev))->priority) + 0)
464	root	1.33	#define ev_cb(ev) (ev)->cb /* rw */
465	root	1.78	#define ev_set_priority(ev,pri) ((ev_watcher )(void )(ev))->priority = (pri)
466	root	1.45
467			#ifndef ev_set_cb
468			# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
469			#endif
470	root	1.1
471	root	1.5	/* stopping (enabling, adding) a watcher does nothing if it is already running */
472			/* stopping (disabling, deleting) a watcher does nothing unless its already running */
473	root	1.9	#if EV_PROTOTYPES
474	root	1.41
475			/* feeds an event into a watcher as if the event actually occured */
476			/* accepts any ev_watcher type */
477			void ev_feed_event (EV_P_ void *w, int revents);
478	root	1.42	void ev_feed_fd_event (EV_P_ int fd, int revents);
479			void ev_feed_signal_event (EV_P_ int signum);
480	root	1.81	void ev_invoke (EV_P_ void *w, int revents);
481	root	1.80	int ev_clear_pending (EV_P_ void *w);
482	root	1.41
483	root	1.66	void ev_io_start (EV_P_ ev_io *w);
484			void ev_io_stop (EV_P_ ev_io *w);
485	root	1.6
486	root	1.66	void ev_timer_start (EV_P_ ev_timer *w);
487			void ev_timer_stop (EV_P_ ev_timer *w);
488	root	1.30	/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
489	root	1.66	void ev_timer_again (EV_P_ ev_timer *w);
490	root	1.1
491	root	1.69	#if EV_PERIODIC_ENABLE
492	root	1.66	void ev_periodic_start (EV_P_ ev_periodic *w);
493			void ev_periodic_stop (EV_P_ ev_periodic *w);
494			void ev_periodic_again (EV_P_ ev_periodic *w);
495	root	1.50	#endif
496	root	1.1
497	root	1.70	/* only supported in the default loop */
498			void ev_signal_start (EV_P_ ev_signal *w);
499			void ev_signal_stop (EV_P_ ev_signal *w);
500
501			/* only supported in the default loop */
502			void ev_child_start (EV_P_ ev_child *w);
503			void ev_child_stop (EV_P_ ev_child *w);
504
505			# if EV_STAT_ENABLE
506			void ev_stat_start (EV_P_ ev_stat *w);
507			void ev_stat_stop (EV_P_ ev_stat *w);
508			void ev_stat_stat (EV_P_ ev_stat *w);
509			# endif
510
511	root	1.78	# if EV_IDLE_ENABLE
512	root	1.66	void ev_idle_start (EV_P_ ev_idle *w);
513			void ev_idle_stop (EV_P_ ev_idle *w);
514	root	1.78	# endif
515	root	1.5
516	root	1.66	void ev_prepare_start (EV_P_ ev_prepare *w);
517			void ev_prepare_stop (EV_P_ ev_prepare *w);
518	root	1.11
519	root	1.66	void ev_check_start (EV_P_ ev_check *w);
520			void ev_check_stop (EV_P_ ev_check *w);
521	root	1.12
522	root	1.72	# if EV_FORK_ENABLE
523			void ev_fork_start (EV_P_ ev_fork *w);
524			void ev_fork_stop (EV_P_ ev_fork *w);
525			# endif
526
527	root	1.69	# if EV_EMBED_ENABLE
528	root	1.64	/* only supported when loop to be embedded is in fact embeddable */
529	root	1.66	void ev_embed_start (EV_P_ ev_embed *w);
530			void ev_embed_stop (EV_P_ ev_embed *w);
531	root	1.68	void ev_embed_sweep (EV_P_ ev_embed *w);
532	root	1.64	# endif
533
534	root	1.9	#endif
535	root	1.5
536	root	1.19	#ifdef __cplusplus
537			}
538			#endif
539
540	root	1.1	#endif
541