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

Comparing libev/ev.h (file contents):
Revision 1.50 by root, Sun Nov 11 01:07:35 2007 UTC vs.
Revision 1.64 by root, Fri Nov 23 19:13:33 2007 UTC

… …
69# define EV_DEFAULT_A 69# define EV_DEFAULT_A
70# define EV_DEFAULT_A_ 70# define EV_DEFAULT_A_
71#endif 71#endif
72 72
73/* eventmask, revents, events... */ 73/* eventmask, revents, events... */
74#define EV_UNDEF -1 /* guaranteed to be invalid */ 74#define EV_UNDEF -1L /* guaranteed to be invalid */
75#define EV_NONE 0x00 75#define EV_NONE 0x00L
76#define EV_READ 0x01 76#define EV_READ 0x01L /* io only */
77#define EV_WRITE 0x02 77#define EV_WRITE 0x02L /* io only */
78#define EV_TIMEOUT 0x000100 78#define EV_TIMEOUT 0x000100L /* timer only */
79#define EV_PERIODIC 0x000200 79#define EV_PERIODIC 0x000200L /* periodic timer only */
80#define EV_SIGNAL 0x000400 80#define EV_SIGNAL 0x000400L /* signal only */
81#define EV_IDLE 0x000800 81#define EV_IDLE 0x000800L /* idle only */
82#define EV_CHECK 0x001000 82#define EV_CHECK 0x001000L /* check only */
83#define EV_PREPARE 0x002000 83#define EV_PREPARE 0x002000L /* prepare only */
84#define EV_CHILD 0x004000 84#define EV_CHILD 0x004000L /* child/pid only */
85#define EV_EMBED 0x008000L /* embedded event loop */
85#define EV_ERROR 0x800000 /* sent when an error occurs */ 86#define EV_ERROR 0x800000L /* sent when an error occurs */
86 87
87/* can be used to add custom fields to all watchers */ 88/* can be used to add custom fields to all watchers, while losing binary compatibility */
88#ifndef EV_COMMON 89#ifndef EV_COMMON
89# define EV_COMMON void *data 90# define EV_COMMON void *data;
90#endif 91#endif
91#ifndef EV_PROTOTYPES 92#ifndef EV_PROTOTYPES
92# define EV_PROTOTYPES 1 93# define EV_PROTOTYPES 1
93#endif 94#endif
94 95
… …
112/* shared by all watchers */ 113/* shared by all watchers */
113#define EV_WATCHER(type) \ 114#define EV_WATCHER(type) \
114 int active; /* private */ \ 115 int active; /* private */ \
115 int pending; /* private */ \ 116 int pending; /* private */ \
116 int priority; /* private */ \ 117 int priority; /* private */ \
117 EV_COMMON; /* rw */ \ 118 EV_COMMON /* rw */ \
118 EV_CB_DECLARE (type) /* private */ 119 EV_CB_DECLARE (type) /* private */
119 120
120#define EV_WATCHER_LIST(type) \ 121#define EV_WATCHER_LIST(type) \
121 EV_WATCHER (type); \ 122 EV_WATCHER (type) \
122 struct ev_watcher_list *next /* private */ 123 struct ev_watcher_list *next; /* private */
123 124
124#define EV_WATCHER_TIME(type) \ 125#define EV_WATCHER_TIME(type) \
125 EV_WATCHER (type); \ 126 EV_WATCHER (type) \
126 ev_tstamp at /* private */ 127 ev_tstamp at; /* private */
127 128
128/* base class, nothing to see here unless you subclass */ 129/* base class, nothing to see here unless you subclass */
129struct ev_watcher 130struct ev_watcher
130{ 131{
131 EV_WATCHER (ev_watcher); 132 EV_WATCHER (ev_watcher)
132}; 133};
133 134
134/* base class, nothing to see here unless you subclass */ 135/* base class, nothing to see here unless you subclass */
135struct ev_watcher_list 136struct ev_watcher_list
136{ 137{
137 EV_WATCHER_LIST (ev_watcher_list); 138 EV_WATCHER_LIST (ev_watcher_list)
138}; 139};
139 140
140/* base class, nothing to see here unless you subclass */ 141/* base class, nothing to see here unless you subclass */
141struct ev_watcher_time 142struct ev_watcher_time
142{ 143{
143 EV_WATCHER_TIME (ev_watcher_time); 144 EV_WATCHER_TIME (ev_watcher_time)
144}; 145};
145 146
146/* invoked after a specific time, repeatable (based on monotonic clock) */ 147/* invoked after a specific time, repeatable (based on monotonic clock) */
147/* revent EV_TIMEOUT */ 148/* revent EV_TIMEOUT */
148struct ev_timer 149struct ev_timer
149{ 150{
150 EV_WATCHER_TIME (ev_timer); 151 EV_WATCHER_TIME (ev_timer)
151 152
152 ev_tstamp repeat; /* rw */ 153 ev_tstamp repeat; /* rw */
153}; 154};
154 155
155/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */ 156/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
156/* revent EV_PERIODIC */ 157/* revent EV_PERIODIC */
157struct ev_periodic 158struct ev_periodic
158{ 159{
159 EV_WATCHER_TIME (ev_periodic); 160 EV_WATCHER_TIME (ev_periodic)
160 161
161 ev_tstamp interval; /* rw */ 162 ev_tstamp interval; /* rw */
162 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */ 163 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */
163}; 164};
164 165
165/* invoked when fd is either EV_READable or EV_WRITEable */ 166/* invoked when fd is either EV_READable or EV_WRITEable */
166/* revent EV_READ, EV_WRITE */ 167/* revent EV_READ, EV_WRITE */
167struct ev_io 168struct ev_io
168{ 169{
169 EV_WATCHER_LIST (ev_io); 170 EV_WATCHER_LIST (ev_io)
170 171
171 int fd; /* ro */ 172 int fd; /* ro */
172 int events; /* ro */ 173 int events; /* ro */
173}; 174};
174 175
175/* invoked when the given signal has been received */ 176/* invoked when the given signal has been received */
176/* revent EV_SIGNAL */ 177/* revent EV_SIGNAL */
177struct ev_signal 178struct ev_signal
178{ 179{
179 EV_WATCHER_LIST (ev_signal); 180 EV_WATCHER_LIST (ev_signal)
180 181
181 int signum; /* ro */ 182 int signum; /* ro */
182}; 183};
183 184
184/* invoked when the nothing else needs to be done, keeps the process from blocking */ 185/* invoked when the nothing else needs to be done, keeps the process from blocking */
185/* revent EV_IDLE */ 186/* revent EV_IDLE */
186struct ev_idle 187struct ev_idle
187{ 188{
188 EV_WATCHER (ev_idle); 189 EV_WATCHER (ev_idle)
189}; 190};
190 191
191/* invoked for each run of the mainloop, just before the blocking call */ 192/* invoked for each run of the mainloop, just before the blocking call */
192/* you can still change events in any way you like */ 193/* you can still change events in any way you like */
193/* revent EV_PREPARE */ 194/* revent EV_PREPARE */
194struct ev_prepare 195struct ev_prepare
195{ 196{
196 EV_WATCHER (ev_prepare); 197 EV_WATCHER (ev_prepare)
197}; 198};
198 199
199/* invoked for each run of the mainloop, just after the blocking call */ 200/* invoked for each run of the mainloop, just after the blocking call */
200/* revent EV_CHECK */ 201/* revent EV_CHECK */
201struct ev_check 202struct ev_check
202{ 203{
203 EV_WATCHER (ev_check); 204 EV_WATCHER (ev_check)
204}; 205};
205 206
206/* invoked when sigchld is received and waitpid indicates the givne pid */ 207/* invoked when sigchld is received and waitpid indicates the given pid */
207/* revent EV_CHILD */ 208/* revent EV_CHILD */
208/* does not support priorities */ 209/* does not support priorities */
209struct ev_child 210struct ev_child
210{ 211{
211 EV_WATCHER_LIST (ev_child); 212 EV_WATCHER_LIST (ev_child)
212 213
213 int pid; /* ro */ 214 int pid; /* ro */
214 int rpid; /* rw, holds the received pid */ 215 int rpid; /* rw, holds the received pid */
215 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */ 216 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
216}; 217};
218
219#if EV_MULTIPLICITY
220/* used to embed an event loop inside another */
221/* the callback gets invoked when the event loop has handled events, and can be 0 */
222struct ev_embed
223{
224 EV_WATCHER (ev_embed)
225
226 struct ev_io io; /* private */
227 struct ev_loop *loop; /* ro */
228};
229#endif
217 230
218/* the presence of this union forces similar struct layout */ 231/* the presence of this union forces similar struct layout */
219union ev_any_watcher 232union ev_any_watcher
220{ 233{
221 struct ev_watcher w; 234 struct ev_watcher w;
… …
227 struct ev_idle idle; 240 struct ev_idle idle;
228 struct ev_prepare prepare; 241 struct ev_prepare prepare;
229 struct ev_check check; 242 struct ev_check check;
230 struct ev_signal signal; 243 struct ev_signal signal;
231 struct ev_child child; 244 struct ev_child child;
245 struct ev_embed embed;
232}; 246};
233 247
234#define EVMETHOD_AUTO 0 /* consults environment */ 248/* bits for ev_default_loop and ev_loop_new */
235#define EVMETHOD_SELECT 1 249/* the default */
236#define EVMETHOD_POLL 2 250#define EVFLAG_AUTO 0x00000000UL /* not quite a mask */
237#define EVMETHOD_EPOLL 4 251/* flag bits */
238#define EVMETHOD_KQUEUE 8 252#define EVFLAG_NOENV 0x01000000UL /* do NOT consult environment */
239#define EVMETHOD_DEVPOLL 16 /* NYI */ 253/* method bits to be ored together */
240#define EVMETHOD_PORT 32 /* NYI */ 254#define EVBACKEND_SELECT 0x00000001UL /* about anywhere */
241#define EVMETHOD_WIN32 64 /* NYI */ 255#define EVBACKEND_POLL 0x00000002UL /* !win */
242#define EVMETHOD_ANY ~0 /* any method, do not consult env */ 256#define EVBACKEND_EPOLL 0x00000004UL /* linux */
257#define EVBACKEND_KQUEUE 0x00000008UL /* bsd */
258#define EVBACKEND_DEVPOLL 0x00000010UL /* solaris 8 */ /* NYI */
259#define EVBACKEND_PORT 0x00000020UL /* solaris 10 */
243 260
244#if EV_PROTOTYPES 261#if EV_PROTOTYPES
245int ev_version_major (void); 262int ev_version_major (void);
246int ev_version_minor (void); 263int ev_version_minor (void);
264
265unsigned int ev_supported_backends (void);
266unsigned int ev_recommended_backends (void);
267unsigned int ev_embeddable_backends (void);
247 268
248ev_tstamp ev_time (void); 269ev_tstamp ev_time (void);
249 270
250/* Sets the allocation function to use, works like realloc. 271/* Sets the allocation function to use, works like realloc.
251 * It is used to allocate and free memory. 272 * It is used to allocate and free memory.
… …
262void ev_set_syserr_cb (void (*cb)(const char *msg)); 283void ev_set_syserr_cb (void (*cb)(const char *msg));
263 284
264# if EV_MULTIPLICITY 285# if EV_MULTIPLICITY
265/* the default loop is the only one that handles signals and child watchers */ 286/* the default loop is the only one that handles signals and child watchers */
266/* you can call this as often as you like */ 287/* you can call this as often as you like */
267struct ev_loop *ev_default_loop (int methods); /* returns default loop */ 288static struct ev_loop *
289ev_default_loop (unsigned int flags)
290{
291 extern struct ev_loop *ev_default_loop_ptr;
292 extern struct ev_loop *ev_default_loop_init (unsigned int flags);
293
294 if (!ev_default_loop_ptr)
295 ev_default_loop_init (flags);
296
297 return ev_default_loop_ptr;
298}
268 299
269/* create and destroy alternative loops that don't handle signals */ 300/* create and destroy alternative loops that don't handle signals */
270struct ev_loop *ev_loop_new (int methods); 301struct ev_loop *ev_loop_new (unsigned int flags);
271void ev_loop_destroy (EV_P); 302void ev_loop_destroy (EV_P);
272void ev_loop_fork (EV_P); 303void ev_loop_fork (EV_P);
273 304
274ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */ 305ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
275 306
276# else 307# else
277 308
278int ev_default_loop (int methods); /* returns true when successful */ 309int ev_default_loop (unsigned int flags); /* returns true when successful */
279 310
280static ev_tstamp 311static ev_tstamp
281ev_now () 312ev_now (void)
282{ 313{
283 extern ev_tstamp ev_rt_now; 314 extern ev_tstamp ev_rt_now;
284 315
285 return ev_rt_now; 316 return ev_rt_now;
286} 317}
… …
291/* if you create alternative loops you have to call ev_loop_fork on them */ 322/* if you create alternative loops you have to call ev_loop_fork on them */
292/* you can call it in either the parent or the child */ 323/* you can call it in either the parent or the child */
293/* you can actually call it at any time, anywhere :) */ 324/* you can actually call it at any time, anywhere :) */
294void ev_default_fork (void); 325void ev_default_fork (void);
295 326
296int ev_method (EV_P); 327unsigned int ev_backend (EV_P);
297#endif 328#endif
298 329
299#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 330#define EVLOOP_NONBLOCK 1 /* do not block/wait */
300#define EVLOOP_ONESHOT 2 /* block *once* only */ 331#define EVLOOP_ONESHOT 2 /* block *once* only */
301#define EVUNLOOP_ONCE 1 /* unloop once */ 332#define EVUNLOOP_ONE 1 /* unloop once */
302#define EVUNLOOP_ALL 2 /* unloop all loops */ 333#define EVUNLOOP_ALL 2 /* unloop all loops */
303 334
304#if EV_PROTOTYPES 335#if EV_PROTOTYPES
305void ev_loop (EV_P_ int flags); 336void ev_loop (EV_P_ int flags);
306void ev_unloop (EV_P_ int how); /* set to 1 to break out of event loop, set to 2 to break out of all event loops */ 337void ev_unloop (EV_P_ int how); /* set to 1 to break out of event loop, set to 2 to break out of all event loops */
… …
333#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) 364#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
334#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */ 365#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
335#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */ 366#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
336#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */ 367#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
337#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0) 368#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0)
369#define ev_embed_set(ev,loop_) do { (ev)->loop = (loop_); } while (0)
338 370
339#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) 371#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
340#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0) 372#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
341#define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0) 373#define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0)
342#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0) 374#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
343#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0) 375#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
344#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0) 376#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
345#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0) 377#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
346#define ev_child_init(ev,cb,pid) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0) 378#define ev_child_init(ev,cb,pid) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)
379#define ev_embed_init(ev,cb,loop) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(loop)); } while (0)
347 380
348#define ev_is_pending(ev) (0 + ((struct ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ 381#define ev_is_pending(ev) (0 + ((struct ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
349#define ev_is_active(ev) (0 + ((struct ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */ 382#define ev_is_active(ev) (0 + ((struct ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
350 383
351#define ev_priority(ev) ((struct ev_watcher *)(void *)(ev))->priority /* rw */ 384#define ev_priority(ev) ((struct ev_watcher *)(void *)(ev))->priority /* rw */
… …
394void ev_signal_stop (EV_P_ struct ev_signal *w); 427void ev_signal_stop (EV_P_ struct ev_signal *w);
395 428
396/* only supported in the default loop */ 429/* only supported in the default loop */
397void ev_child_start (EV_P_ struct ev_child *w); 430void ev_child_start (EV_P_ struct ev_child *w);
398void ev_child_stop (EV_P_ struct ev_child *w); 431void ev_child_stop (EV_P_ struct ev_child *w);
432
433# if EV_MULTIPLICITY
434/* only supported when loop to be embedded is in fact embeddable */
435void ev_embed_start (EV_P_ struct ev_embed *w);
436void ev_embed_stop (EV_P_ struct ev_embed *w);
437# endif
438
399#endif 439#endif
400 440
401#ifdef __cplusplus 441#ifdef __cplusplus
402} 442}
403#endif 443#endif

Diff Legend

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