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

/* 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_
#endif

/* eventmask, revents, events... */
#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
# 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 */
struct ev_watcher
{
  EV_WATCHER (ev_watcher);
};

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

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

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

  ev_tstamp repeat; /* rw */
};

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

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

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

  int signum; /* ro */
};

/* invoked when the nothing else needs to be done, keeps the process from blocking */
/* revent EV_IDLE */
struct ev_idle
{
  EV_WATCHER (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 */
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 */
/* revent EV_CHILD */
/* does not support priorities */
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 */
};

/* 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_idle idle;
  struct ev_prepare prepare;
  struct ev_check check;
  struct ev_signal signal;
  struct ev_child child;
};

#define EVMETHOD_AUTO     0 /* consults environment */
#define EVMETHOD_SELECT   1
#define EVMETHOD_POLL     2
#define EVMETHOD_EPOLL    4
#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 */

#if EV_PROTOTYPES
int ev_version_major (void);
int ev_version_minor (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);

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

# else

int ev_default_loop (int methods); /* returns true when successful */

static ev_tstamp
ev_now ()
{
  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);

int ev_method (EV_P);
#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);
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 {                            \
  ((struct ev_watcher *)(void *)(ev))->active   =       \
  ((struct ev_watcher *)(void *)(ev))->pending  =       \
  ((struct 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_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_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_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_child_init(ev,cb,pid)            do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)

#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)

#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_ 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);
/* 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_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_prepare_start  (EV_P_ struct ev_prepare *w);
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);

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

#ifdef __cplusplus
}
#endif

#endif

Revision:	1.49
Committed:	Sat Nov 10 21:19:30 2007 UTC (16 years, 6 months ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.48:	+4 -0 lines
Log Message:	first rough cut at c++ interface
#	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.28	/* support multiple event loops? */
52	root	1.29	#if EV_MULTIPLICITY
53	root	1.28	struct ev_loop;
54			# define EV_P struct ev_loop *loop
55			# define EV_P_ EV_P,
56			# define EV_A loop
57			# define EV_A_ EV_A,
58	root	1.49	# define EV_DEFAULT_A ev_default_loop (0)
59			# define EV_DEFAULT_A_ EV_DEFAULT_A,
60	root	1.28	#else
61			# define EV_P void
62			# define EV_P_
63			# define EV_A
64			# define EV_A_
65	root	1.49	# define EV_DEFAULT_A
66			# define EV_DEFAULT_A_
67	root	1.28	#endif
68	root	1.27
69	root	1.1	/* eventmask, revents, events... */
70	root	1.17	#define EV_UNDEF -1 /* guaranteed to be invalid */
71			#define EV_NONE 0x00
72			#define EV_READ 0x01
73			#define EV_WRITE 0x02
74			#define EV_TIMEOUT 0x000100
75			#define EV_PERIODIC 0x000200
76			#define EV_SIGNAL 0x000400
77			#define EV_IDLE 0x000800
78			#define EV_CHECK 0x001000
79			#define EV_PREPARE 0x002000
80			#define EV_CHILD 0x004000
81			#define EV_ERROR 0x800000 /* sent when an error occurs */
82	root	1.1
83	root	1.6	/* can be used to add custom fields to all watchers */
84			#ifndef EV_COMMON
85			# define EV_COMMON void *data
86			#endif
87	root	1.9	#ifndef EV_PROTOTYPES
88			# define EV_PROTOTYPES 1
89			#endif
90	root	1.6
91	root	1.14	#define EV_VERSION_MAJOR 1
92			#define EV_VERSION_MINOR 1
93
94	root	1.44	#ifndef EV_CB_DECLARE
95	root	1.46	# define EV_CB_DECLARE(type) void (cb)(EV_P_ struct type w, int revents);
96	root	1.44	#endif
97			#ifndef EV_CB_INVOKE
98			# define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents))
99			#endif
100
101	root	1.6	/*
102			* struct member types:
103			* private: you can look at them, but not change them, and they might not mean anything to you.
104			* ro: can be read anytime, but only changed when the watcher isn't active
105			* rw: can be read and modified anytime, even when the watcher is active
106			*/
107
108	root	1.1	/* shared by all watchers */
109			#define EV_WATCHER(type) \
110			int active; /* private */ \
111			int pending; /* private */ \
112	root	1.32	int priority; /* private */ \
113	root	1.6	EV_COMMON; /* rw */ \
114	root	1.44	EV_CB_DECLARE (type) /* private */
115	root	1.1
116			#define EV_WATCHER_LIST(type) \
117			EV_WATCHER (type); \
118	root	1.26	struct ev_watcher_list next / private */
119	root	1.1
120	root	1.6	#define EV_WATCHER_TIME(type) \
121			EV_WATCHER (type); \
122			ev_tstamp at /* private */
123
124	root	1.7	/* base class, nothing to see here unless you subclass */
125	root	1.44	struct ev_watcher
126			{
127	root	1.7	EV_WATCHER (ev_watcher);
128			};
129
130			/* base class, nothing to see here unless you subclass */
131	root	1.44	struct ev_watcher_list
132			{
133	root	1.7	EV_WATCHER_LIST (ev_watcher_list);
134			};
135
136			/* base class, nothing to see here unless you subclass */
137	root	1.44	struct ev_watcher_time
138			{
139	root	1.7	EV_WATCHER_TIME (ev_watcher_time);
140			};
141
142	root	1.6	/* invoked after a specific time, repeatable (based on monotonic clock) */
143	root	1.17	/* revent EV_TIMEOUT */
144	root	1.1	struct ev_timer
145			{
146	root	1.6	EV_WATCHER_TIME (ev_timer);
147	root	1.1
148			ev_tstamp repeat; /* rw */
149	root	1.6	};
150
151			/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
152	root	1.17	/* revent EV_PERIODIC */
153	root	1.6	struct ev_periodic
154			{
155			EV_WATCHER_TIME (ev_periodic);
156
157			ev_tstamp interval; /* rw */
158	root	1.40	ev_tstamp (reschedule_cb)(struct ev_periodic w, ev_tstamp now); /* rw */
159	root	1.1	};
160
161	root	1.5	/* invoked when fd is either EV_READable or EV_WRITEable */
162	root	1.17	/* revent EV_READ, EV_WRITE */
163	root	1.1	struct ev_io
164			{
165			EV_WATCHER_LIST (ev_io);
166
167			int fd; /* ro */
168			int events; /* ro */
169			};
170
171	root	1.5	/* invoked when the given signal has been received */
172	root	1.17	/* revent EV_SIGNAL */
173	root	1.1	struct ev_signal
174			{
175			EV_WATCHER_LIST (ev_signal);
176
177			int signum; /* ro */
178			};
179
180	root	1.5	/* invoked when the nothing else needs to be done, keeps the process from blocking */
181	root	1.17	/* revent EV_IDLE */
182	root	1.5	struct ev_idle
183			{
184			EV_WATCHER (ev_idle);
185			};
186
187	root	1.11	/* invoked for each run of the mainloop, just before the blocking call */
188			/* you can still change events in any way you like */
189	root	1.17	/* revent EV_PREPARE */
190	root	1.11	struct ev_prepare
191			{
192			EV_WATCHER (ev_prepare);
193			};
194
195			/* invoked for each run of the mainloop, just after the blocking call */
196	root	1.17	/* revent EV_CHECK */
197	root	1.5	struct ev_check
198			{
199			EV_WATCHER (ev_check);
200			};
201
202	root	1.12	/* invoked when sigchld is received and waitpid indicates the givne pid */
203	root	1.17	/* revent EV_CHILD */
204	root	1.25	/* does not support priorities */
205	root	1.12	struct ev_child
206			{
207			EV_WATCHER_LIST (ev_child);
208
209	root	1.24	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	root	1.12	};
213
214	root	1.41	/* the presence of this union forces similar struct layout */
215	root	1.35	union ev_any_watcher
216			{
217			struct ev_watcher w;
218			struct ev_watcher_list wl;
219	root	1.46
220	root	1.35	struct ev_io io;
221			struct ev_timer timer;
222			struct ev_periodic periodic;
223			struct ev_idle idle;
224			struct ev_prepare prepare;
225			struct ev_check check;
226	root	1.46	struct ev_signal signal;
227			struct ev_child child;
228	root	1.35	};
229
230	root	1.22	#define EVMETHOD_AUTO 0 /* consults environment */
231			#define EVMETHOD_SELECT 1
232			#define EVMETHOD_POLL 2
233			#define EVMETHOD_EPOLL 4
234			#define EVMETHOD_KQUEUE 8
235	root	1.23	#define EVMETHOD_DEVPOLL 16 /* NYI */
236			#define EVMETHOD_PORT 32 /* NYI */
237	root	1.32	#define EVMETHOD_WIN32 64 /* NYI */
238	root	1.22	#define EVMETHOD_ANY ~0 /* any method, do not consult env */
239	root	1.29
240	root	1.9	#if EV_PROTOTYPES
241	root	1.14	int ev_version_major (void);
242			int ev_version_minor (void);
243	root	1.1
244			ev_tstamp ev_time (void);
245	root	1.29
246	root	1.36	/* Sets the allocation function to use, works like realloc.
247			* It is used to allocate and free memory.
248			* If it returns zero when memory needs to be allocated, the library might abort
249			* or take some potentially destructive action.
250			* The default is your system realloc function.
251			*/
252			void ev_set_allocator (void (cb)(void *ptr, long size));
253
254			/* set the callback function to call on a
255			* retryable syscall error
256			* (such as failed select, poll, epoll_wait)
257			*/
258	root	1.37	void ev_set_syserr_cb (void (cb)(const char msg));
259	root	1.36
260	root	1.29	# if EV_MULTIPLICITY
261	root	1.30	/* the default loop is the only one that handles signals and child watchers */
262			/* you can call this as often as you like */
263			struct ev_loop ev_default_loop (int methods); / returns default loop */
264
265			/* create and destroy alternative loops that don't handle signals */
266	root	1.29	struct ev_loop *ev_loop_new (int methods);
267	root	1.30	void ev_loop_destroy (EV_P);
268			void ev_loop_fork (EV_P);
269	root	1.47
270			ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
271
272	root	1.29	# else
273	root	1.47
274	root	1.30	int ev_default_loop (int methods); /* returns true when successful */
275	root	1.47
276			static ev_tstamp
277			ev_now ()
278			{
279	root	1.48	extern ev_tstamp ev_rt_now;
280	root	1.47
281			return ev_rt_now;
282			}
283	root	1.29	# endif
284
285	root	1.30	void ev_default_destroy (void); /* destroy the default loop */
286			/* this needs to be called after fork, to duplicate the default loop */
287			/* if you create alternative loops you have to call ev_loop_fork on them */
288			/* you can call it in either the parent or the child */
289			/* you can actually call it at any time, anywhere :) */
290			void ev_default_fork (void);
291
292	root	1.29	int ev_method (EV_P);
293	root	1.9	#endif
294	root	1.1
295			#define EVLOOP_NONBLOCK 1 /* do not block/wait */
296			#define EVLOOP_ONESHOT 2 /* block once only */
297	root	1.29	#define EVUNLOOP_ONCE 1 /* unloop once */
298			#define EVUNLOOP_ALL 2 /* unloop all loops */
299
300	root	1.9	#if EV_PROTOTYPES
301	root	1.27	void ev_loop (EV_P_ int flags);
302	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 */
303	root	1.27
304			/*
305			* ref/unref can be used to add or remove a refcount on the mainloop. every watcher
306			* keeps one reference. if you have a long-runing watcher you never unregister that
307			* should not keep ev_loop from running, unref() after starting, and ref() before stopping.
308			*/
309			void ev_ref (EV_P);
310			void ev_unref (EV_P);
311	root	1.1
312	root	1.9	/* convinience function, wait for a single event, without registering an event watcher */
313			/* if timeout is < 0, do wait indefinitely */
314	root	1.27	void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (cb)(int revents, void arg), void *arg);
315	root	1.9	#endif
316
317	root	1.2	/* these may evaluate ev multiple times, and the other arguments at most once */
318	root	1.45	/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
319			#define ev_init(ev,cb_) do { \
320	root	1.34	((struct ev_watcher )(void )(ev))->active = \
321			((struct ev_watcher )(void )(ev))->pending = \
322			((struct ev_watcher )(void )(ev))->priority = 0; \
323	root	1.45	ev_set_cb ((ev), cb_); \
324	root	1.32	} while (0)
325	root	1.3
326	root	1.16	#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0)
327			#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)
328	root	1.40	#define ev_periodic_set(ev,at_,ival_,res_) do { (ev)->at = (at_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0)
329	root	1.16	#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
330			#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
331			#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
332			#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
333			#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0)
334
335	root	1.45	#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
336			#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
337			#define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0)
338			#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
339			#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
340			#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
341			#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
342			#define ev_child_init(ev,cb,pid) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)
343	root	1.1
344	root	1.34	#define ev_is_pending(ev) (0 + ((struct ev_watcher )(void )(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
345			#define ev_is_active(ev) (0 + ((struct ev_watcher )(void )(ev))->active) /* ro, true when the watcher has been started */
346	root	1.32
347	root	1.34	#define ev_priority(ev) ((struct ev_watcher )(void )(ev))->priority /* rw */
348	root	1.33	#define ev_cb(ev) (ev)->cb /* rw */
349	root	1.32	#define ev_set_priority(ev,pri) ev_priority (ev) = (pri)
350	root	1.45
351			#ifndef ev_set_cb
352			# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
353			#endif
354	root	1.1
355	root	1.5	/* stopping (enabling, adding) a watcher does nothing if it is already running */
356			/* stopping (disabling, deleting) a watcher does nothing unless its already running */
357	root	1.9	#if EV_PROTOTYPES
358	root	1.41
359			/* feeds an event into a watcher as if the event actually occured */
360			/* accepts any ev_watcher type */
361			void ev_feed_event (EV_P_ void *w, int revents);
362	root	1.42	void ev_feed_fd_event (EV_P_ int fd, int revents);
363			void ev_feed_signal_event (EV_P_ int signum);
364	root	1.41
365	root	1.27	void ev_io_start (EV_P_ struct ev_io *w);
366			void ev_io_stop (EV_P_ struct ev_io *w);
367	root	1.6
368	root	1.27	void ev_timer_start (EV_P_ struct ev_timer *w);
369			void ev_timer_stop (EV_P_ struct ev_timer *w);
370	root	1.30	/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
371			void ev_timer_again (EV_P_ struct ev_timer *w);
372	root	1.1
373	root	1.27	void ev_periodic_start (EV_P_ struct ev_periodic *w);
374			void ev_periodic_stop (EV_P_ struct ev_periodic *w);
375	root	1.40	void ev_periodic_again (EV_P_ struct ev_periodic *w);
376	root	1.1
377	root	1.27	void ev_idle_start (EV_P_ struct ev_idle *w);
378			void ev_idle_stop (EV_P_ struct ev_idle *w);
379	root	1.5
380	root	1.27	void ev_prepare_start (EV_P_ struct ev_prepare *w);
381			void ev_prepare_stop (EV_P_ struct ev_prepare *w);
382	root	1.11
383	root	1.27	void ev_check_start (EV_P_ struct ev_check *w);
384			void ev_check_stop (EV_P_ struct ev_check *w);
385	root	1.12
386	root	1.30	/* only supported in the default loop */
387			void ev_signal_start (EV_P_ struct ev_signal *w);
388			void ev_signal_stop (EV_P_ struct ev_signal *w);
389
390			/* only supported in the default loop */
391	root	1.27	void ev_child_start (EV_P_ struct ev_child *w);
392			void ev_child_stop (EV_P_ struct ev_child *w);
393	root	1.9	#endif
394	root	1.5
395	root	1.19	#ifdef __cplusplus
396			}
397			#endif
398
399	root	1.1	#endif
400