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

Comparing libev/ev.h (file contents):
Revision 1.14 by root, Wed Oct 31 20:46:44 2007 UTC vs.
Revision 1.41 by root, Thu Nov 8 21:08:56 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#ifndef EV_MULTIPLICITY
48# define EV_MULTIPLICITY 1
49#endif
50
51/* support multiple event loops? */
52#if EV_MULTIPLICITY
53struct ev_loop;
54# define EV_P struct ev_loop *loop
55# define EV_P_ EV_P,
56# define EV_A loop
57# define EV_A_ EV_A,
58#else
59# define EV_P void
60# define EV_P_
61# define EV_A
62# define EV_A_
63#endif
64
35/* eventmask, revents, events... */ 65/* eventmask, revents, events... */
36#define EV_UNDEF -1 /* guaranteed to be invalid */ 66#define EV_UNDEF -1 /* guaranteed to be invalid */
37#define EV_NONE 0x000000 67#define EV_NONE 0x00
38#define EV_READ 0x000001 68#define EV_READ 0x01
39#define EV_WRITE 0x000002 69#define EV_WRITE 0x02
40#define EV_TIMEOUT 0x000004 70#define EV_TIMEOUT 0x000100
71#define EV_PERIODIC 0x000200
41#define EV_SIGNAL 0x000008 72#define EV_SIGNAL 0x000400
42#define EV_IDLE 0x000010 73#define EV_IDLE 0x000800
43#define EV_CHECK 0x000020 74#define EV_CHECK 0x001000
44#define EV_PREPARE 0x000040 75#define EV_PREPARE 0x002000
45#define EV_CHILD 0x000080 76#define EV_CHILD 0x004000
46#define EV_ERROR 0x800000 77#define EV_ERROR 0x800000 /* sent when an error occurs */
47 78
48/* can be used to add custom fields to all watchers */ 79/* can be used to add custom fields to all watchers */
49#ifndef EV_COMMON 80#ifndef EV_COMMON
50# define EV_COMMON void *data 81# define EV_COMMON void *data
51#endif 82#endif
… …
65 96
66/* shared by all watchers */ 97/* shared by all watchers */
67#define EV_WATCHER(type) \ 98#define EV_WATCHER(type) \
68 int active; /* private */ \ 99 int active; /* private */ \
69 int pending; /* private */ \ 100 int pending; /* private */ \
101 int priority; /* private */ \
70 EV_COMMON; /* rw */ \ 102 EV_COMMON; /* rw */ \
71 void (*cb)(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 */
72 104
73#define EV_WATCHER_LIST(type) \ 105#define EV_WATCHER_LIST(type) \
74 EV_WATCHER (type); \ 106 EV_WATCHER (type); \
75 struct type *next /* private */ 107 struct ev_watcher_list *next /* private */
76 108
77#define EV_WATCHER_TIME(type) \ 109#define EV_WATCHER_TIME(type) \
78 EV_WATCHER (type); \ 110 EV_WATCHER (type); \
79 ev_tstamp at /* private */ 111 ev_tstamp at /* private */
80 112
… …
92struct ev_watcher_time { 124struct ev_watcher_time {
93 EV_WATCHER_TIME (ev_watcher_time); 125 EV_WATCHER_TIME (ev_watcher_time);
94}; 126};
95 127
96/* invoked after a specific time, repeatable (based on monotonic clock) */ 128/* invoked after a specific time, repeatable (based on monotonic clock) */
129/* revent EV_TIMEOUT */
97struct ev_timer 130struct ev_timer
98{ 131{
99 EV_WATCHER_TIME (ev_timer); 132 EV_WATCHER_TIME (ev_timer);
100 133
101 ev_tstamp repeat; /* rw */ 134 ev_tstamp repeat; /* rw */
102}; 135};
103 136
104/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */ 137/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
138/* revent EV_PERIODIC */
105struct ev_periodic 139struct ev_periodic
106{ 140{
107 EV_WATCHER_TIME (ev_periodic); 141 EV_WATCHER_TIME (ev_periodic);
108 142
109 ev_tstamp interval; /* rw */ 143 ev_tstamp interval; /* rw */
144 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */
110}; 145};
111 146
112/* invoked when fd is either EV_READable or EV_WRITEable */ 147/* invoked when fd is either EV_READable or EV_WRITEable */
148/* revent EV_READ, EV_WRITE */
113struct ev_io 149struct ev_io
114{ 150{
115 EV_WATCHER_LIST (ev_io); 151 EV_WATCHER_LIST (ev_io);
116 152
117 int fd; /* ro */ 153 int fd; /* ro */
118 int events; /* ro */ 154 int events; /* ro */
119}; 155};
120 156
121/* invoked when the given signal has been received */ 157/* invoked when the given signal has been received */
158/* revent EV_SIGNAL */
122struct ev_signal 159struct ev_signal
123{ 160{
124 EV_WATCHER_LIST (ev_signal); 161 EV_WATCHER_LIST (ev_signal);
125 162
126 int signum; /* ro */ 163 int signum; /* ro */
127}; 164};
128 165
129/* 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 */
167/* revent EV_IDLE */
130struct ev_idle 168struct ev_idle
131{ 169{
132 EV_WATCHER (ev_idle); 170 EV_WATCHER (ev_idle);
133}; 171};
134 172
135/* invoked for each run of the mainloop, just before the blocking call */ 173/* invoked for each run of the mainloop, just before the blocking call */
136/* you can still change events in any way you like */ 174/* you can still change events in any way you like */
175/* revent EV_PREPARE */
137struct ev_prepare 176struct ev_prepare
138{ 177{
139 EV_WATCHER (ev_prepare); 178 EV_WATCHER (ev_prepare);
140}; 179};
141 180
142/* invoked for each run of the mainloop, just after the blocking call */ 181/* invoked for each run of the mainloop, just after the blocking call */
182/* revent EV_CHECK */
143struct ev_check 183struct ev_check
144{ 184{
145 EV_WATCHER (ev_check); 185 EV_WATCHER (ev_check);
146}; 186};
147 187
148/* invoked when sigchld is received and waitpid indicates the givne pid */ 188/* invoked when sigchld is received and waitpid indicates the givne pid */
189/* revent EV_CHILD */
190/* does not support priorities */
149struct ev_child 191struct ev_child
150{ 192{
151 EV_WATCHER_LIST (ev_child); 193 EV_WATCHER_LIST (ev_child);
152 194
153 int pid; /* ro */ 195 int pid; /* ro */
196 int rpid; /* rw, holds the received pid */
154 int status; /* 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 */
155}; 198};
156 199
157#define EVMETHOD_NONE 0 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;
213};
214
215#define EVMETHOD_AUTO 0 /* consults environment */
158#define EVMETHOD_SELECT 1 216#define EVMETHOD_SELECT 1
159#define EVMETHOD_EPOLL 2 217#define EVMETHOD_POLL 2
218#define EVMETHOD_EPOLL 4
219#define EVMETHOD_KQUEUE 8
220#define EVMETHOD_DEVPOLL 16 /* NYI */
221#define EVMETHOD_PORT 32 /* NYI */
222#define EVMETHOD_WIN32 64 /* NYI */
223#define EVMETHOD_ANY ~0 /* any method, do not consult env */
224
160#if EV_PROTOTYPES 225#if EV_PROTOTYPES
161extern int ev_method;
162int ev_init (int flags); /* returns ev_method */
163int ev_version_major (void); 226int ev_version_major (void);
164int ev_version_minor (void); 227int ev_version_minor (void);
165 228
166/* these three calls are suitable for plugging into pthread_atfork */
167void ev_prefork (void);
168void ev_postfork_parent (void);
169void ev_postfork_child (void);
170
171extern ev_tstamp ev_now; /* time w.r.t. timers and the eventloop, updated after each poll */
172ev_tstamp ev_time (void); 229ev_tstamp ev_time (void);
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
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 */
251struct ev_loop *ev_loop_new (int methods);
252void ev_loop_destroy (EV_P);
253void ev_loop_fork (EV_P);
254# else
255int ev_default_loop (int methods); /* returns true when successful */
256# endif
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
265int ev_method (EV_P);
173#endif 266#endif
174 267
175#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 268#define EVLOOP_NONBLOCK 1 /* do not block/wait */
176#define EVLOOP_ONESHOT 2 /* block *once* only */ 269#define EVLOOP_ONESHOT 2 /* block *once* only */
270#define EVUNLOOP_ONCE 1 /* unloop once */
271#define EVUNLOOP_ALL 2 /* unloop all loops */
272
177#if EV_PROTOTYPES 273#if EV_PROTOTYPES
178void ev_loop (int flags); 274void ev_loop (EV_P_ int flags);
179extern int ev_loop_done; /* set to 1 to break out of event loop, set to 2 to break out of all event loops */ 275void 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 */
276
277ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
278
279/*
280 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
281 * keeps one reference. if you have a long-runing watcher you never unregister that
282 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
283 */
284void ev_ref (EV_P);
285void ev_unref (EV_P);
180 286
181/* convinience function, wait for a single event, without registering an event watcher */ 287/* convinience function, wait for a single event, without registering an event watcher */
182/* if timeout is < 0, do wait indefinitely */ 288/* if timeout is < 0, do wait indefinitely */
183void ev_once (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);
184#endif 290#endif
185 291
186/* 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 */
187/* either use evw_init + evXXX_set, or the evXXX_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 */
188#define evw_init(ev,cb_) do { (ev)->active = 0; (ev)->pending = 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)
189 300
190#define evio_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)
191#define evtimer_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)
192#define evperiodic_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)
193#define evsignal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) 304#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
194#define evidle_set(ev) /* nop, yes, this is a serious in-joke */ 305#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
195#define evprepare_set(ev) /* nop, yes, this is a serious in-joke */ 306#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
196#define evcheck_set(ev) /* nop, yes, this is a serious in-joke */ 307#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
197#define evchild_set(ev,pid_) do { (ev)->pid = (pid_); } while (0) 308#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0)
198 309
199#define evio_init(ev,cb,fd,events) do { evw_init ((ev), (cb)); evio_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)
200#define evtimer_init(ev,cb,after,repeat) do { evw_init ((ev), (cb)); evtimer_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)
201#define evperiodic_init(ev,cb,at,interval) do { evw_init ((ev), (cb)); evperiodic_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)
202#define evsignal_init(ev,cb,signum) do { evw_init ((ev), (cb)); evsignal_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)
203#define evidle_init(ev,cb) do { evw_init ((ev), (cb)); evidle_set ((ev)); } while (0) 314#define ev_idle_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
204#define evprepare_init(ev,cb) do { evw_init ((ev), (cb)); evprepare_set ((ev)); } while (0) 315#define ev_prepare_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
205#define evcheck_init(ev,cb) do { evw_init ((ev), (cb)); evcheck_set ((ev)); } while (0) 316#define ev_check_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
206#define evchild_init(ev,cb,pid) do { evw_init ((ev), (cb)); evchild_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)
207 318
319#define ev_is_pending(ev) (0 + ((struct ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
208#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 */
324#define ev_set_priority(ev,pri) ev_priority (ev) = (pri)
325#define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
209 326
210/* 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 */
211/* stopping (disabling, deleting) a watcher does nothing unless its already running */ 328/* stopping (disabling, deleting) a watcher does nothing unless its already running */
212#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);
334
213void evio_start (struct ev_io *w); 335void ev_io_start (EV_P_ struct ev_io *w);
214void evio_stop (struct ev_io *w); 336void ev_io_stop (EV_P_ struct ev_io *w);
215 337
216void evtimer_start (struct ev_timer *w); 338void ev_timer_start (EV_P_ struct ev_timer *w);
217void evtimer_stop (struct ev_timer *w); 339void ev_timer_stop (EV_P_ struct ev_timer *w);
218void evtimer_again (struct ev_timer *w); /* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */ 340/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
341void ev_timer_again (EV_P_ struct ev_timer *w);
219 342
220void evperiodic_start (struct ev_periodic *w); 343void ev_periodic_start (EV_P_ struct ev_periodic *w);
221void evperiodic_stop (struct ev_periodic *w); 344void ev_periodic_stop (EV_P_ struct ev_periodic *w);
345void ev_periodic_again (EV_P_ struct ev_periodic *w);
222 346
223void evsignal_start (struct ev_signal *w);
224void evsignal_stop (struct ev_signal *w);
225
226void evidle_start (struct ev_idle *w); 347void ev_idle_start (EV_P_ struct ev_idle *w);
227void evidle_stop (struct ev_idle *w); 348void ev_idle_stop (EV_P_ struct ev_idle *w);
228 349
229void evprepare_start (struct ev_prepare *w); 350void ev_prepare_start (EV_P_ struct ev_prepare *w);
230void evprepare_stop (struct ev_prepare *w); 351void ev_prepare_stop (EV_P_ struct ev_prepare *w);
231 352
232void evcheck_start (struct ev_check *w); 353void ev_check_start (EV_P_ struct ev_check *w);
233void evcheck_stop (struct ev_check *w); 354void ev_check_stop (EV_P_ struct ev_check *w);
234 355
356/* only supported in the default loop */
357void ev_signal_start (EV_P_ struct ev_signal *w);
358void ev_signal_stop (EV_P_ struct ev_signal *w);
359
360/* only supported in the default loop */
235void evchild_start (struct ev_child *w); 361void ev_child_start (EV_P_ struct ev_child *w);
236void evchild_stop (struct ev_child *w); 362void ev_child_stop (EV_P_ struct ev_child *w);
237#endif 363#endif
238 364
365#ifdef __cplusplus
366}
239#endif 367#endif
240 368
369#endif
370

Diff Legend

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