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_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_A ev_default_loop (0)
# define EV_DEFAULT_A_ EV_DEFAULT_A,
#else
# define EV_P void
# define EV_P_
# define EV_A
# define EV_A_
# define EV_DEFAULT_A
# define EV_DEFAULT_A_

# 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_TIMEOUT  0x00000100L /* timer timed out */
#define EV_PERIODIC 0x00000200L /* periodic timer timed out */
#define EV_SIGNAL   0x00000400L /* signal was received */
#define EV_IDLE     0x00000800L /* event loop is idling */
#define EV_PREPARE  0x00001000L /* event loop about to poll */
#define EV_CHECK    0x00002000L /* event loop finished poll */
#define EV_CHILD    0x00004000L /* child/pid had status change */
#define EV_EMBED    0x00008000L /* embedded event loop needs sweep */
#define EV_STAT     0x00010000L /* stat data changed */
#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 1

#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 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 */
typedef struct stat ev_statdata;

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

  ev_timer timer;     /* private */
  ev_tstamp interval; /* ro */
  const char *path;   /* ro */
  ev_statdata prev;   /* ro */
  ev_statdata attr;   /* ro */
} ev_stat;
#endif

/* 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 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_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 *loop; /* 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_child child;
#if EV_STAT_ENABLE
  struct ev_stat stat;
#endif
  struct ev_idle idle;
  struct ev_prepare prepare;
  struct ev_check check;
  struct ev_signal signal;
#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 */
/* 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);
#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_); } 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_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_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_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,loop)           do { ev_init ((ev), (cb)); ev_embed_set ((ev),(loop)); } 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_cb(ev)                           (ev)->cb /* rw */
#define ev_set_priority(ev,pri)             ev_priority (ev) = (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_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

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

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_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.70
Committed:	Tue Nov 27 08:11:52 2007 UTC (16 years, 5 months ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.69:	+62 -62 lines
Log Message:	add member documentation
#	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			#ifndef EV_EMBED_ENABLE
60			# define EV_EMBED_ENABLE 1
61			#endif
62
63			/*****************************************************************************/
64
65			#if EV_STAT_ENABLE
66			# include <sys/stat.h>
67	root	1.50	#endif
68
69	root	1.28	/* support multiple event loops? */
70	root	1.29	#if EV_MULTIPLICITY
71	root	1.28	struct ev_loop;
72			# define EV_P struct ev_loop *loop
73			# define EV_P_ EV_P,
74			# define EV_A loop
75			# define EV_A_ EV_A,
76	root	1.49	# define EV_DEFAULT_A ev_default_loop (0)
77			# define EV_DEFAULT_A_ EV_DEFAULT_A,
78	root	1.28	#else
79			# define EV_P void
80			# define EV_P_
81			# define EV_A
82			# define EV_A_
83	root	1.49	# define EV_DEFAULT_A
84			# define EV_DEFAULT_A_
85	root	1.69
86			# undef EV_EMBED_ENABLE
87	root	1.28	#endif
88	root	1.27
89	root	1.1	/* eventmask, revents, events... */
90	root	1.69	#define EV_UNDEF -1L /* guaranteed to be invalid */
91			#define EV_NONE 0x00L /* no events */
92			#define EV_READ 0x01L /* ev_io detected read will not block */
93			#define EV_WRITE 0x02L /* ev_io detected write will not block */
94			#define EV_TIMEOUT 0x00000100L /* timer timed out */
95			#define EV_PERIODIC 0x00000200L /* periodic timer timed out */
96			#define EV_SIGNAL 0x00000400L /* signal was received */
97			#define EV_IDLE 0x00000800L /* event loop is idling */
98			#define EV_PREPARE 0x00001000L /* event loop about to poll */
99			#define EV_CHECK 0x00002000L /* event loop finished poll */
100			#define EV_CHILD 0x00004000L /* child/pid had status change */
101			#define EV_EMBED 0x00008000L /* embedded event loop needs sweep */
102			#define EV_STAT 0x00010000L /* stat data changed */
103			#define EV_ERROR 0x80000000L /* sent when an error occurs */
104	root	1.1
105	root	1.51	/* can be used to add custom fields to all watchers, while losing binary compatibility */
106	root	1.6	#ifndef EV_COMMON
107	root	1.52	# define EV_COMMON void *data;
108	root	1.6	#endif
109	root	1.9	#ifndef EV_PROTOTYPES
110			# define EV_PROTOTYPES 1
111			#endif
112	root	1.6
113	root	1.14	#define EV_VERSION_MAJOR 1
114			#define EV_VERSION_MINOR 1
115
116	root	1.44	#ifndef EV_CB_DECLARE
117	root	1.46	# define EV_CB_DECLARE(type) void (cb)(EV_P_ struct type w, int revents);
118	root	1.44	#endif
119			#ifndef EV_CB_INVOKE
120			# define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents))
121			#endif
122
123	root	1.6	/*
124			* struct member types:
125			* private: you can look at them, but not change them, and they might not mean anything to you.
126			* ro: can be read anytime, but only changed when the watcher isn't active
127			* rw: can be read and modified anytime, even when the watcher is active
128			*/
129
130	root	1.1	/* shared by all watchers */
131			#define EV_WATCHER(type) \
132			int active; /* private */ \
133			int pending; /* private */ \
134	root	1.32	int priority; /* private */ \
135	root	1.52	EV_COMMON /* rw */ \
136	root	1.44	EV_CB_DECLARE (type) /* private */
137	root	1.1
138			#define EV_WATCHER_LIST(type) \
139	root	1.52	EV_WATCHER (type) \
140			struct ev_watcher_list next; / private */
141	root	1.1
142	root	1.6	#define EV_WATCHER_TIME(type) \
143	root	1.52	EV_WATCHER (type) \
144			ev_tstamp at; /* private */
145	root	1.6
146	root	1.7	/* base class, nothing to see here unless you subclass */
147	root	1.66	typedef struct ev_watcher
148	root	1.44	{
149	root	1.52	EV_WATCHER (ev_watcher)
150	root	1.66	} ev_watcher;
151	root	1.7
152			/* base class, nothing to see here unless you subclass */
153	root	1.66	typedef struct ev_watcher_list
154	root	1.44	{
155	root	1.52	EV_WATCHER_LIST (ev_watcher_list)
156	root	1.66	} ev_watcher_list;
157	root	1.7
158			/* base class, nothing to see here unless you subclass */
159	root	1.66	typedef struct ev_watcher_time
160	root	1.44	{
161	root	1.52	EV_WATCHER_TIME (ev_watcher_time)
162	root	1.66	} ev_watcher_time;
163	root	1.7
164	root	1.70	/* invoked when fd is either EV_READable or EV_WRITEable */
165			/* revent EV_READ, EV_WRITE */
166			typedef struct ev_io
167			{
168			EV_WATCHER_LIST (ev_io)
169
170			int fd; /* ro */
171			int events; /* ro */
172			} ev_io;
173
174	root	1.6	/* invoked after a specific time, repeatable (based on monotonic clock) */
175	root	1.17	/* revent EV_TIMEOUT */
176	root	1.66	typedef struct ev_timer
177	root	1.1	{
178	root	1.52	EV_WATCHER_TIME (ev_timer)
179	root	1.1
180			ev_tstamp repeat; /* rw */
181	root	1.66	} ev_timer;
182	root	1.6
183			/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
184	root	1.17	/* revent EV_PERIODIC */
185	root	1.66	typedef struct ev_periodic
186	root	1.6	{
187	root	1.52	EV_WATCHER_TIME (ev_periodic)
188	root	1.6
189			ev_tstamp interval; /* rw */
190	root	1.40	ev_tstamp (reschedule_cb)(struct ev_periodic w, ev_tstamp now); /* rw */
191	root	1.66	} ev_periodic;
192	root	1.1
193	root	1.5	/* invoked when the given signal has been received */
194	root	1.17	/* revent EV_SIGNAL */
195	root	1.66	typedef struct ev_signal
196	root	1.1	{
197	root	1.52	EV_WATCHER_LIST (ev_signal)
198	root	1.1
199			int signum; /* ro */
200	root	1.66	} ev_signal;
201	root	1.1
202	root	1.70	/* invoked when sigchld is received and waitpid indicates the given pid */
203			/* revent EV_CHILD */
204			/* does not support priorities */
205			typedef struct ev_child
206			{
207			EV_WATCHER_LIST (ev_child)
208
209			int pid; /* ro */
210			int rpid; /* rw, holds the received pid */
211			int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
212			} ev_child;
213
214			#if EV_STAT_ENABLE
215			/* st_nlink = 0 means missing file or other error */
216			typedef struct stat ev_statdata;
217
218			/* invoked each time the stat data changes for a given path */
219			/* revent EV_STAT */
220			typedef struct ev_stat
221			{
222			EV_WATCHER (ev_stat)
223
224			ev_timer timer; /* private */
225			ev_tstamp interval; /* ro */
226			const char path; / ro */
227			ev_statdata prev; /* ro */
228			ev_statdata attr; /* ro */
229			} ev_stat;
230			#endif
231
232	root	1.5	/* invoked when the nothing else needs to be done, keeps the process from blocking */
233	root	1.17	/* revent EV_IDLE */
234	root	1.66	typedef struct ev_idle
235	root	1.5	{
236	root	1.52	EV_WATCHER (ev_idle)
237	root	1.66	} ev_idle;
238	root	1.5
239	root	1.11	/* invoked for each run of the mainloop, just before the blocking call */
240			/* you can still change events in any way you like */
241	root	1.17	/* revent EV_PREPARE */
242	root	1.66	typedef struct ev_prepare
243	root	1.11	{
244	root	1.52	EV_WATCHER (ev_prepare)
245	root	1.66	} ev_prepare;
246	root	1.11
247			/* invoked for each run of the mainloop, just after the blocking call */
248	root	1.17	/* revent EV_CHECK */
249	root	1.66	typedef struct ev_check
250	root	1.5	{
251	root	1.52	EV_WATCHER (ev_check)
252	root	1.66	} ev_check;
253	root	1.5
254	root	1.69	#if EV_EMBED_ENABLE
255	root	1.64	/* used to embed an event loop inside another */
256			/* the callback gets invoked when the event loop has handled events, and can be 0 */
257	root	1.66	typedef struct ev_embed
258	root	1.64	{
259			EV_WATCHER (ev_embed)
260
261	root	1.66	ev_io io; /* private */
262	root	1.64	struct ev_loop loop; / ro */
263	root	1.66	} ev_embed;
264	root	1.64	#endif
265
266	root	1.41	/* the presence of this union forces similar struct layout */
267	root	1.35	union ev_any_watcher
268			{
269			struct ev_watcher w;
270			struct ev_watcher_list wl;
271	root	1.46
272	root	1.35	struct ev_io io;
273			struct ev_timer timer;
274			struct ev_periodic periodic;
275	root	1.70	struct ev_child child;
276			#if EV_STAT_ENABLE
277			struct ev_stat stat;
278			#endif
279	root	1.35	struct ev_idle idle;
280			struct ev_prepare prepare;
281			struct ev_check check;
282	root	1.46	struct ev_signal signal;
283	root	1.69	#if EV_EMBED_ENABLE
284	root	1.64	struct ev_embed embed;
285	root	1.67	#endif
286	root	1.35	};
287
288	root	1.53	/* bits for ev_default_loop and ev_loop_new */
289			/* the default */
290	root	1.63	#define EVFLAG_AUTO 0x00000000UL /* not quite a mask */
291			/* flag bits */
292			#define EVFLAG_NOENV 0x01000000UL /* do NOT consult environment */
293	root	1.53	/* method bits to be ored together */
294	root	1.63	#define EVBACKEND_SELECT 0x00000001UL /* about anywhere */
295			#define EVBACKEND_POLL 0x00000002UL /* !win */
296			#define EVBACKEND_EPOLL 0x00000004UL /* linux */
297			#define EVBACKEND_KQUEUE 0x00000008UL /* bsd */
298			#define EVBACKEND_DEVPOLL 0x00000010UL /* solaris 8 / / NYI */
299			#define EVBACKEND_PORT 0x00000020UL /* solaris 10 */
300	root	1.29
301	root	1.9	#if EV_PROTOTYPES
302	root	1.14	int ev_version_major (void);
303			int ev_version_minor (void);
304	root	1.1
305	root	1.63	unsigned int ev_supported_backends (void);
306			unsigned int ev_recommended_backends (void);
307	root	1.64	unsigned int ev_embeddable_backends (void);
308	root	1.63
309	root	1.1	ev_tstamp ev_time (void);
310	root	1.29
311	root	1.36	/* Sets the allocation function to use, works like realloc.
312			* It is used to allocate and free memory.
313			* If it returns zero when memory needs to be allocated, the library might abort
314			* or take some potentially destructive action.
315			* The default is your system realloc function.
316			*/
317			void ev_set_allocator (void (cb)(void *ptr, long size));
318
319			/* set the callback function to call on a
320			* retryable syscall error
321			* (such as failed select, poll, epoll_wait)
322			*/
323	root	1.37	void ev_set_syserr_cb (void (cb)(const char msg));
324	root	1.36
325	root	1.29	# if EV_MULTIPLICITY
326	root	1.30	/* the default loop is the only one that handles signals and child watchers */
327			/* you can call this as often as you like */
328	root	1.58	static struct ev_loop *
329			ev_default_loop (unsigned int flags)
330			{
331			extern struct ev_loop *ev_default_loop_ptr;
332	root	1.61	extern struct ev_loop *ev_default_loop_init (unsigned int flags);
333	root	1.58
334			if (!ev_default_loop_ptr)
335	root	1.60	ev_default_loop_init (flags);
336	root	1.58
337			return ev_default_loop_ptr;
338			}
339	root	1.30
340			/* create and destroy alternative loops that don't handle signals */
341	root	1.53	struct ev_loop *ev_loop_new (unsigned int flags);
342	root	1.30	void ev_loop_destroy (EV_P);
343			void ev_loop_fork (EV_P);
344	root	1.47
345			ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
346
347	root	1.29	# else
348	root	1.47
349	root	1.54	int ev_default_loop (unsigned int flags); /* returns true when successful */
350	root	1.47
351			static ev_tstamp
352	root	1.52	ev_now (void)
353	root	1.47	{
354	root	1.48	extern ev_tstamp ev_rt_now;
355	root	1.47
356			return ev_rt_now;
357			}
358	root	1.29	# endif
359
360	root	1.30	void ev_default_destroy (void); /* destroy the default loop */
361			/* this needs to be called after fork, to duplicate the default loop */
362			/* if you create alternative loops you have to call ev_loop_fork on them */
363			/* you can call it in either the parent or the child */
364			/* you can actually call it at any time, anywhere :) */
365			void ev_default_fork (void);
366
367	root	1.63	unsigned int ev_backend (EV_P);
368	root	1.9	#endif
369	root	1.1
370			#define EVLOOP_NONBLOCK 1 /* do not block/wait */
371			#define EVLOOP_ONESHOT 2 /* block once only */
372	root	1.65	#define EVUNLOOP_CANCEL 0 /* undo unloop */
373	root	1.57	#define EVUNLOOP_ONE 1 /* unloop once */
374	root	1.29	#define EVUNLOOP_ALL 2 /* unloop all loops */
375
376	root	1.9	#if EV_PROTOTYPES
377	root	1.27	void ev_loop (EV_P_ int flags);
378	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 */
379	root	1.27
380			/*
381			* ref/unref can be used to add or remove a refcount on the mainloop. every watcher
382			* keeps one reference. if you have a long-runing watcher you never unregister that
383			* should not keep ev_loop from running, unref() after starting, and ref() before stopping.
384			*/
385			void ev_ref (EV_P);
386			void ev_unref (EV_P);
387	root	1.1
388	root	1.9	/* convinience function, wait for a single event, without registering an event watcher */
389			/* if timeout is < 0, do wait indefinitely */
390	root	1.27	void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (cb)(int revents, void arg), void *arg);
391	root	1.9	#endif
392
393	root	1.2	/* these may evaluate ev multiple times, and the other arguments at most once */
394	root	1.45	/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
395			#define ev_init(ev,cb_) do { \
396	root	1.66	((ev_watcher )(void )(ev))->active = \
397			((ev_watcher )(void )(ev))->pending = \
398			((ev_watcher )(void )(ev))->priority = 0; \
399	root	1.45	ev_set_cb ((ev), cb_); \
400	root	1.32	} while (0)
401	root	1.3
402	root	1.16	#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0)
403			#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)
404	root	1.40	#define ev_periodic_set(ev,at_,ival_,res_) do { (ev)->at = (at_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0)
405	root	1.16	#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
406	root	1.70	#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0)
407			#define ev_stat_set(ev,path_,interval_) do { (ev)->path = (path_); (ev)->interval = (interval_); } while (0)
408	root	1.16	#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
409			#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
410			#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
411	root	1.64	#define ev_embed_set(ev,loop_) do { (ev)->loop = (loop_); } while (0)
412	root	1.16
413	root	1.45	#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
414			#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
415			#define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0)
416			#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
417	root	1.70	#define ev_child_init(ev,cb,pid) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)
418			#define ev_stat_init(ev,cb,path,interval) do { ev_init ((ev), (cb)); ev_path_set ((ev),(path),(interval)); } while (0)
419	root	1.45	#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
420			#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
421			#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
422	root	1.64	#define ev_embed_init(ev,cb,loop) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(loop)); } while (0)
423	root	1.1
424	root	1.66	#define ev_is_pending(ev) (0 + ((ev_watcher )(void )(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
425			#define ev_is_active(ev) (0 + ((ev_watcher )(void )(ev))->active) /* ro, true when the watcher has been started */
426	root	1.32
427	root	1.66	#define ev_priority(ev) ((ev_watcher )(void )(ev))->priority /* rw */
428	root	1.33	#define ev_cb(ev) (ev)->cb /* rw */
429	root	1.32	#define ev_set_priority(ev,pri) ev_priority (ev) = (pri)
430	root	1.45
431			#ifndef ev_set_cb
432			# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
433			#endif
434	root	1.1
435	root	1.5	/* stopping (enabling, adding) a watcher does nothing if it is already running */
436			/* stopping (disabling, deleting) a watcher does nothing unless its already running */
437	root	1.9	#if EV_PROTOTYPES
438	root	1.41
439			/* feeds an event into a watcher as if the event actually occured */
440			/* accepts any ev_watcher type */
441			void ev_feed_event (EV_P_ void *w, int revents);
442	root	1.42	void ev_feed_fd_event (EV_P_ int fd, int revents);
443			void ev_feed_signal_event (EV_P_ int signum);
444	root	1.41
445	root	1.66	void ev_io_start (EV_P_ ev_io *w);
446			void ev_io_stop (EV_P_ ev_io *w);
447	root	1.6
448	root	1.66	void ev_timer_start (EV_P_ ev_timer *w);
449			void ev_timer_stop (EV_P_ ev_timer *w);
450	root	1.30	/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
451	root	1.66	void ev_timer_again (EV_P_ ev_timer *w);
452	root	1.1
453	root	1.69	#if EV_PERIODIC_ENABLE
454	root	1.66	void ev_periodic_start (EV_P_ ev_periodic *w);
455			void ev_periodic_stop (EV_P_ ev_periodic *w);
456			void ev_periodic_again (EV_P_ ev_periodic *w);
457	root	1.50	#endif
458	root	1.1
459	root	1.70	/* only supported in the default loop */
460			void ev_signal_start (EV_P_ ev_signal *w);
461			void ev_signal_stop (EV_P_ ev_signal *w);
462
463			/* only supported in the default loop */
464			void ev_child_start (EV_P_ ev_child *w);
465			void ev_child_stop (EV_P_ ev_child *w);
466
467			# if EV_STAT_ENABLE
468			void ev_stat_start (EV_P_ ev_stat *w);
469			void ev_stat_stop (EV_P_ ev_stat *w);
470			void ev_stat_stat (EV_P_ ev_stat *w);
471			# endif
472
473	root	1.66	void ev_idle_start (EV_P_ ev_idle *w);
474			void ev_idle_stop (EV_P_ ev_idle *w);
475	root	1.5
476	root	1.66	void ev_prepare_start (EV_P_ ev_prepare *w);
477			void ev_prepare_stop (EV_P_ ev_prepare *w);
478	root	1.11
479	root	1.66	void ev_check_start (EV_P_ ev_check *w);
480			void ev_check_stop (EV_P_ ev_check *w);
481	root	1.12
482	root	1.69	# if EV_EMBED_ENABLE
483	root	1.64	/* only supported when loop to be embedded is in fact embeddable */
484	root	1.66	void ev_embed_start (EV_P_ ev_embed *w);
485			void ev_embed_stop (EV_P_ ev_embed *w);
486	root	1.68	void ev_embed_sweep (EV_P_ ev_embed *w);
487	root	1.64	# endif
488
489	root	1.9	#endif
490	root	1.5
491	root	1.19	#ifdef __cplusplus
492			}
493			#endif
494
495	root	1.1	#endif
496