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    0x000000
#define EV_READ    0x000001
#define EV_WRITE   0x000002
#define EV_TIMEOUT 0x000004
#define EV_SIGNAL  0x000008
#define EV_IDLE    0x000010
#define EV_CHECK   0x000020
#define EV_PREPARE 0x000040
#define EV_CHILD   0x000080
#define EV_ERROR   0x800000

/* 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) */
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) */
struct ev_periodic
{
  EV_WATCHER_TIME (ev_periodic);

  ev_tstamp interval; /* rw */
};

/* invoked when fd is either EV_READable or EV_WRITEable */
struct ev_io
{
  EV_WATCHER_LIST (ev_io);

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

/* invoked when the given signal has been received */
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 */
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 */
struct ev_prepare
{
  EV_WATCHER (ev_prepare);
};

/* invoked for each run of the mainloop, just after the blocking call */
struct ev_check
{
  EV_WATCHER (ev_check);
};

/* invoked when sigchld is received and waitpid indicates the givne pid */
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 evw_init + evXXX_set, or the evXXX_init macro, below, to first initialise a watcher */
#define evw_init(ev,cb_)                   do { (ev)->active = 0; (ev)->pending = 0; (ev)->cb = (cb_); } while (0)

#define evio_set(ev,fd_,events_)           do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0)
#define evtimer_set(ev,after_,repeat_)     do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)
#define evperiodic_set(ev,at_,interval_)   do { (ev)->at = (at_); (ev)->interval = (interval_); } while (0)
#define evsignal_set(ev,signum_)           do { (ev)->signum = (signum_); } while (0)
#define evidle_set(ev)                     /* nop, yes, this is a serious in-joke */
#define evprepare_set(ev)                  /* nop, yes, this is a serious in-joke */
#define evcheck_set(ev)                    /* nop, yes, this is a serious in-joke */
#define evchild_set(ev,pid_)               do { (ev)->pid = (pid_); } while (0)

#define evio_init(ev,cb,fd,events)         do { evw_init ((ev), (cb)); evio_set ((ev),(fd),(events)); } while (0)
#define evtimer_init(ev,cb,after,repeat)   do { evw_init ((ev), (cb)); evtimer_set ((ev),(after),(repeat)); } while (0)
#define evperiodic_init(ev,cb,at,interval) do { evw_init ((ev), (cb)); evperiodic_set ((ev),(at),(interval)); } while (0)
#define evsignal_init(ev,cb,signum)        do { evw_init ((ev), (cb)); evsignal_set ((ev), (signum)); } while (0)
#define evidle_init(ev,cb)                 do { evw_init ((ev), (cb)); evidle_set ((ev)); } while (0)
#define evprepare_init(ev,cb)              do { evw_init ((ev), (cb)); evprepare_set ((ev)); } while (0)
#define evcheck_init(ev,cb)                do { evw_init ((ev), (cb)); evcheck_set ((ev)); } while (0)
#define evchild_init(ev,cb,pid)            do { evw_init ((ev), (cb)); evchild_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 evio_start       (struct ev_io *w);
void evio_stop        (struct ev_io *w);

void evtimer_start    (struct ev_timer *w);
void evtimer_stop     (struct ev_timer *w);
void evtimer_again    (struct ev_timer *w); /* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */

void evperiodic_start (struct ev_periodic *w);
void evperiodic_stop  (struct ev_periodic *w);

void evsignal_start   (struct ev_signal *w);
void evsignal_stop    (struct ev_signal *w);

void evidle_start     (struct ev_idle *w);
void evidle_stop      (struct ev_idle *w);

void evprepare_start  (struct ev_prepare *w);
void evprepare_stop   (struct ev_prepare *w);

void evcheck_start    (struct ev_check *w);
void evcheck_stop     (struct ev_check *w);

void evchild_start    (struct ev_child *w);
void evchild_stop     (struct ev_child *w);
#endif

#endif

Revision:	1.14
Committed:	Wed Oct 31 20:46:44 2007 UTC (16 years, 6 months ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.13:	+15 -10 lines
Log Message:	stuffs
#	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			#define EV_UNDEF -1 /* guaranteed to be invalid */
37	root	1.14	#define EV_NONE 0x000000
38			#define EV_READ 0x000001
39			#define EV_WRITE 0x000002
40			#define EV_TIMEOUT 0x000004
41			#define EV_SIGNAL 0x000008
42			#define EV_IDLE 0x000010
43			#define EV_CHECK 0x000020
44			#define EV_PREPARE 0x000040
45			#define EV_CHILD 0x000080
46			#define EV_ERROR 0x800000
47	root	1.1
48	root	1.6	/* can be used to add custom fields to all watchers */
49			#ifndef EV_COMMON
50			# define EV_COMMON void *data
51			#endif
52	root	1.9	#ifndef EV_PROTOTYPES
53			# define EV_PROTOTYPES 1
54			#endif
55	root	1.6
56	root	1.14	#define EV_VERSION_MAJOR 1
57			#define EV_VERSION_MINOR 1
58
59	root	1.6	/*
60			* struct member types:
61			* private: you can look at them, but not change them, and they might not mean anything to you.
62			* ro: can be read anytime, but only changed when the watcher isn't active
63			* rw: can be read and modified anytime, even when the watcher is active
64			*/
65
66	root	1.1	/* shared by all watchers */
67			#define EV_WATCHER(type) \
68			int active; /* private */ \
69			int pending; /* private */ \
70	root	1.6	EV_COMMON; /* rw */ \
71			void (cb)(struct type , int revents); /* rw / / gets invoked with an eventmask */
72	root	1.1
73			#define EV_WATCHER_LIST(type) \
74			EV_WATCHER (type); \
75			struct type next / private */
76
77	root	1.6	#define EV_WATCHER_TIME(type) \
78			EV_WATCHER (type); \
79			ev_tstamp at /* private */
80
81	root	1.7	/* base class, nothing to see here unless you subclass */
82			struct ev_watcher {
83			EV_WATCHER (ev_watcher);
84			};
85
86			/* base class, nothing to see here unless you subclass */
87			struct ev_watcher_list {
88			EV_WATCHER_LIST (ev_watcher_list);
89			};
90
91			/* base class, nothing to see here unless you subclass */
92			struct ev_watcher_time {
93			EV_WATCHER_TIME (ev_watcher_time);
94			};
95
96	root	1.6	/* invoked after a specific time, repeatable (based on monotonic clock) */
97	root	1.1	struct ev_timer
98			{
99	root	1.6	EV_WATCHER_TIME (ev_timer);
100	root	1.1
101			ev_tstamp repeat; /* rw */
102	root	1.6	};
103
104			/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
105			struct ev_periodic
106			{
107			EV_WATCHER_TIME (ev_periodic);
108
109			ev_tstamp interval; /* rw */
110	root	1.1	};
111
112	root	1.5	/* invoked when fd is either EV_READable or EV_WRITEable */
113	root	1.1	struct ev_io
114			{
115			EV_WATCHER_LIST (ev_io);
116
117			int fd; /* ro */
118			int events; /* ro */
119			};
120
121	root	1.5	/* invoked when the given signal has been received */
122	root	1.1	struct ev_signal
123			{
124			EV_WATCHER_LIST (ev_signal);
125
126			int signum; /* ro */
127			};
128
129	root	1.5	/* invoked when the nothing else needs to be done, keeps the process from blocking */
130			struct ev_idle
131			{
132			EV_WATCHER (ev_idle);
133			};
134
135	root	1.11	/* invoked for each run of the mainloop, just before the blocking call */
136			/* you can still change events in any way you like */
137			struct ev_prepare
138			{
139			EV_WATCHER (ev_prepare);
140			};
141
142			/* invoked for each run of the mainloop, just after the blocking call */
143	root	1.5	struct ev_check
144			{
145			EV_WATCHER (ev_check);
146			};
147
148	root	1.12	/* invoked when sigchld is received and waitpid indicates the givne pid */
149			struct ev_child
150			{
151			EV_WATCHER_LIST (ev_child);
152
153			int pid; /* ro */
154	root	1.13	int status; /* rw, holds the exit status, use the macros from sys/wait.h */
155	root	1.12	};
156
157	root	1.1	#define EVMETHOD_NONE 0
158			#define EVMETHOD_SELECT 1
159			#define EVMETHOD_EPOLL 2
160	root	1.9	#if EV_PROTOTYPES
161			extern int ev_method;
162	root	1.5	int ev_init (int flags); /* returns ev_method */
163	root	1.14	int ev_version_major (void);
164			int ev_version_minor (void);
165	root	1.1
166	root	1.5	/* these three calls are suitable for plugging into pthread_atfork */
167	root	1.1	void ev_prefork (void);
168			void ev_postfork_parent (void);
169			void ev_postfork_child (void);
170
171			extern ev_tstamp ev_now; /* time w.r.t. timers and the eventloop, updated after each poll */
172			ev_tstamp ev_time (void);
173	root	1.9	#endif
174	root	1.1
175			#define EVLOOP_NONBLOCK 1 /* do not block/wait */
176			#define EVLOOP_ONESHOT 2 /* block once only */
177	root	1.9	#if EV_PROTOTYPES
178	root	1.3	void ev_loop (int flags);
179	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 */
180	root	1.1
181	root	1.9	/* convinience function, wait for a single event, without registering an event watcher */
182			/* if timeout is < 0, do wait indefinitely */
183			void ev_once (int fd, int events, ev_tstamp timeout, void (cb)(int revents, void arg), void *arg);
184			#endif
185
186	root	1.2	/* these may evaluate ev multiple times, and the other arguments at most once */
187	root	1.6	/* either use evw_init + evXXX_set, or the evXXX_init macro, below, to first initialise a watcher */
188	root	1.9	#define evw_init(ev,cb_) do { (ev)->active = 0; (ev)->pending = 0; (ev)->cb = (cb_); } while (0)
189	root	1.3
190	root	1.1	#define evio_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0)
191	root	1.6	#define evtimer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)
192			#define evperiodic_set(ev,at_,interval_) do { (ev)->at = (at_); (ev)->interval = (interval_); } while (0)
193	root	1.1	#define evsignal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
194	root	1.11	#define evidle_set(ev) /* nop, yes, this is a serious in-joke */
195			#define evprepare_set(ev) /* nop, yes, this is a serious in-joke */
196	root	1.9	#define evcheck_set(ev) /* nop, yes, this is a serious in-joke */
197	root	1.12	#define evchild_set(ev,pid_) do { (ev)->pid = (pid_); } while (0)
198	root	1.6
199			#define evio_init(ev,cb,fd,events) do { evw_init ((ev), (cb)); evio_set ((ev),(fd),(events)); } while (0)
200			#define evtimer_init(ev,cb,after,repeat) do { evw_init ((ev), (cb)); evtimer_set ((ev),(after),(repeat)); } while (0)
201			#define evperiodic_init(ev,cb,at,interval) do { evw_init ((ev), (cb)); evperiodic_set ((ev),(at),(interval)); } while (0)
202			#define evsignal_init(ev,cb,signum) do { evw_init ((ev), (cb)); evsignal_set ((ev), (signum)); } while (0)
203	root	1.11	#define evidle_init(ev,cb) do { evw_init ((ev), (cb)); evidle_set ((ev)); } while (0)
204			#define evprepare_init(ev,cb) do { evw_init ((ev), (cb)); evprepare_set ((ev)); } while (0)
205	root	1.6	#define evcheck_init(ev,cb) do { evw_init ((ev), (cb)); evcheck_set ((ev)); } while (0)
206	root	1.12	#define evchild_init(ev,cb,pid) do { evw_init ((ev), (cb)); evchild_set ((ev),(pid)); } while (0)
207	root	1.1
208	root	1.2	#define ev_is_active(ev) (0 + (ev)->active) /* true when the watcher has been started */
209	root	1.1
210	root	1.5	/* stopping (enabling, adding) a watcher does nothing if it is already running */
211			/* stopping (disabling, deleting) a watcher does nothing unless its already running */
212	root	1.9	#if EV_PROTOTYPES
213	root	1.6	void evio_start (struct ev_io *w);
214			void evio_stop (struct ev_io *w);
215
216			void evtimer_start (struct ev_timer *w);
217			void evtimer_stop (struct ev_timer *w);
218	root	1.8	void evtimer_again (struct ev_timer w); / stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
219	root	1.1
220	root	1.6	void evperiodic_start (struct ev_periodic *w);
221			void evperiodic_stop (struct ev_periodic *w);
222	root	1.1
223	root	1.6	void evsignal_start (struct ev_signal *w);
224			void evsignal_stop (struct ev_signal *w);
225	root	1.1
226	root	1.6	void evidle_start (struct ev_idle *w);
227			void evidle_stop (struct ev_idle *w);
228	root	1.5
229	root	1.11	void evprepare_start (struct ev_prepare *w);
230			void evprepare_stop (struct ev_prepare *w);
231
232	root	1.6	void evcheck_start (struct ev_check *w);
233			void evcheck_stop (struct ev_check *w);
234	root	1.12
235			void evchild_start (struct ev_child *w);
236			void evchild_stop (struct ev_child *w);
237	root	1.9	#endif
238	root	1.5
239	root	1.1	#endif
240