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

typedef double ev_tstamp;

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

#define EV_WATCHER_LIST(type)                   \
  EV_WATCHER (type);                            \
  struct type *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);

  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 */
struct ev_child
{
  EV_WATCHER_LIST (ev_child);

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

#define EVMETHOD_NONE   0
#define EVMETHOD_SELECT 1
#define EVMETHOD_EPOLL  2
#if EV_PROTOTYPES
extern int ev_method;
int ev_init (int flags); /* returns ev_method */
int ev_version_major (void);
int ev_version_minor (void);

/* these three calls are suitable for plugging into pthread_atfork */
void ev_prefork (void);
void ev_postfork_parent (void);
void ev_postfork_child (void);

extern ev_tstamp ev_now; /* time w.r.t. timers and the eventloop, updated after each poll */
ev_tstamp ev_time (void);
#endif

#define EVLOOP_NONBLOCK 1 /* do not block/wait */
#define EVLOOP_ONESHOT  2 /* block *once* only */
#if EV_PROTOTYPES
void ev_loop (int flags);
extern int ev_loop_done; /* set to 1 to break out of event loop, set to 2 to break out of all event loops */

/* convinience function, wait for a single event, without registering an event watcher */
/* if timeout is < 0, do wait indefinitely */
void ev_once (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 { (ev)->active = 0; (ev)->pending = 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_active(ev) (0 + (ev)->active) /* true when the watcher has been started */

/* 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       (struct ev_io *w);
void ev_io_stop        (struct ev_io *w);

void ev_timer_start    (struct ev_timer *w);
void ev_timer_stop     (struct ev_timer *w);
void ev_timer_again    (struct ev_timer *w); /* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */

void ev_periodic_start (struct ev_periodic *w);
void ev_periodic_stop  (struct ev_periodic *w);

void ev_signal_start   (struct ev_signal *w);
void ev_signal_stop    (struct ev_signal *w);

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

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

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

void ev_child_start    (struct ev_child *w);
void ev_child_stop     (struct ev_child *w);
#endif

#endif

Revision:	1.17
Committed:	Thu Nov 1 11:11:22 2007 UTC (16 years, 6 months ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.16:	+20 -12 lines
Log Message:	* empty log message *
#	User	Rev	Content
1	root	1.10	/*
2			* Copyright (c) 2007 Marc Alexander Lehmann <libev@schmorp.de>
3			* All rights reserved.
4			*
5			* Redistribution and use in source and binary forms, with or without
6			* modification, are permitted provided that the following conditions are
7			* met:
8			*
9			* * Redistributions of source code must retain the above copyright
10			* notice, this list of conditions and the following disclaimer.
11			*
12			* * Redistributions in binary form must reproduce the above
13			* copyright notice, this list of conditions and the following
14			* disclaimer in the documentation and/or other materials provided
15			* with the distribution.
16			*
17			* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18			* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19			* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20			* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21			* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22			* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23			* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24			* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25			* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26			* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27			* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28			*/
29
30	root	1.1	#ifndef EV_H
31			#define EV_H
32
33			typedef double ev_tstamp;
34
35			/* eventmask, revents, events... */
36	root	1.17	#define EV_UNDEF -1 /* guaranteed to be invalid */
37			#define EV_NONE 0x00
38			#define EV_READ 0x01
39			#define EV_WRITE 0x02
40			#define EV_TIMEOUT 0x000100
41			#define EV_PERIODIC 0x000200
42			#define EV_SIGNAL 0x000400
43			#define EV_IDLE 0x000800
44			#define EV_CHECK 0x001000
45			#define EV_PREPARE 0x002000
46			#define EV_CHILD 0x004000
47			#define EV_ERROR 0x800000 /* sent when an error occurs */
48	root	1.1
49	root	1.6	/* can be used to add custom fields to all watchers */
50			#ifndef EV_COMMON
51			# define EV_COMMON void *data
52			#endif
53	root	1.9	#ifndef EV_PROTOTYPES
54			# define EV_PROTOTYPES 1
55			#endif
56	root	1.6
57	root	1.14	#define EV_VERSION_MAJOR 1
58			#define EV_VERSION_MINOR 1
59
60	root	1.6	/*
61			* struct member types:
62			* private: you can look at them, but not change them, and they might not mean anything to you.
63			* ro: can be read anytime, but only changed when the watcher isn't active
64			* rw: can be read and modified anytime, even when the watcher is active
65			*/
66
67	root	1.1	/* shared by all watchers */
68			#define EV_WATCHER(type) \
69			int active; /* private */ \
70			int pending; /* private */ \
71	root	1.6	EV_COMMON; /* rw */ \
72			void (cb)(struct type , int revents); /* rw / / gets invoked with an eventmask */
73	root	1.1
74			#define EV_WATCHER_LIST(type) \
75			EV_WATCHER (type); \
76			struct type next / private */
77
78	root	1.6	#define EV_WATCHER_TIME(type) \
79			EV_WATCHER (type); \
80			ev_tstamp at /* private */
81
82	root	1.7	/* base class, nothing to see here unless you subclass */
83			struct ev_watcher {
84			EV_WATCHER (ev_watcher);
85			};
86
87			/* base class, nothing to see here unless you subclass */
88			struct ev_watcher_list {
89			EV_WATCHER_LIST (ev_watcher_list);
90			};
91
92			/* base class, nothing to see here unless you subclass */
93			struct ev_watcher_time {
94			EV_WATCHER_TIME (ev_watcher_time);
95			};
96
97	root	1.6	/* invoked after a specific time, repeatable (based on monotonic clock) */
98	root	1.17	/* revent EV_TIMEOUT */
99	root	1.1	struct ev_timer
100			{
101	root	1.6	EV_WATCHER_TIME (ev_timer);
102	root	1.1
103			ev_tstamp repeat; /* rw */
104	root	1.6	};
105
106			/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
107	root	1.17	/* revent EV_PERIODIC */
108	root	1.6	struct ev_periodic
109			{
110			EV_WATCHER_TIME (ev_periodic);
111
112			ev_tstamp interval; /* rw */
113	root	1.1	};
114
115	root	1.5	/* invoked when fd is either EV_READable or EV_WRITEable */
116	root	1.17	/* revent EV_READ, EV_WRITE */
117	root	1.1	struct ev_io
118			{
119			EV_WATCHER_LIST (ev_io);
120
121			int fd; /* ro */
122			int events; /* ro */
123			};
124
125	root	1.5	/* invoked when the given signal has been received */
126	root	1.17	/* revent EV_SIGNAL */
127	root	1.1	struct ev_signal
128			{
129			EV_WATCHER_LIST (ev_signal);
130
131			int signum; /* ro */
132			};
133
134	root	1.5	/* invoked when the nothing else needs to be done, keeps the process from blocking */
135	root	1.17	/* revent EV_IDLE */
136	root	1.5	struct ev_idle
137			{
138			EV_WATCHER (ev_idle);
139			};
140
141	root	1.11	/* invoked for each run of the mainloop, just before the blocking call */
142			/* you can still change events in any way you like */
143	root	1.17	/* revent EV_PREPARE */
144	root	1.11	struct ev_prepare
145			{
146			EV_WATCHER (ev_prepare);
147			};
148
149			/* invoked for each run of the mainloop, just after the blocking call */
150	root	1.17	/* revent EV_CHECK */
151	root	1.5	struct ev_check
152			{
153			EV_WATCHER (ev_check);
154			};
155
156	root	1.12	/* invoked when sigchld is received and waitpid indicates the givne pid */
157	root	1.17	/* revent EV_CHILD */
158	root	1.12	struct ev_child
159			{
160			EV_WATCHER_LIST (ev_child);
161
162			int pid; /* ro */
163	root	1.13	int status; /* rw, holds the exit status, use the macros from sys/wait.h */
164	root	1.12	};
165
166	root	1.1	#define EVMETHOD_NONE 0
167			#define EVMETHOD_SELECT 1
168			#define EVMETHOD_EPOLL 2
169	root	1.9	#if EV_PROTOTYPES
170			extern int ev_method;
171	root	1.5	int ev_init (int flags); /* returns ev_method */
172	root	1.14	int ev_version_major (void);
173			int ev_version_minor (void);
174	root	1.1
175	root	1.5	/* these three calls are suitable for plugging into pthread_atfork */
176	root	1.1	void ev_prefork (void);
177			void ev_postfork_parent (void);
178			void ev_postfork_child (void);
179
180			extern ev_tstamp ev_now; /* time w.r.t. timers and the eventloop, updated after each poll */
181			ev_tstamp ev_time (void);
182	root	1.9	#endif
183	root	1.1
184			#define EVLOOP_NONBLOCK 1 /* do not block/wait */
185			#define EVLOOP_ONESHOT 2 /* block once only */
186	root	1.9	#if EV_PROTOTYPES
187	root	1.3	void ev_loop (int flags);
188	root	1.7	extern int ev_loop_done; /* set to 1 to break out of event loop, set to 2 to break out of all event loops */
189	root	1.1
190	root	1.9	/* convinience function, wait for a single event, without registering an event watcher */
191			/* if timeout is < 0, do wait indefinitely */
192			void ev_once (int fd, int events, ev_tstamp timeout, void (cb)(int revents, void arg), void *arg);
193			#endif
194
195	root	1.2	/* these may evaluate ev multiple times, and the other arguments at most once */
196	root	1.16	/* either use ev_watcher_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
197			#define ev_watcher_init(ev,cb_) do { (ev)->active = 0; (ev)->pending = 0; (ev)->cb = (cb_); } while (0)
198	root	1.3
199	root	1.16	#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0)
200			#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)
201			#define ev_periodic_set(ev,at_,interval_) do { (ev)->at = (at_); (ev)->interval = (interval_); } while (0)
202			#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
203			#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
204			#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
205			#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
206			#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0)
207
208			#define ev_io_init(ev,cb,fd,events) do { ev_watcher_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
209			#define ev_timer_init(ev,cb,after,repeat) do { ev_watcher_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
210			#define ev_periodic_init(ev,cb,at,interval) do { ev_watcher_init ((ev), (cb)); ev_periodic_set ((ev),(at),(interval)); } while (0)
211			#define ev_signal_init(ev,cb,signum) do { ev_watcher_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
212			#define ev_idle_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
213			#define ev_prepare_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
214			#define ev_check_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
215			#define ev_child_init(ev,cb,pid) do { ev_watcher_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)
216	root	1.1
217	root	1.2	#define ev_is_active(ev) (0 + (ev)->active) /* true when the watcher has been started */
218	root	1.1
219	root	1.5	/* stopping (enabling, adding) a watcher does nothing if it is already running */
220			/* stopping (disabling, deleting) a watcher does nothing unless its already running */
221	root	1.9	#if EV_PROTOTYPES
222	root	1.16	void ev_io_start (struct ev_io *w);
223			void ev_io_stop (struct ev_io *w);
224	root	1.6
225	root	1.16	void ev_timer_start (struct ev_timer *w);
226			void ev_timer_stop (struct ev_timer *w);
227			void ev_timer_again (struct ev_timer w); / stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
228	root	1.1
229	root	1.16	void ev_periodic_start (struct ev_periodic *w);
230			void ev_periodic_stop (struct ev_periodic *w);
231	root	1.1
232	root	1.16	void ev_signal_start (struct ev_signal *w);
233			void ev_signal_stop (struct ev_signal *w);
234	root	1.1
235	root	1.16	void ev_idle_start (struct ev_idle *w);
236			void ev_idle_stop (struct ev_idle *w);
237	root	1.5
238	root	1.16	void ev_prepare_start (struct ev_prepare *w);
239			void ev_prepare_stop (struct ev_prepare *w);
240	root	1.11
241	root	1.16	void ev_check_start (struct ev_check *w);
242			void ev_check_stop (struct ev_check *w);
243	root	1.12
244	root	1.16	void ev_child_start (struct ev_child *w);
245			void ev_child_stop (struct ev_child *w);
246	root	1.9	#endif
247	root	1.5
248	root	1.1	#endif
249