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.52 by root, Mon Nov 12 00:31:08 2007 UTC

… …
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 27 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 */ 28 */
29 29
30#ifndef EV_H 30#ifndef EV_H__
31#define EV_H 31#define EV_H__
32
33#ifdef __cplusplus
34extern "C" {
35#endif
32 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#ifndef EV_PERIODICS
52# define EV_PERIODICS 1
53#endif
54
55/* support multiple event loops? */
56#if EV_MULTIPLICITY
57struct ev_loop;
58# define EV_P struct ev_loop *loop
59# define EV_P_ EV_P,
60# define EV_A loop
61# define EV_A_ EV_A,
62# define EV_DEFAULT_A ev_default_loop (0)
63# define EV_DEFAULT_A_ EV_DEFAULT_A,
64#else
65# define EV_P void
66# define EV_P_
67# define EV_A
68# define EV_A_
69# define EV_DEFAULT_A
70# define EV_DEFAULT_A_
71#endif
72
35/* eventmask, revents, events... */ 73/* eventmask, revents, events... */
36#define EV_UNDEF -1 /* guaranteed to be invalid */ 74#define EV_UNDEF -1 /* guaranteed to be invalid */
37#define EV_NONE 0x000000 75#define EV_NONE 0x00
38#define EV_READ 0x000001 76#define EV_READ 0x01 /* io only */
39#define EV_WRITE 0x000002 77#define EV_WRITE 0x02 /* io only */
40#define EV_TIMEOUT 0x000004 78#define EV_TIMEOUT 0x000100 /* timer only */
41#define EV_SIGNAL 0x000008 79#define EV_PERIODIC 0x000200 /* periodic timer only */
42#define EV_IDLE 0x000010 80#define EV_SIGNAL 0x000400 /* signal only */
43#define EV_CHECK 0x000020 81#define EV_IDLE 0x000800 /* idle only */
44#define EV_PREPARE 0x000040 82#define EV_CHECK 0x001000 /* check only */
45#define EV_CHILD 0x000080 83#define EV_PREPARE 0x002000 /* prepare only */
46#define EV_ERROR 0x800000 84#define EV_CHILD 0x004000 /* child/pid only */
85#define EV_ERROR 0x800000 /* sent when an error occurs */
47 86
48/* can be used to add custom fields to all watchers */ 87/* can be used to add custom fields to all watchers, while losing binary compatibility */
49#ifndef EV_COMMON 88#ifndef EV_COMMON
50# define EV_COMMON void *data 89# define EV_COMMON void *data;
51#endif 90#endif
52#ifndef EV_PROTOTYPES 91#ifndef EV_PROTOTYPES
53# define EV_PROTOTYPES 1 92# define EV_PROTOTYPES 1
54#endif 93#endif
55 94
56#define EV_VERSION_MAJOR 1 95#define EV_VERSION_MAJOR 1
57#define EV_VERSION_MINOR 1 96#define EV_VERSION_MINOR 1
97
98#ifndef EV_CB_DECLARE
99# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents);
100#endif
101#ifndef EV_CB_INVOKE
102# define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents))
103#endif
58 104
59/* 105/*
60 * struct member types: 106 * struct member types:
61 * private: you can look at them, but not change them, and they might not mean anything to you. 107 * private: you can look at them, but not change them, and they might not mean anything to you.
62 * ro: can be read anytime, but only changed when the watcher isn't active 108 * ro: can be read anytime, but only changed when the watcher isn't active
… …
65 111
66/* shared by all watchers */ 112/* shared by all watchers */
67#define EV_WATCHER(type) \ 113#define EV_WATCHER(type) \
68 int active; /* private */ \ 114 int active; /* private */ \
69 int pending; /* private */ \ 115 int pending; /* private */ \
116 int priority; /* private */ \
70 EV_COMMON; /* rw */ \ 117 EV_COMMON /* rw */ \
71 void (*cb)(struct type *, int revents); /* rw */ /* gets invoked with an eventmask */ 118 EV_CB_DECLARE (type) /* private */
72 119
73#define EV_WATCHER_LIST(type) \ 120#define EV_WATCHER_LIST(type) \
74 EV_WATCHER (type); \ 121 EV_WATCHER (type) \
75 struct type *next /* private */ 122 struct ev_watcher_list *next; /* private */
76 123
77#define EV_WATCHER_TIME(type) \ 124#define EV_WATCHER_TIME(type) \
78 EV_WATCHER (type); \ 125 EV_WATCHER (type) \
79 ev_tstamp at /* private */ 126 ev_tstamp at; /* private */
80 127
81/* base class, nothing to see here unless you subclass */ 128/* base class, nothing to see here unless you subclass */
82struct ev_watcher { 129struct ev_watcher
130{
83 EV_WATCHER (ev_watcher); 131 EV_WATCHER (ev_watcher)
84}; 132};
85 133
86/* base class, nothing to see here unless you subclass */ 134/* base class, nothing to see here unless you subclass */
87struct ev_watcher_list { 135struct ev_watcher_list
136{
88 EV_WATCHER_LIST (ev_watcher_list); 137 EV_WATCHER_LIST (ev_watcher_list)
89}; 138};
90 139
91/* base class, nothing to see here unless you subclass */ 140/* base class, nothing to see here unless you subclass */
92struct ev_watcher_time { 141struct ev_watcher_time
142{
93 EV_WATCHER_TIME (ev_watcher_time); 143 EV_WATCHER_TIME (ev_watcher_time)
94}; 144};
95 145
96/* invoked after a specific time, repeatable (based on monotonic clock) */ 146/* invoked after a specific time, repeatable (based on monotonic clock) */
147/* revent EV_TIMEOUT */
97struct ev_timer 148struct ev_timer
98{ 149{
99 EV_WATCHER_TIME (ev_timer); 150 EV_WATCHER_TIME (ev_timer)
100 151
101 ev_tstamp repeat; /* rw */ 152 ev_tstamp repeat; /* rw */
102}; 153};
103 154
104/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */ 155/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
156/* revent EV_PERIODIC */
105struct ev_periodic 157struct ev_periodic
106{ 158{
107 EV_WATCHER_TIME (ev_periodic); 159 EV_WATCHER_TIME (ev_periodic)
108 160
109 ev_tstamp interval; /* rw */ 161 ev_tstamp interval; /* rw */
162 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */
110}; 163};
111 164
112/* invoked when fd is either EV_READable or EV_WRITEable */ 165/* invoked when fd is either EV_READable or EV_WRITEable */
166/* revent EV_READ, EV_WRITE */
113struct ev_io 167struct ev_io
114{ 168{
115 EV_WATCHER_LIST (ev_io); 169 EV_WATCHER_LIST (ev_io)
116 170
117 int fd; /* ro */ 171 int fd; /* ro */
118 int events; /* ro */ 172 int events; /* ro */
119}; 173};
120 174
121/* invoked when the given signal has been received */ 175/* invoked when the given signal has been received */
176/* revent EV_SIGNAL */
122struct ev_signal 177struct ev_signal
123{ 178{
124 EV_WATCHER_LIST (ev_signal); 179 EV_WATCHER_LIST (ev_signal)
125 180
126 int signum; /* ro */ 181 int signum; /* ro */
127}; 182};
128 183
129/* invoked when the nothing else needs to be done, keeps the process from blocking */ 184/* invoked when the nothing else needs to be done, keeps the process from blocking */
185/* revent EV_IDLE */
130struct ev_idle 186struct ev_idle
131{ 187{
132 EV_WATCHER (ev_idle); 188 EV_WATCHER (ev_idle)
133}; 189};
134 190
135/* invoked for each run of the mainloop, just before the blocking call */ 191/* invoked for each run of the mainloop, just before the blocking call */
136/* you can still change events in any way you like */ 192/* you can still change events in any way you like */
193/* revent EV_PREPARE */
137struct ev_prepare 194struct ev_prepare
138{ 195{
139 EV_WATCHER (ev_prepare); 196 EV_WATCHER (ev_prepare)
140}; 197};
141 198
142/* invoked for each run of the mainloop, just after the blocking call */ 199/* invoked for each run of the mainloop, just after the blocking call */
200/* revent EV_CHECK */
143struct ev_check 201struct ev_check
144{ 202{
145 EV_WATCHER (ev_check); 203 EV_WATCHER (ev_check)
146}; 204};
147 205
148/* invoked when sigchld is received and waitpid indicates the givne pid */ 206/* invoked when sigchld is received and waitpid indicates the givne pid */
207/* revent EV_CHILD */
208/* does not support priorities */
149struct ev_child 209struct ev_child
150{ 210{
151 EV_WATCHER_LIST (ev_child); 211 EV_WATCHER_LIST (ev_child)
152 212
153 int pid; /* ro */ 213 int pid; /* ro */
214 int rpid; /* rw, holds the received pid */
154 int status; /* rw, holds the exit status, use the macros from sys/wait.h */ 215 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
155}; 216};
156 217
157#define EVMETHOD_NONE 0 218/* the presence of this union forces similar struct layout */
219union ev_any_watcher
220{
221 struct ev_watcher w;
222 struct ev_watcher_list wl;
223
224 struct ev_io io;
225 struct ev_timer timer;
226 struct ev_periodic periodic;
227 struct ev_idle idle;
228 struct ev_prepare prepare;
229 struct ev_check check;
230 struct ev_signal signal;
231 struct ev_child child;
232};
233
234#define EVMETHOD_AUTO 0 /* consults environment */
158#define EVMETHOD_SELECT 1 235#define EVMETHOD_SELECT 1
159#define EVMETHOD_EPOLL 2 236#define EVMETHOD_POLL 2
237#define EVMETHOD_EPOLL 4
238#define EVMETHOD_KQUEUE 8
239#define EVMETHOD_DEVPOLL 16 /* NYI */
240#define EVMETHOD_PORT 32 /* NYI */
241#define EVMETHOD_WIN32 64 /* NYI */
242#define EVMETHOD_ANY ~0 /* any method, do not consult env */
243
160#if EV_PROTOTYPES 244#if EV_PROTOTYPES
161extern int ev_method;
162int ev_init (int flags); /* returns ev_method */
163int ev_version_major (void); 245int ev_version_major (void);
164int ev_version_minor (void); 246int ev_version_minor (void);
165 247
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); 248ev_tstamp ev_time (void);
249
250/* Sets the allocation function to use, works like realloc.
251 * It is used to allocate and free memory.
252 * If it returns zero when memory needs to be allocated, the library might abort
253 * or take some potentially destructive action.
254 * The default is your system realloc function.
255 */
256void ev_set_allocator (void *(*cb)(void *ptr, long size));
257
258/* set the callback function to call on a
259 * retryable syscall error
260 * (such as failed select, poll, epoll_wait)
261 */
262void ev_set_syserr_cb (void (*cb)(const char *msg));
263
264# if EV_MULTIPLICITY
265/* the default loop is the only one that handles signals and child watchers */
266/* you can call this as often as you like */
267struct ev_loop *ev_default_loop (int methods); /* returns default loop */
268
269/* create and destroy alternative loops that don't handle signals */
270struct ev_loop *ev_loop_new (int methods);
271void ev_loop_destroy (EV_P);
272void ev_loop_fork (EV_P);
273
274ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
275
276# else
277
278int ev_default_loop (int methods); /* returns true when successful */
279
280static ev_tstamp
281ev_now (void)
282{
283 extern ev_tstamp ev_rt_now;
284
285 return ev_rt_now;
286}
287# endif
288
289void ev_default_destroy (void); /* destroy the default loop */
290/* this needs to be called after fork, to duplicate the default loop */
291/* 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 */
293/* you can actually call it at any time, anywhere :) */
294void ev_default_fork (void);
295
296int ev_method (EV_P);
173#endif 297#endif
174 298
175#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 299#define EVLOOP_NONBLOCK 1 /* do not block/wait */
176#define EVLOOP_ONESHOT 2 /* block *once* only */ 300#define EVLOOP_ONESHOT 2 /* block *once* only */
301#define EVUNLOOP_ONCE 1 /* unloop once */
302#define EVUNLOOP_ALL 2 /* unloop all loops */
303
177#if EV_PROTOTYPES 304#if EV_PROTOTYPES
178void ev_loop (int flags); 305void 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 */ 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 */
307
308/*
309 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
310 * keeps one reference. if you have a long-runing watcher you never unregister that
311 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
312 */
313void ev_ref (EV_P);
314void ev_unref (EV_P);
180 315
181/* convinience function, wait for a single event, without registering an event watcher */ 316/* convinience function, wait for a single event, without registering an event watcher */
182/* if timeout is < 0, do wait indefinitely */ 317/* 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); 318void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
184#endif 319#endif
185 320
186/* these may evaluate ev multiple times, and the other arguments at most once */ 321/* 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 */ 322/* either use ev_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) 323#define ev_init(ev,cb_) do { \
324 ((struct ev_watcher *)(void *)(ev))->active = \
325 ((struct ev_watcher *)(void *)(ev))->pending = \
326 ((struct ev_watcher *)(void *)(ev))->priority = 0; \
327 ev_set_cb ((ev), cb_); \
328} while (0)
189 329
190#define evio_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0) 330#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) 331#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) 332#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) 333#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 */ 334#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 */ 335#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 */ 336#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) 337#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0)
198 338
199#define evio_init(ev,cb,fd,events) do { evw_init ((ev), (cb)); evio_set ((ev),(fd),(events)); } while (0) 339#define ev_io_init(ev,cb,fd,events) do { ev_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) 340#define ev_timer_init(ev,cb,after,repeat) do { ev_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) 341#define ev_periodic_init(ev,cb,at,ival,res) do { ev_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) 342#define ev_signal_init(ev,cb,signum) do { ev_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) 343#define ev_idle_init(ev,cb) do { ev_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) 344#define ev_prepare_init(ev,cb) do { ev_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) 345#define ev_check_init(ev,cb) do { ev_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) 346#define ev_child_init(ev,cb,pid) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)
207 347
348#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 */ 349#define ev_is_active(ev) (0 + ((struct ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
350
351#define ev_priority(ev) ((struct ev_watcher *)(void *)(ev))->priority /* rw */
352#define ev_cb(ev) (ev)->cb /* rw */
353#define ev_set_priority(ev,pri) ev_priority (ev) = (pri)
354
355#ifndef ev_set_cb
356# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
357#endif
209 358
210/* stopping (enabling, adding) a watcher does nothing if it is already running */ 359/* stopping (enabling, adding) a watcher does nothing if it is already running */
211/* stopping (disabling, deleting) a watcher does nothing unless its already running */ 360/* stopping (disabling, deleting) a watcher does nothing unless its already running */
212#if EV_PROTOTYPES 361#if EV_PROTOTYPES
362
363/* feeds an event into a watcher as if the event actually occured */
364/* accepts any ev_watcher type */
365void ev_feed_event (EV_P_ void *w, int revents);
366void ev_feed_fd_event (EV_P_ int fd, int revents);
367void ev_feed_signal_event (EV_P_ int signum);
368
213void evio_start (struct ev_io *w); 369void ev_io_start (EV_P_ struct ev_io *w);
214void evio_stop (struct ev_io *w); 370void ev_io_stop (EV_P_ struct ev_io *w);
215 371
216void evtimer_start (struct ev_timer *w); 372void ev_timer_start (EV_P_ struct ev_timer *w);
217void evtimer_stop (struct ev_timer *w); 373void 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 */ 374/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
375void ev_timer_again (EV_P_ struct ev_timer *w);
219 376
377#if EV_PERIODICS
220void evperiodic_start (struct ev_periodic *w); 378void ev_periodic_start (EV_P_ struct ev_periodic *w);
221void evperiodic_stop (struct ev_periodic *w); 379void ev_periodic_stop (EV_P_ struct ev_periodic *w);
380void ev_periodic_again (EV_P_ struct ev_periodic *w);
381#endif
222 382
223void evsignal_start (struct ev_signal *w);
224void evsignal_stop (struct ev_signal *w);
225
226void evidle_start (struct ev_idle *w); 383void ev_idle_start (EV_P_ struct ev_idle *w);
227void evidle_stop (struct ev_idle *w); 384void ev_idle_stop (EV_P_ struct ev_idle *w);
228 385
229void evprepare_start (struct ev_prepare *w); 386void ev_prepare_start (EV_P_ struct ev_prepare *w);
230void evprepare_stop (struct ev_prepare *w); 387void ev_prepare_stop (EV_P_ struct ev_prepare *w);
231 388
232void evcheck_start (struct ev_check *w); 389void ev_check_start (EV_P_ struct ev_check *w);
233void evcheck_stop (struct ev_check *w); 390void ev_check_stop (EV_P_ struct ev_check *w);
234 391
392/* only supported in the default loop */
393void ev_signal_start (EV_P_ struct ev_signal *w);
394void ev_signal_stop (EV_P_ struct ev_signal *w);
395
396/* only supported in the default loop */
235void evchild_start (struct ev_child *w); 397void ev_child_start (EV_P_ struct ev_child *w);
236void evchild_stop (struct ev_child *w); 398void ev_child_stop (EV_P_ struct ev_child *w);
237#endif 399#endif
238 400
401#ifdef __cplusplus
402}
239#endif 403#endif
240 404
405#endif
406

Diff Legend

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