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

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

Diff Legend

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