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

Comparing libev/ev.h (file contents):
Revision 1.29 by root, Sun Nov 4 00:24:17 2007 UTC vs.
Revision 1.42 by root, Fri Nov 9 15:15:21 2007 UTC

96 96
97/* shared by all watchers */ 97/* shared by all watchers */
98#define EV_WATCHER(type) \ 98#define EV_WATCHER(type) \
99 int active; /* private */ \ 99 int active; /* private */ \
100 int pending; /* private */ \ 100 int pending; /* private */ \
101 int priority; /* ro */ \ 101 int priority; /* private */ \
102 EV_COMMON; /* rw */ \ 102 EV_COMMON; /* rw */ \
103 void (*cb)(EV_P_ struct type *, int revents); /* rw */ /* gets invoked with an eventmask */ 103 void (*cb)(EV_P_ struct type *, int revents) /* private */ /* gets invoked with an eventmask */
104 104
105#define EV_WATCHER_LIST(type) \ 105#define EV_WATCHER_LIST(type) \
106 EV_WATCHER (type); \ 106 EV_WATCHER (type); \
107 struct ev_watcher_list *next /* private */ 107 struct ev_watcher_list *next /* private */
108 108
139struct ev_periodic 139struct ev_periodic
140{ 140{
141 EV_WATCHER_TIME (ev_periodic); 141 EV_WATCHER_TIME (ev_periodic);
142 142
143 ev_tstamp interval; /* rw */ 143 ev_tstamp interval; /* rw */
144 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */
144}; 145};
145 146
146/* invoked when fd is either EV_READable or EV_WRITEable */ 147/* invoked when fd is either EV_READable or EV_WRITEable */
147/* revent EV_READ, EV_WRITE */ 148/* revent EV_READ, EV_WRITE */
148struct ev_io 149struct ev_io
156/* invoked when the given signal has been received */ 157/* invoked when the given signal has been received */
157/* revent EV_SIGNAL */ 158/* revent EV_SIGNAL */
158struct ev_signal 159struct ev_signal
159{ 160{
160 EV_WATCHER_LIST (ev_signal); 161 EV_WATCHER_LIST (ev_signal);
161#if EV_MULTIPLICITY
162 struct ev_loop *loop;
163#endif
164 162
165 int signum; /* ro */ 163 int signum; /* ro */
166}; 164};
167 165
168/* invoked when the nothing else needs to be done, keeps the process from blocking */ 166/* invoked when the nothing else needs to be done, keeps the process from blocking */
195 EV_WATCHER_LIST (ev_child); 193 EV_WATCHER_LIST (ev_child);
196 194
197 int pid; /* ro */ 195 int pid; /* ro */
198 int rpid; /* rw, holds the received pid */ 196 int rpid; /* rw, holds the received pid */
199 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */ 197 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
198};
199
200/* the presence of this union forces similar struct layout */
201union ev_any_watcher
202{
203 struct ev_watcher w;
204 struct ev_watcher_list wl;
205 struct ev_io io;
206 struct ev_timer timer;
207 struct ev_periodic periodic;
208 struct ev_signal signal;
209 struct ev_idle idle;
210 struct ev_child child;
211 struct ev_prepare prepare;
212 struct ev_check check;
200}; 213};
201 214
202#define EVMETHOD_AUTO 0 /* consults environment */ 215#define EVMETHOD_AUTO 0 /* consults environment */
203#define EVMETHOD_SELECT 1 216#define EVMETHOD_SELECT 1
204#define EVMETHOD_POLL 2 217#define EVMETHOD_POLL 2
205#define EVMETHOD_EPOLL 4 218#define EVMETHOD_EPOLL 4
206#define EVMETHOD_KQUEUE 8 219#define EVMETHOD_KQUEUE 8
207#define EVMETHOD_DEVPOLL 16 /* NYI */ 220#define EVMETHOD_DEVPOLL 16 /* NYI */
208#define EVMETHOD_PORT 32 /* NYI */ 221#define EVMETHOD_PORT 32 /* NYI */
222#define EVMETHOD_WIN32 64 /* NYI */
209#define EVMETHOD_ANY ~0 /* any method, do not consult env */ 223#define EVMETHOD_ANY ~0 /* any method, do not consult env */
210 224
211#if EV_PROTOTYPES 225#if EV_PROTOTYPES
212int ev_version_major (void); 226int ev_version_major (void);
213int ev_version_minor (void); 227int ev_version_minor (void);
214 228
215/* these three calls are suitable for plugging into pthread_atfork */
216void ev_fork_prepare (void);
217void ev_fork_parent (void);
218void ev_fork_child (void);
219
220ev_tstamp ev_time (void); 229ev_tstamp ev_time (void);
221 230
231/* Sets the allocation function to use, works like realloc.
232 * It is used to allocate and free memory.
233 * If it returns zero when memory needs to be allocated, the library might abort
234 * or take some potentially destructive action.
235 * The default is your system realloc function.
236 */
237void ev_set_allocator (void *(*cb)(void *ptr, long size));
238
239/* set the callback function to call on a
240 * retryable syscall error
241 * (such as failed select, poll, epoll_wait)
242 */
243void ev_set_syserr_cb (void (*cb)(const char *msg));
244
222# if EV_MULTIPLICITY 245# if EV_MULTIPLICITY
246/* the default loop is the only one that handles signals and child watchers */
247/* you can call this as often as you like */
248struct ev_loop *ev_default_loop (int methods); /* returns default loop */
249
250/* create and destroy alternative loops that don't handle signals */
223struct ev_loop *ev_loop_new (int methods); 251struct ev_loop *ev_loop_new (int methods);
224void ev_loop_delete (EV_P); 252void ev_loop_destroy (EV_P);
253void ev_loop_fork (EV_P);
225# else 254# else
226int ev_init (int methods); /* returns ev_method */ 255int ev_default_loop (int methods); /* returns true when successful */
227# endif 256# endif
228 257
258void ev_default_destroy (void); /* destroy the default loop */
259/* this needs to be called after fork, to duplicate the default loop */
260/* if you create alternative loops you have to call ev_loop_fork on them */
261/* you can call it in either the parent or the child */
262/* you can actually call it at any time, anywhere :) */
263void ev_default_fork (void);
264
229int ev_method (EV_P); 265int ev_method (EV_P);
230
231#endif 266#endif
232 267
233#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 268#define EVLOOP_NONBLOCK 1 /* do not block/wait */
234#define EVLOOP_ONESHOT 2 /* block *once* only */ 269#define EVLOOP_ONESHOT 2 /* block *once* only */
235#define EVUNLOOP_ONCE 1 /* unloop once */ 270#define EVUNLOOP_ONCE 1 /* unloop once */
254void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); 289void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
255#endif 290#endif
256 291
257/* these may evaluate ev multiple times, and the other arguments at most once */ 292/* these may evaluate ev multiple times, and the other arguments at most once */
258/* either use ev_watcher_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */ 293/* either use ev_watcher_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
259#define ev_watcher_init(ev,cb_) do { (ev)->active = (ev)->pending = (ev)->priority = 0; (ev)->cb = (cb_); } while (0) 294#define ev_watcher_init(ev,cb_) do { \
295 ((struct ev_watcher *)(void *)(ev))->active = \
296 ((struct ev_watcher *)(void *)(ev))->pending = \
297 ((struct ev_watcher *)(void *)(ev))->priority = 0; \
298 (ev)->cb = (cb_); \
299} while (0)
260 300
261#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0) 301#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0)
262#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0) 302#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)
263#define ev_periodic_set(ev,at_,interval_) do { (ev)->at = (at_); (ev)->interval = (interval_); } while (0) 303#define ev_periodic_set(ev,at_,ival_,res_) do { (ev)->at = (at_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0)
264#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) 304#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
265#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */ 305#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
266#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */ 306#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
267#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */ 307#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
268#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0) 308#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0)
269 309
270#define ev_io_init(ev,cb,fd,events) do { ev_watcher_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) 310#define ev_io_init(ev,cb,fd,events) do { ev_watcher_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
271#define ev_timer_init(ev,cb,after,repeat) do { ev_watcher_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0) 311#define ev_timer_init(ev,cb,after,repeat) do { ev_watcher_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
272#define ev_periodic_init(ev,cb,at,interval) do { ev_watcher_init ((ev), (cb)); ev_periodic_set ((ev),(at),(interval)); } while (0) 312#define ev_periodic_init(ev,cb,at,ival,res) do { ev_watcher_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0)
273#define ev_signal_init(ev,cb,signum) do { ev_watcher_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0) 313#define ev_signal_init(ev,cb,signum) do { ev_watcher_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
274#define ev_idle_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_idle_set ((ev)); } while (0) 314#define ev_idle_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
275#define ev_prepare_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0) 315#define ev_prepare_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
276#define ev_check_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_check_set ((ev)); } while (0) 316#define ev_check_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
277#define ev_child_init(ev,cb,pid) do { ev_watcher_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0) 317#define ev_child_init(ev,cb,pid) do { ev_watcher_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)
278 318
319#define ev_is_pending(ev) (0 + ((struct ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
279#define ev_is_active(ev) (0 + (ev)->active) /* true when the watcher has been started */ 320#define ev_is_active(ev) (0 + ((struct ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
321
322#define ev_priority(ev) ((struct ev_watcher *)(void *)(ev))->priority /* rw */
323#define ev_cb(ev) (ev)->cb /* rw */
280#define ev_set_priority(ev,pri) (ev)->priority = pri 324#define ev_set_priority(ev,pri) ev_priority (ev) = (pri)
325#define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
281 326
282/* stopping (enabling, adding) a watcher does nothing if it is already running */ 327/* stopping (enabling, adding) a watcher does nothing if it is already running */
283/* stopping (disabling, deleting) a watcher does nothing unless its already running */ 328/* stopping (disabling, deleting) a watcher does nothing unless its already running */
284#if EV_PROTOTYPES 329#if EV_PROTOTYPES
330
331/* feeds an event into a watcher as if the event actually occured */
332/* accepts any ev_watcher type */
333void ev_feed_event (EV_P_ void *w, int revents);
334void ev_feed_fd_event (EV_P_ int fd, int revents);
335void ev_feed_signal_event (EV_P_ int signum);
336
285void ev_io_start (EV_P_ struct ev_io *w); 337void ev_io_start (EV_P_ struct ev_io *w);
286void ev_io_stop (EV_P_ struct ev_io *w); 338void ev_io_stop (EV_P_ struct ev_io *w);
287 339
288void ev_timer_start (EV_P_ struct ev_timer *w); 340void ev_timer_start (EV_P_ struct ev_timer *w);
289void ev_timer_stop (EV_P_ struct ev_timer *w); 341void ev_timer_stop (EV_P_ struct ev_timer *w);
290void 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 */ 342/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
343void ev_timer_again (EV_P_ struct ev_timer *w);
291 344
292void ev_periodic_start (EV_P_ struct ev_periodic *w); 345void ev_periodic_start (EV_P_ struct ev_periodic *w);
293void ev_periodic_stop (EV_P_ struct ev_periodic *w); 346void ev_periodic_stop (EV_P_ struct ev_periodic *w);
347void ev_periodic_again (EV_P_ struct ev_periodic *w);
294 348
349void ev_idle_start (EV_P_ struct ev_idle *w);
350void ev_idle_stop (EV_P_ struct ev_idle *w);
351
352void ev_prepare_start (EV_P_ struct ev_prepare *w);
353void ev_prepare_stop (EV_P_ struct ev_prepare *w);
354
355void ev_check_start (EV_P_ struct ev_check *w);
356void ev_check_stop (EV_P_ struct ev_check *w);
357
358/* only supported in the default loop */
295void ev_signal_start (EV_P_ struct ev_signal *w); 359void ev_signal_start (EV_P_ struct ev_signal *w);
296void ev_signal_stop (EV_P_ struct ev_signal *w); 360void ev_signal_stop (EV_P_ struct ev_signal *w);
297 361
298void ev_idle_start (EV_P_ struct ev_idle *w); 362/* only supported in the default loop */
299void ev_idle_stop (EV_P_ struct ev_idle *w);
300
301void ev_prepare_start (EV_P_ struct ev_prepare *w);
302void ev_prepare_stop (EV_P_ struct ev_prepare *w);
303
304void ev_check_start (EV_P_ struct ev_check *w);
305void ev_check_stop (EV_P_ struct ev_check *w);
306
307void ev_child_start (EV_P_ struct ev_child *w); 363void ev_child_start (EV_P_ struct ev_child *w);
308void ev_child_stop (EV_P_ struct ev_child *w); 364void ev_child_stop (EV_P_ struct ev_child *w);
309#endif 365#endif
310 366
311#ifdef __cplusplus 367#ifdef __cplusplus

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines