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

Comparing libev/ev.h (file contents):
Revision 1.15 by root, Wed Oct 31 22:16:36 2007 UTC vs.
Revision 1.17 by root, Thu Nov 1 11:11:22 2007 UTC

… …
31#define EV_H 31#define EV_H
32 32
33typedef double ev_tstamp; 33typedef double ev_tstamp;
34 34
35/* eventmask, revents, events... */ 35/* eventmask, revents, events... */
36#define EV_UNDEF -1 /* guaranteed to be invalid */ 36#define EV_UNDEF -1 /* guaranteed to be invalid */
37#define EV_NONE 0x00 37#define EV_NONE 0x00
38#define EV_READ 0x01 38#define EV_READ 0x01
39#define EV_WRITE 0x02 39#define EV_WRITE 0x02
40#define EV_REIFY 0x04 /* private */
41#define EV_TIMEOUT 0x000100 40#define EV_TIMEOUT 0x000100
41#define EV_PERIODIC 0x000200
42#define EV_SIGNAL 0x000200 42#define EV_SIGNAL 0x000400
43#define EV_IDLE 0x000400 43#define EV_IDLE 0x000800
44#define EV_CHECK 0x000800 44#define EV_CHECK 0x001000
45#define EV_PREPARE 0x001000 45#define EV_PREPARE 0x002000
46#define EV_CHILD 0x002000 46#define EV_CHILD 0x004000
47#define EV_ERROR 0x800000 /* sent when an error occurs */ 47#define EV_ERROR 0x800000 /* sent when an error occurs */
48 48
49/* can be used to add custom fields to all watchers */ 49/* can be used to add custom fields to all watchers */
50#ifndef EV_COMMON 50#ifndef EV_COMMON
51# define EV_COMMON void *data 51# define EV_COMMON void *data
52#endif 52#endif
… …
93struct ev_watcher_time { 93struct ev_watcher_time {
94 EV_WATCHER_TIME (ev_watcher_time); 94 EV_WATCHER_TIME (ev_watcher_time);
95}; 95};
96 96
97/* invoked after a specific time, repeatable (based on monotonic clock) */ 97/* invoked after a specific time, repeatable (based on monotonic clock) */
98/* revent EV_TIMEOUT */
98struct ev_timer 99struct ev_timer
99{ 100{
100 EV_WATCHER_TIME (ev_timer); 101 EV_WATCHER_TIME (ev_timer);
101 102
102 ev_tstamp repeat; /* rw */ 103 ev_tstamp repeat; /* rw */
103}; 104};
104 105
105/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */ 106/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
107/* revent EV_PERIODIC */
106struct ev_periodic 108struct ev_periodic
107{ 109{
108 EV_WATCHER_TIME (ev_periodic); 110 EV_WATCHER_TIME (ev_periodic);
109 111
110 ev_tstamp interval; /* rw */ 112 ev_tstamp interval; /* rw */
111}; 113};
112 114
113/* invoked when fd is either EV_READable or EV_WRITEable */ 115/* invoked when fd is either EV_READable or EV_WRITEable */
116/* revent EV_READ, EV_WRITE */
114struct ev_io 117struct ev_io
115{ 118{
116 EV_WATCHER_LIST (ev_io); 119 EV_WATCHER_LIST (ev_io);
117 120
118 int fd; /* ro */ 121 int fd; /* ro */
119 int events; /* ro */ 122 int events; /* ro */
120}; 123};
121 124
122/* invoked when the given signal has been received */ 125/* invoked when the given signal has been received */
126/* revent EV_SIGNAL */
123struct ev_signal 127struct ev_signal
124{ 128{
125 EV_WATCHER_LIST (ev_signal); 129 EV_WATCHER_LIST (ev_signal);
126 130
127 int signum; /* ro */ 131 int signum; /* ro */
128}; 132};
129 133
130/* invoked when the nothing else needs to be done, keeps the process from blocking */ 134/* invoked when the nothing else needs to be done, keeps the process from blocking */
135/* revent EV_IDLE */
131struct ev_idle 136struct ev_idle
132{ 137{
133 EV_WATCHER (ev_idle); 138 EV_WATCHER (ev_idle);
134}; 139};
135 140
136/* invoked for each run of the mainloop, just before the blocking call */ 141/* invoked for each run of the mainloop, just before the blocking call */
137/* you can still change events in any way you like */ 142/* you can still change events in any way you like */
143/* revent EV_PREPARE */
138struct ev_prepare 144struct ev_prepare
139{ 145{
140 EV_WATCHER (ev_prepare); 146 EV_WATCHER (ev_prepare);
141}; 147};
142 148
143/* invoked for each run of the mainloop, just after the blocking call */ 149/* invoked for each run of the mainloop, just after the blocking call */
150/* revent EV_CHECK */
144struct ev_check 151struct ev_check
145{ 152{
146 EV_WATCHER (ev_check); 153 EV_WATCHER (ev_check);
147}; 154};
148 155
149/* invoked when sigchld is received and waitpid indicates the givne pid */ 156/* invoked when sigchld is received and waitpid indicates the givne pid */
157/* revent EV_CHILD */
150struct ev_child 158struct ev_child
151{ 159{
152 EV_WATCHER_LIST (ev_child); 160 EV_WATCHER_LIST (ev_child);
153 161
154 int pid; /* ro */ 162 int pid; /* ro */
… …
183/* if timeout is < 0, do wait indefinitely */ 191/* if timeout is < 0, do wait indefinitely */
184void ev_once (int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); 192void ev_once (int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
185#endif 193#endif
186 194
187/* these may evaluate ev multiple times, and the other arguments at most once */ 195/* these may evaluate ev multiple times, and the other arguments at most once */
188/* either use evw_init + evXXX_set, or the evXXX_init macro, below, to first initialise a watcher */ 196/* either use ev_watcher_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
189#define evw_init(ev,cb_) do { (ev)->active = 0; (ev)->pending = 0; (ev)->cb = (cb_); } while (0) 197#define ev_watcher_init(ev,cb_) do { (ev)->active = 0; (ev)->pending = 0; (ev)->cb = (cb_); } while (0)
190 198
191#define evio_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0) 199#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0)
192#define evtimer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0) 200#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)
193#define evperiodic_set(ev,at_,interval_) do { (ev)->at = (at_); (ev)->interval = (interval_); } while (0) 201#define ev_periodic_set(ev,at_,interval_) do { (ev)->at = (at_); (ev)->interval = (interval_); } while (0)
194#define evsignal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) 202#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
195#define evidle_set(ev) /* nop, yes, this is a serious in-joke */ 203#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
196#define evprepare_set(ev) /* nop, yes, this is a serious in-joke */ 204#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
197#define evcheck_set(ev) /* nop, yes, this is a serious in-joke */ 205#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
198#define evchild_set(ev,pid_) do { (ev)->pid = (pid_); } while (0) 206#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0)
199 207
200#define evio_init(ev,cb,fd,events) do { evw_init ((ev), (cb)); evio_set ((ev),(fd),(events)); } while (0) 208#define ev_io_init(ev,cb,fd,events) do { ev_watcher_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
201#define evtimer_init(ev,cb,after,repeat) do { evw_init ((ev), (cb)); evtimer_set ((ev),(after),(repeat)); } while (0) 209#define ev_timer_init(ev,cb,after,repeat) do { ev_watcher_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
202#define evperiodic_init(ev,cb,at,interval) do { evw_init ((ev), (cb)); evperiodic_set ((ev),(at),(interval)); } while (0) 210#define ev_periodic_init(ev,cb,at,interval) do { ev_watcher_init ((ev), (cb)); ev_periodic_set ((ev),(at),(interval)); } while (0)
203#define evsignal_init(ev,cb,signum) do { evw_init ((ev), (cb)); evsignal_set ((ev), (signum)); } while (0) 211#define ev_signal_init(ev,cb,signum) do { ev_watcher_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
204#define evidle_init(ev,cb) do { evw_init ((ev), (cb)); evidle_set ((ev)); } while (0) 212#define ev_idle_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
205#define evprepare_init(ev,cb) do { evw_init ((ev), (cb)); evprepare_set ((ev)); } while (0) 213#define ev_prepare_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
206#define evcheck_init(ev,cb) do { evw_init ((ev), (cb)); evcheck_set ((ev)); } while (0) 214#define ev_check_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
207#define evchild_init(ev,cb,pid) do { evw_init ((ev), (cb)); evchild_set ((ev),(pid)); } while (0) 215#define ev_child_init(ev,cb,pid) do { ev_watcher_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)
208 216
209#define ev_is_active(ev) (0 + (ev)->active) /* true when the watcher has been started */ 217#define ev_is_active(ev) (0 + (ev)->active) /* true when the watcher has been started */
210 218
211/* stopping (enabling, adding) a watcher does nothing if it is already running */ 219/* stopping (enabling, adding) a watcher does nothing if it is already running */
212/* stopping (disabling, deleting) a watcher does nothing unless its already running */ 220/* stopping (disabling, deleting) a watcher does nothing unless its already running */
213#if EV_PROTOTYPES 221#if EV_PROTOTYPES
214void evio_start (struct ev_io *w); 222void ev_io_start (struct ev_io *w);
215void evio_stop (struct ev_io *w); 223void ev_io_stop (struct ev_io *w);
216 224
217void evtimer_start (struct ev_timer *w); 225void ev_timer_start (struct ev_timer *w);
218void evtimer_stop (struct ev_timer *w); 226void ev_timer_stop (struct ev_timer *w);
219void evtimer_again (struct ev_timer *w); /* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */ 227void ev_timer_again (struct ev_timer *w); /* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
220 228
221void evperiodic_start (struct ev_periodic *w); 229void ev_periodic_start (struct ev_periodic *w);
222void evperiodic_stop (struct ev_periodic *w); 230void ev_periodic_stop (struct ev_periodic *w);
223 231
224void evsignal_start (struct ev_signal *w); 232void ev_signal_start (struct ev_signal *w);
225void evsignal_stop (struct ev_signal *w); 233void ev_signal_stop (struct ev_signal *w);
226 234
227void evidle_start (struct ev_idle *w); 235void ev_idle_start (struct ev_idle *w);
228void evidle_stop (struct ev_idle *w); 236void ev_idle_stop (struct ev_idle *w);
229 237
230void evprepare_start (struct ev_prepare *w); 238void ev_prepare_start (struct ev_prepare *w);
231void evprepare_stop (struct ev_prepare *w); 239void ev_prepare_stop (struct ev_prepare *w);
232 240
233void evcheck_start (struct ev_check *w); 241void ev_check_start (struct ev_check *w);
234void evcheck_stop (struct ev_check *w); 242void ev_check_stop (struct ev_check *w);
235 243
236void evchild_start (struct ev_child *w); 244void ev_child_start (struct ev_child *w);
237void evchild_stop (struct ev_child *w); 245void ev_child_stop (struct ev_child *w);
238#endif 246#endif
239 247
240#endif 248#endif
241 249

Diff Legend

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