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,
#else
# define EV_P void
# define EV_P_
# define EV_A
# define EV_A_
#endif

/* eventmask, revents, events... */
#define EV_UNDEF          -1 /* guaranteed to be invalid */
#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

/*
 * 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 */                           \
  void (*cb)(EV_P_ struct type *, int revents); /* private */ /* gets invoked with an eventmask */

#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 */
};

/* 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);
#if EV_MULTIPLICITY
  struct ev_loop *loop;
#endif

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

union ev_any_watcher
{
  struct ev_watcher w;
  struct ev_watcher_list wl;
  struct ev_io io;
  struct ev_timer timer;
  struct ev_periodic periodic;
  struct ev_signal signal;
  struct ev_idle idle;
  struct ev_child child;
  struct ev_prepare prepare;
  struct ev_check check;
};

#define EVMETHOD_AUTO     0 /* consults environment */
#define EVMETHOD_SELECT   1
#define EVMETHOD_POLL     2
#define EVMETHOD_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)(void));

# if EV_MULTIPLICITY
/* the default loop is the only one that handles signals and child watchers */
/* you can call this as often as you like */
struct ev_loop *ev_default_loop (int methods); /* returns default loop */

/* create and destroy alternative loops that don't handle signals */
struct ev_loop *ev_loop_new (int methods);
void ev_loop_destroy (EV_P);
void ev_loop_fork (EV_P);
# else
int ev_default_loop (int methods); /* returns true when successful */
# endif

void ev_default_destroy (void); /* destroy the default loop */
/* this needs to be called after fork, to duplicate the default loop */
/* if you create alternative loops you have to call ev_loop_fork on them */
/* you can call it in either the parent or the child */
/* you can actually call it at any time, anywhere :) */
void ev_default_fork (void);

int ev_method (EV_P);
#endif

#define EVLOOP_NONBLOCK 1 /* do not block/wait */
#define EVLOOP_ONESHOT  2 /* block *once* only */
#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 */

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

/*
 * 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_watcher_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
#define ev_watcher_init(ev,cb_) do {            \
  ((struct ev_watcher *)(void *)(ev))->active   =       \
  ((struct ev_watcher *)(void *)(ev))->pending  =       \
  ((struct ev_watcher *)(void *)(ev))->priority = 0;    \
  (ev)->cb = (cb_);                             \
} while (0)

#define ev_io_set(ev,fd_,events_)           do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0)
#define ev_timer_set(ev,after_,repeat_)     do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)
#define ev_periodic_set(ev,at_,interval_)   do { (ev)->at = (at_); (ev)->interval = (interval_); } while (0)
#define ev_signal_set(ev,signum_)           do { (ev)->signum = (signum_); } while (0)
#define ev_idle_set(ev)                     /* nop, yes, this is a serious in-joke */
#define ev_prepare_set(ev)                  /* nop, yes, this is a serious in-joke */
#define ev_check_set(ev)                    /* nop, yes, this is a serious in-joke */
#define ev_child_set(ev,pid_)               do { (ev)->pid = (pid_); } while (0)

#define ev_io_init(ev,cb,fd,events)         do { ev_watcher_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
#define ev_timer_init(ev,cb,after,repeat)   do { ev_watcher_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
#define ev_periodic_init(ev,cb,at,interval) do { ev_watcher_init ((ev), (cb)); ev_periodic_set ((ev),(at),(interval)); } while (0)
#define ev_signal_init(ev,cb,signum)        do { ev_watcher_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
#define ev_idle_init(ev,cb)                 do { ev_watcher_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
#define ev_prepare_init(ev,cb)              do { ev_watcher_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
#define ev_check_init(ev,cb)                do { ev_watcher_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
#define ev_child_init(ev,cb,pid)            do { ev_watcher_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)

#define ev_is_pending(ev)                   (0 + ((struct ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
#define ev_is_active(ev)                    (0 + ((struct ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */

#define ev_priority(ev)                     ((struct ev_watcher *)(void *)(ev))->priority /* rw */
#define ev_cb(ev)                           (ev)->cb /* rw */
#define ev_set_priority(ev,pri)             ev_priority (ev) = (pri)
#define ev_set_cb(ev,cb_)                   ev_cb (ev) = (cb_)

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