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

Diff Legend

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