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.19 by root, Thu Nov 1 13:11:12 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
35/* eventmask, revents, events... */ 39/* eventmask, revents, events... */
36#define EV_UNDEF -1 /* guaranteed to be invalid */ 40#define EV_UNDEF -1 /* guaranteed to be invalid */
37#define EV_NONE 0x00 41#define EV_NONE 0x00
38#define EV_READ 0x01 42#define EV_READ 0x01
39#define EV_WRITE 0x02 43#define EV_WRITE 0x02
40#define EV_TIMEOUT 0x04 44#define EV_TIMEOUT 0x000100
45#define EV_PERIODIC 0x000200
41#define EV_SIGNAL 0x08 46#define EV_SIGNAL 0x000400
42#define EV_IDLE 0x10 47#define EV_IDLE 0x000800
43#define EV_CHECK 0x20 48#define EV_CHECK 0x001000
44#define EV_PREPARE 0x40 49#define EV_PREPARE 0x002000
45#define EV_ERROR (0x7f|0x80) 50#define EV_CHILD 0x004000
51#define EV_ERROR 0x800000 /* sent when an error occurs */
46 52
47/* can be used to add custom fields to all watchers */ 53/* can be used to add custom fields to all watchers */
48#ifndef EV_COMMON 54#ifndef EV_COMMON
49# define EV_COMMON void *data 55# define EV_COMMON void *data
50#endif 56#endif
51#ifndef EV_PROTOTYPES 57#ifndef EV_PROTOTYPES
52# define EV_PROTOTYPES 1 58# define EV_PROTOTYPES 1
53#endif 59#endif
60
61#define EV_VERSION_MAJOR 1
62#define EV_VERSION_MINOR 1
54 63
55/* 64/*
56 * struct member types: 65 * struct member types:
57 * private: you can look at them, but not change them, and they might not mean anything to you. 66 * 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 67 * ro: can be read anytime, but only changed when the watcher isn't active
… …
88struct ev_watcher_time { 97struct ev_watcher_time {
89 EV_WATCHER_TIME (ev_watcher_time); 98 EV_WATCHER_TIME (ev_watcher_time);
90}; 99};
91 100
92/* invoked after a specific time, repeatable (based on monotonic clock) */ 101/* invoked after a specific time, repeatable (based on monotonic clock) */
102/* revent EV_TIMEOUT */
93struct ev_timer 103struct ev_timer
94{ 104{
95 EV_WATCHER_TIME (ev_timer); 105 EV_WATCHER_TIME (ev_timer);
96 106
97 ev_tstamp repeat; /* rw */ 107 ev_tstamp repeat; /* rw */
98}; 108};
99 109
100/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */ 110/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
111/* revent EV_PERIODIC */
101struct ev_periodic 112struct ev_periodic
102{ 113{
103 EV_WATCHER_TIME (ev_periodic); 114 EV_WATCHER_TIME (ev_periodic);
104 115
105 ev_tstamp interval; /* rw */ 116 ev_tstamp interval; /* rw */
106}; 117};
107 118
108/* invoked when fd is either EV_READable or EV_WRITEable */ 119/* invoked when fd is either EV_READable or EV_WRITEable */
120/* revent EV_READ, EV_WRITE */
109struct ev_io 121struct ev_io
110{ 122{
111 EV_WATCHER_LIST (ev_io); 123 EV_WATCHER_LIST (ev_io);
112 124
113 int fd; /* ro */ 125 int fd; /* ro */
114 int events; /* ro */ 126 int events; /* ro */
115}; 127};
116 128
117/* invoked when the given signal has been received */ 129/* invoked when the given signal has been received */
130/* revent EV_SIGNAL */
118struct ev_signal 131struct ev_signal
119{ 132{
120 EV_WATCHER_LIST (ev_signal); 133 EV_WATCHER_LIST (ev_signal);
121 134
122 int signum; /* ro */ 135 int signum; /* ro */
123}; 136};
124 137
125/* invoked when the nothing else needs to be done, keeps the process from blocking */ 138/* invoked when the nothing else needs to be done, keeps the process from blocking */
139/* revent EV_IDLE */
126struct ev_idle 140struct ev_idle
127{ 141{
128 EV_WATCHER (ev_idle); 142 EV_WATCHER (ev_idle);
129}; 143};
130 144
131/* invoked for each run of the mainloop, just before the blocking call */ 145/* invoked for each run of the mainloop, just before the blocking call */
132/* you can still change events in any way you like */ 146/* you can still change events in any way you like */
147/* revent EV_PREPARE */
133struct ev_prepare 148struct ev_prepare
134{ 149{
135 EV_WATCHER (ev_prepare); 150 EV_WATCHER (ev_prepare);
136}; 151};
137 152
138/* invoked for each run of the mainloop, just after the blocking call */ 153/* invoked for each run of the mainloop, just after the blocking call */
154/* revent EV_CHECK */
139struct ev_check 155struct ev_check
140{ 156{
141 EV_WATCHER (ev_check); 157 EV_WATCHER (ev_check);
158};
159
160/* invoked when sigchld is received and waitpid indicates the givne pid */
161/* revent EV_CHILD */
162struct ev_child
163{
164 EV_WATCHER_LIST (ev_child);
165
166 int pid; /* ro */
167 int status; /* rw, holds the exit status, use the macros from sys/wait.h */
142}; 168};
143 169
144#define EVMETHOD_NONE 0 170#define EVMETHOD_NONE 0
145#define EVMETHOD_SELECT 1 171#define EVMETHOD_SELECT 1
146#define EVMETHOD_EPOLL 2 172#define EVMETHOD_EPOLL 2
147#if EV_PROTOTYPES 173#if EV_PROTOTYPES
148extern int ev_method; 174extern int ev_method;
149int ev_init (int flags); /* returns ev_method */ 175int ev_init (int flags); /* returns ev_method */
176int ev_version_major (void);
177int ev_version_minor (void);
150 178
151/* these three calls are suitable for plugging into pthread_atfork */ 179/* these three calls are suitable for plugging into pthread_atfork */
152void ev_prefork (void); 180void ev_fork_prepare (void);
153void ev_postfork_parent (void); 181void ev_fork_parent (void);
154void ev_postfork_child (void); 182void ev_fork_child (void);
155 183
156extern ev_tstamp ev_now; /* time w.r.t. timers and the eventloop, updated after each poll */ 184extern ev_tstamp ev_now; /* time w.r.t. timers and the eventloop, updated after each poll */
157ev_tstamp ev_time (void); 185ev_tstamp ev_time (void);
158#endif 186#endif
159 187
… …
167/* if timeout is < 0, do wait indefinitely */ 195/* 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); 196void ev_once (int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
169#endif 197#endif
170 198
171/* these may evaluate ev multiple times, and the other arguments at most once */ 199/* 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 */ 200/* 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) 201#define ev_watcher_init(ev,cb_) do { (ev)->active = 0; (ev)->pending = 0; (ev)->cb = (cb_); } while (0)
174 202
175#define evio_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0) 203#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) 204#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) 205#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) 206#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 */ 207#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 */ 208#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 */ 209#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
210#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0)
182 211
183#define evio_init(ev,cb,fd,events) do { evw_init ((ev), (cb)); evio_set ((ev),(fd),(events)); } while (0) 212#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) 213#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) 214#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) 215#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) 216#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) 217#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) 218#define ev_check_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
219#define ev_child_init(ev,cb,pid) do { ev_watcher_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)
190 220
191#define ev_is_active(ev) (0 + (ev)->active) /* true when the watcher has been started */ 221#define ev_is_active(ev) (0 + (ev)->active) /* true when the watcher has been started */
192 222
193/* stopping (enabling, adding) a watcher does nothing if it is already running */ 223/* stopping (enabling, adding) a watcher does nothing if it is already running */
194/* stopping (disabling, deleting) a watcher does nothing unless its already running */ 224/* stopping (disabling, deleting) a watcher does nothing unless its already running */
195#if EV_PROTOTYPES 225#if EV_PROTOTYPES
196void evio_start (struct ev_io *w); 226void ev_io_start (struct ev_io *w);
197void evio_stop (struct ev_io *w); 227void ev_io_stop (struct ev_io *w);
198 228
199void evtimer_start (struct ev_timer *w); 229void ev_timer_start (struct ev_timer *w);
200void evtimer_stop (struct ev_timer *w); 230void ev_timer_stop (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 */ 231void ev_timer_again (struct ev_timer *w); /* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
202 232
203void evperiodic_start (struct ev_periodic *w); 233void ev_periodic_start (struct ev_periodic *w);
204void evperiodic_stop (struct ev_periodic *w); 234void ev_periodic_stop (struct ev_periodic *w);
205 235
206void evsignal_start (struct ev_signal *w); 236void ev_signal_start (struct ev_signal *w);
207void evsignal_stop (struct ev_signal *w); 237void ev_signal_stop (struct ev_signal *w);
208 238
209void evidle_start (struct ev_idle *w); 239void ev_idle_start (struct ev_idle *w);
210void evidle_stop (struct ev_idle *w); 240void ev_idle_stop (struct ev_idle *w);
211 241
212void evprepare_start (struct ev_prepare *w); 242void ev_prepare_start (struct ev_prepare *w);
213void evprepare_stop (struct ev_prepare *w); 243void ev_prepare_stop (struct ev_prepare *w);
214 244
215void evcheck_start (struct ev_check *w); 245void ev_check_start (struct ev_check *w);
216void evcheck_stop (struct ev_check *w); 246void ev_check_stop (struct ev_check *w);
217#endif
218 247
248void ev_child_start (struct ev_child *w);
249void ev_child_stop (struct ev_child *w);
219#endif 250#endif
220 251
252#ifdef __cplusplus
253}
254#endif
255
256#endif
257

Diff Legend

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