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 0x04
#define EV_SIGNAL  0x08
#define EV_IDLE    0x10
#define EV_CHECK   0x20
#define EV_ERROR   (0x3f|0x80)

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

/*
 * 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 next blocking vall is initiated */
struct ev_check
{
  EV_WATCHER (ev_check);
};

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

/* 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 evcheck_set(ev)                    /* nop, yes, this is a serious in-joke */
#define evidle_set(ev)                     /* nop, yes, this is a serious in-joke */

#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 evcheck_init(ev,cb)                do { evw_init ((ev), (cb)); evcheck_set ((ev)); } while (0)
#define evidle_init(ev,cb)                 do { evw_init ((ev), (cb)); evidle_set ((ev)); } 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 evcheck_start    (struct ev_check *w);
void evcheck_stop     (struct ev_check *w);
#endif

#endif

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