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_PERIODICS
# define EV_PERIODICS 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 /* io only */
#define EV_WRITE        0x02 /* io only */
#define EV_TIMEOUT  0x000100 /* timer only */
#define EV_PERIODIC 0x000200 /* periodic timer only */
#define EV_SIGNAL   0x000400 /* signal only */
#define EV_IDLE     0x000800 /* idle only */
#define EV_CHECK    0x001000 /* check only */
#define EV_PREPARE  0x002000 /* prepare only */
#define EV_CHILD    0x004000 /* child/pid only */
#define EV_ERROR    0x800000 /* 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 */
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;
};

/* bits for ev_default_loop and ev_loop_new */
/* the default */
#define EVMETHOD_AUTO    0x00000000 /* not quite a mask */

/* method bits to be ored together */
#define EVMETHOD_SELECT  0x00000001 /* about anywhere */
#define EVMETHOD_POLL    0x00000002 /* !win */
#define EVMETHOD_EPOLL   0x00000004 /* linux */
#define EVMETHOD_KQUEUE  0x00000008 /* bsd */
#define EVMETHOD_DEVPOLL 0x00000010 /* solaris 8 */ /* NYI */
#define EVMETHOD_PORT    0x00000020 /* solaris 10 */ /* NYI */

/* flag bits */
#define EVMETHOD_NOENV   0x01000000 /* do NOT consult environment */

#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 (unsigned int flags); /* returns default loop */

/* 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 (int methods); /* 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);

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

#if EV_PERIODICS
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);
#endif

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