ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libev/ev.h
(Generate patch)

Comparing libev/ev.h (file contents):
Revision 1.11 by root, Wed Oct 31 18:28:00 2007 UTC vs.
Revision 1.22 by root, Fri Nov 2 20:59:15 2007 UTC

… …
28 */ 28 */
29 29
30#ifndef EV_H 30#ifndef EV_H
31#define EV_H 31#define EV_H
32 32
33#ifdef __cplusplus
34extern "C" {
35#endif
36
33typedef double ev_tstamp; 37typedef double ev_tstamp;
34 38
39/* 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
35/* eventmask, revents, events... */ 47/* eventmask, revents, events... */
36#define EV_UNDEF -1 /* guaranteed to be invalid */ 48#define EV_UNDEF -1 /* guaranteed to be invalid */
37#define EV_NONE 0x00 49#define EV_NONE 0x00
38#define EV_READ 0x01 50#define EV_READ 0x01
39#define EV_WRITE 0x02 51#define EV_WRITE 0x02
40#define EV_TIMEOUT 0x04 52#define EV_TIMEOUT 0x000100
53#define EV_PERIODIC 0x000200
41#define EV_SIGNAL 0x08 54#define EV_SIGNAL 0x000400
42#define EV_IDLE 0x10 55#define EV_IDLE 0x000800
43#define EV_CHECK 0x20 56#define EV_CHECK 0x001000
44#define EV_PREPARE 0x40 57#define EV_PREPARE 0x002000
45#define EV_ERROR (0x7f|0x80) 58#define EV_CHILD 0x004000
59#define EV_ERROR 0x800000 /* sent when an error occurs */
46 60
47/* can be used to add custom fields to all watchers */ 61/* can be used to add custom fields to all watchers */
48#ifndef EV_COMMON 62#ifndef EV_COMMON
49# define EV_COMMON void *data 63# define EV_COMMON void *data
50#endif 64#endif
51#ifndef EV_PROTOTYPES 65#ifndef EV_PROTOTYPES
52# define EV_PROTOTYPES 1 66# define EV_PROTOTYPES 1
53#endif 67#endif
68
69#define EV_VERSION_MAJOR 1
70#define EV_VERSION_MINOR 1
54 71
55/* 72/*
56 * struct member types: 73 * struct member types:
57 * private: you can look at them, but not change them, and they might not mean anything to you. 74 * private: you can look at them, but not change them, and they might not mean anything to you.
58 * ro: can be read anytime, but only changed when the watcher isn't active 75 * ro: can be read anytime, but only changed when the watcher isn't active
… …
61 78
62/* shared by all watchers */ 79/* shared by all watchers */
63#define EV_WATCHER(type) \ 80#define EV_WATCHER(type) \
64 int active; /* private */ \ 81 int active; /* private */ \
65 int pending; /* private */ \ 82 int pending; /* private */ \
83 int priority; /* ro */ \
66 EV_COMMON; /* rw */ \ 84 EV_COMMON; /* rw */ \
67 void (*cb)(struct type *, int revents); /* rw */ /* gets invoked with an eventmask */ 85 void (*cb)(struct type *, int revents); /* rw */ /* gets invoked with an eventmask */
68 86
69#define EV_WATCHER_LIST(type) \ 87#define EV_WATCHER_LIST(type) \
70 EV_WATCHER (type); \ 88 EV_WATCHER (type); \
… …
88struct ev_watcher_time { 106struct ev_watcher_time {
89 EV_WATCHER_TIME (ev_watcher_time); 107 EV_WATCHER_TIME (ev_watcher_time);
90}; 108};
91 109
92/* invoked after a specific time, repeatable (based on monotonic clock) */ 110/* invoked after a specific time, repeatable (based on monotonic clock) */
111/* revent EV_TIMEOUT */
93struct ev_timer 112struct ev_timer
94{ 113{
95 EV_WATCHER_TIME (ev_timer); 114 EV_WATCHER_TIME (ev_timer);
96 115
97 ev_tstamp repeat; /* rw */ 116 ev_tstamp repeat; /* rw */
98}; 117};
99 118
100/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */ 119/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
120/* revent EV_PERIODIC */
101struct ev_periodic 121struct ev_periodic
102{ 122{
103 EV_WATCHER_TIME (ev_periodic); 123 EV_WATCHER_TIME (ev_periodic);
104 124
105 ev_tstamp interval; /* rw */ 125 ev_tstamp interval; /* rw */
106}; 126};
107 127
108/* invoked when fd is either EV_READable or EV_WRITEable */ 128/* invoked when fd is either EV_READable or EV_WRITEable */
129/* revent EV_READ, EV_WRITE */
109struct ev_io 130struct ev_io
110{ 131{
111 EV_WATCHER_LIST (ev_io); 132 EV_WATCHER_LIST (ev_io);
112 133
113 int fd; /* ro */ 134 int fd; /* ro */
114 int events; /* ro */ 135 int events; /* ro */
115}; 136};
116 137
117/* invoked when the given signal has been received */ 138/* invoked when the given signal has been received */
139/* revent EV_SIGNAL */
118struct ev_signal 140struct ev_signal
119{ 141{
120 EV_WATCHER_LIST (ev_signal); 142 EV_WATCHER_LIST (ev_signal);
121 143
122 int signum; /* ro */ 144 int signum; /* ro */
123}; 145};
124 146
125/* invoked when the nothing else needs to be done, keeps the process from blocking */ 147/* invoked when the nothing else needs to be done, keeps the process from blocking */
148/* revent EV_IDLE */
126struct ev_idle 149struct ev_idle
127{ 150{
128 EV_WATCHER (ev_idle); 151 EV_WATCHER (ev_idle);
129}; 152};
130 153
131/* invoked for each run of the mainloop, just before the blocking call */ 154/* invoked for each run of the mainloop, just before the blocking call */
132/* you can still change events in any way you like */ 155/* you can still change events in any way you like */
156/* revent EV_PREPARE */
133struct ev_prepare 157struct ev_prepare
134{ 158{
135 EV_WATCHER (ev_prepare); 159 EV_WATCHER (ev_prepare);
136}; 160};
137 161
138/* invoked for each run of the mainloop, just after the blocking call */ 162/* invoked for each run of the mainloop, just after the blocking call */
163/* revent EV_CHECK */
139struct ev_check 164struct ev_check
140{ 165{
141 EV_WATCHER (ev_check); 166 EV_WATCHER (ev_check);
142}; 167};
143 168
144#define EVMETHOD_NONE 0 169/* invoked when sigchld is received and waitpid indicates the givne pid */
170/* revent EV_CHILD */
171struct ev_child
172{
173 EV_WATCHER_LIST (ev_child);
174
175 int pid; /* ro */
176 int status; /* rw, holds the exit status, use the macros from sys/wait.h */
177};
178
179#define EVMETHOD_AUTO 0 /* consults environment */
145#define EVMETHOD_SELECT 1 180#define EVMETHOD_SELECT 1
146#define EVMETHOD_EPOLL 2 181#define EVMETHOD_POLL 2
182#define EVMETHOD_EPOLL 4
183#define EVMETHOD_KQUEUE 8
184#define EVMETHOD_DEVPOLL 16
185#define EVMETHOD_ANY ~0 /* any method, do not consult env */
147#if EV_PROTOTYPES 186#if EV_PROTOTYPES
148extern int ev_method; 187extern int ev_method;
149int ev_init (int flags); /* returns ev_method */ 188int ev_init (int methods); /* returns ev_method */
189int ev_version_major (void);
190int ev_version_minor (void);
150 191
151/* these three calls are suitable for plugging into pthread_atfork */ 192/* these three calls are suitable for plugging into pthread_atfork */
152void ev_prefork (void); 193void ev_fork_prepare (void);
153void ev_postfork_parent (void); 194void ev_fork_parent (void);
154void ev_postfork_child (void); 195void ev_fork_child (void);
155 196
156extern ev_tstamp ev_now; /* time w.r.t. timers and the eventloop, updated after each poll */ 197extern ev_tstamp ev_now; /* time w.r.t. timers and the eventloop, updated after each poll */
157ev_tstamp ev_time (void); 198ev_tstamp ev_time (void);
158#endif 199#endif
159 200
… …
167/* if timeout is < 0, do wait indefinitely */ 208/* if timeout is < 0, do wait indefinitely */
168void ev_once (int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); 209void ev_once (int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
169#endif 210#endif
170 211
171/* these may evaluate ev multiple times, and the other arguments at most once */ 212/* these may evaluate ev multiple times, and the other arguments at most once */
172/* either use evw_init + evXXX_set, or the evXXX_init macro, below, to first initialise a watcher */ 213/* either use ev_watcher_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
173#define evw_init(ev,cb_) do { (ev)->active = 0; (ev)->pending = 0; (ev)->cb = (cb_); } while (0) 214#define ev_watcher_init(ev,cb_) do { (ev)->active = (ev)->pending = (ev)->priority = 0; (ev)->cb = (cb_); } while (0)
174 215
175#define evio_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0) 216#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0)
176#define evtimer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0) 217#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)
177#define evperiodic_set(ev,at_,interval_) do { (ev)->at = (at_); (ev)->interval = (interval_); } while (0) 218#define ev_periodic_set(ev,at_,interval_) do { (ev)->at = (at_); (ev)->interval = (interval_); } while (0)
178#define evsignal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) 219#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
179#define evidle_set(ev) /* nop, yes, this is a serious in-joke */ 220#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
180#define evprepare_set(ev) /* nop, yes, this is a serious in-joke */ 221#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
181#define evcheck_set(ev) /* nop, yes, this is a serious in-joke */ 222#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
223#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0)
182 224
183#define evio_init(ev,cb,fd,events) do { evw_init ((ev), (cb)); evio_set ((ev),(fd),(events)); } while (0) 225#define ev_io_init(ev,cb,fd,events) do { ev_watcher_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
184#define evtimer_init(ev,cb,after,repeat) do { evw_init ((ev), (cb)); evtimer_set ((ev),(after),(repeat)); } while (0) 226#define ev_timer_init(ev,cb,after,repeat) do { ev_watcher_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
185#define evperiodic_init(ev,cb,at,interval) do { evw_init ((ev), (cb)); evperiodic_set ((ev),(at),(interval)); } while (0) 227#define ev_periodic_init(ev,cb,at,interval) do { ev_watcher_init ((ev), (cb)); ev_periodic_set ((ev),(at),(interval)); } while (0)
186#define evsignal_init(ev,cb,signum) do { evw_init ((ev), (cb)); evsignal_set ((ev), (signum)); } while (0) 228#define ev_signal_init(ev,cb,signum) do { ev_watcher_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
187#define evidle_init(ev,cb) do { evw_init ((ev), (cb)); evidle_set ((ev)); } while (0) 229#define ev_idle_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
188#define evprepare_init(ev,cb) do { evw_init ((ev), (cb)); evprepare_set ((ev)); } while (0) 230#define ev_prepare_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
189#define evcheck_init(ev,cb) do { evw_init ((ev), (cb)); evcheck_set ((ev)); } while (0) 231#define ev_check_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
232#define ev_child_init(ev,cb,pid) do { ev_watcher_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)
190 233
191#define ev_is_active(ev) (0 + (ev)->active) /* true when the watcher has been started */ 234#define ev_is_active(ev) (0 + (ev)->active) /* true when the watcher has been started */
235#define ev_set_priority(ev,pri) (ev)->priority = pri
192 236
193/* stopping (enabling, adding) a watcher does nothing if it is already running */ 237/* stopping (enabling, adding) a watcher does nothing if it is already running */
194/* stopping (disabling, deleting) a watcher does nothing unless its already running */ 238/* stopping (disabling, deleting) a watcher does nothing unless its already running */
195#if EV_PROTOTYPES 239#if EV_PROTOTYPES
196void evio_start (struct ev_io *w); 240void ev_io_start (struct ev_io *w);
197void evio_stop (struct ev_io *w); 241void ev_io_stop (struct ev_io *w);
198 242
199void evtimer_start (struct ev_timer *w); 243void ev_timer_start (struct ev_timer *w);
200void evtimer_stop (struct ev_timer *w); 244void ev_timer_stop (struct ev_timer *w);
201void evtimer_again (struct ev_timer *w); /* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */ 245void ev_timer_again (struct ev_timer *w); /* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
202 246
203void evperiodic_start (struct ev_periodic *w); 247void ev_periodic_start (struct ev_periodic *w);
204void evperiodic_stop (struct ev_periodic *w); 248void ev_periodic_stop (struct ev_periodic *w);
205 249
206void evsignal_start (struct ev_signal *w); 250void ev_signal_start (struct ev_signal *w);
207void evsignal_stop (struct ev_signal *w); 251void ev_signal_stop (struct ev_signal *w);
208 252
209void evidle_start (struct ev_idle *w); 253void ev_idle_start (struct ev_idle *w);
210void evidle_stop (struct ev_idle *w); 254void ev_idle_stop (struct ev_idle *w);
211 255
212void evprepare_start (struct ev_prepare *w); 256void ev_prepare_start (struct ev_prepare *w);
213void evprepare_stop (struct ev_prepare *w); 257void ev_prepare_stop (struct ev_prepare *w);
214 258
215void evcheck_start (struct ev_check *w); 259void ev_check_start (struct ev_check *w);
216void evcheck_stop (struct ev_check *w); 260void ev_check_stop (struct ev_check *w);
217#endif
218 261
262void ev_child_start (struct ev_child *w);
263void ev_child_stop (struct ev_child *w);
219#endif 264#endif
220 265
266#ifdef __cplusplus
267}
268#endif
269
270#endif
271

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines