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

Comparing libev/ev.h (file contents):
Revision 1.10 by root, Wed Oct 31 14:44:15 2007 UTC vs.
Revision 1.20 by root, Fri Nov 2 16:54:35 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_ERROR (0x3f|0x80) 49#define EV_PREPARE 0x002000
50#define EV_CHILD 0x004000
51#define EV_ERROR 0x800000 /* sent when an error occurs */
45 52
46/* can be used to add custom fields to all watchers */ 53/* can be used to add custom fields to all watchers */
47#ifndef EV_COMMON 54#ifndef EV_COMMON
48# define EV_COMMON void *data 55# define EV_COMMON void *data
49#endif 56#endif
50#ifndef EV_PROTOTYPES 57#ifndef EV_PROTOTYPES
51# define EV_PROTOTYPES 1 58# define EV_PROTOTYPES 1
52#endif 59#endif
60
61#define EV_VERSION_MAJOR 1
62#define EV_VERSION_MINOR 1
53 63
54/* 64/*
55 * struct member types: 65 * struct member types:
56 * 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.
57 * 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
… …
87struct ev_watcher_time { 97struct ev_watcher_time {
88 EV_WATCHER_TIME (ev_watcher_time); 98 EV_WATCHER_TIME (ev_watcher_time);
89}; 99};
90 100
91/* 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 */
92struct ev_timer 103struct ev_timer
93{ 104{
94 EV_WATCHER_TIME (ev_timer); 105 EV_WATCHER_TIME (ev_timer);
95 106
96 ev_tstamp repeat; /* rw */ 107 ev_tstamp repeat; /* rw */
97}; 108};
98 109
99/* 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 */
100struct ev_periodic 112struct ev_periodic
101{ 113{
102 EV_WATCHER_TIME (ev_periodic); 114 EV_WATCHER_TIME (ev_periodic);
103 115
104 ev_tstamp interval; /* rw */ 116 ev_tstamp interval; /* rw */
105}; 117};
106 118
107/* 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 */
108struct ev_io 121struct ev_io
109{ 122{
110 EV_WATCHER_LIST (ev_io); 123 EV_WATCHER_LIST (ev_io);
111 124
112 int fd; /* ro */ 125 int fd; /* ro */
113 int events; /* ro */ 126 int events; /* ro */
114}; 127};
115 128
116/* invoked when the given signal has been received */ 129/* invoked when the given signal has been received */
130/* revent EV_SIGNAL */
117struct ev_signal 131struct ev_signal
118{ 132{
119 EV_WATCHER_LIST (ev_signal); 133 EV_WATCHER_LIST (ev_signal);
120 134
121 int signum; /* ro */ 135 int signum; /* ro */
122}; 136};
123 137
124/* 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 */
125struct ev_idle 140struct ev_idle
126{ 141{
127 EV_WATCHER (ev_idle); 142 EV_WATCHER (ev_idle);
128}; 143};
129 144
130/* invoked for each run of the mainloop, just before the next blocking vall is initiated */ 145/* invoked for each run of the mainloop, just before the blocking call */
146/* you can still change events in any way you like */
147/* revent EV_PREPARE */
148struct ev_prepare
149{
150 EV_WATCHER (ev_prepare);
151};
152
153/* invoked for each run of the mainloop, just after the blocking call */
154/* revent EV_CHECK */
131struct ev_check 155struct ev_check
132{ 156{
133 EV_WATCHER (ev_check); 157 EV_WATCHER (ev_check);
134}; 158};
135 159
136#define EVMETHOD_NONE 0 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 */
168};
169
170#define EVMETHOD_AUTO 0 /* consults environment */
137#define EVMETHOD_SELECT 1 171#define EVMETHOD_SELECT 1
138#define EVMETHOD_EPOLL 2 172#define EVMETHOD_POLL 2
173#define EVMETHOD_EPOLL 4
174#define EVMETHOD_ANY ~0 /* any method, do not consult env */
139#if EV_PROTOTYPES 175#if EV_PROTOTYPES
140extern int ev_method; 176extern int ev_method;
141int ev_init (int flags); /* returns ev_method */ 177int ev_init (int methods); /* returns ev_method */
178int ev_version_major (void);
179int ev_version_minor (void);
142 180
143/* these three calls are suitable for plugging into pthread_atfork */ 181/* these three calls are suitable for plugging into pthread_atfork */
144void ev_prefork (void); 182void ev_fork_prepare (void);
145void ev_postfork_parent (void); 183void ev_fork_parent (void);
146void ev_postfork_child (void); 184void ev_fork_child (void);
147 185
148extern ev_tstamp ev_now; /* time w.r.t. timers and the eventloop, updated after each poll */ 186extern ev_tstamp ev_now; /* time w.r.t. timers and the eventloop, updated after each poll */
149ev_tstamp ev_time (void); 187ev_tstamp ev_time (void);
150#endif 188#endif
151 189
… …
159/* if timeout is < 0, do wait indefinitely */ 197/* if timeout is < 0, do wait indefinitely */
160void ev_once (int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); 198void ev_once (int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
161#endif 199#endif
162 200
163/* these may evaluate ev multiple times, and the other arguments at most once */ 201/* these may evaluate ev multiple times, and the other arguments at most once */
164/* either use evw_init + evXXX_set, or the evXXX_init macro, below, to first initialise a watcher */ 202/* either use ev_watcher_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
165#define evw_init(ev,cb_) do { (ev)->active = 0; (ev)->pending = 0; (ev)->cb = (cb_); } while (0) 203#define ev_watcher_init(ev,cb_) do { (ev)->active = 0; (ev)->pending = 0; (ev)->cb = (cb_); } while (0)
166 204
167#define evio_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0) 205#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0)
168#define evtimer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0) 206#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)
169#define evperiodic_set(ev,at_,interval_) do { (ev)->at = (at_); (ev)->interval = (interval_); } while (0) 207#define ev_periodic_set(ev,at_,interval_) do { (ev)->at = (at_); (ev)->interval = (interval_); } while (0)
170#define evsignal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) 208#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
171#define evcheck_set(ev) /* nop, yes, this is a serious in-joke */
172#define evidle_set(ev) /* nop, yes, this is a serious in-joke */ 209#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
210#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
211#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
212#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0)
173 213
174#define evio_init(ev,cb,fd,events) do { evw_init ((ev), (cb)); evio_set ((ev),(fd),(events)); } while (0) 214#define ev_io_init(ev,cb,fd,events) do { ev_watcher_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
175#define evtimer_init(ev,cb,after,repeat) do { evw_init ((ev), (cb)); evtimer_set ((ev),(after),(repeat)); } while (0) 215#define ev_timer_init(ev,cb,after,repeat) do { ev_watcher_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
176#define evperiodic_init(ev,cb,at,interval) do { evw_init ((ev), (cb)); evperiodic_set ((ev),(at),(interval)); } while (0) 216#define ev_periodic_init(ev,cb,at,interval) do { ev_watcher_init ((ev), (cb)); ev_periodic_set ((ev),(at),(interval)); } while (0)
177#define evsignal_init(ev,cb,signum) do { evw_init ((ev), (cb)); evsignal_set ((ev), (signum)); } while (0) 217#define ev_signal_init(ev,cb,signum) do { ev_watcher_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
218#define ev_idle_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
219#define ev_prepare_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
178#define evcheck_init(ev,cb) do { evw_init ((ev), (cb)); evcheck_set ((ev)); } while (0) 220#define ev_check_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
179#define evidle_init(ev,cb) do { evw_init ((ev), (cb)); evidle_set ((ev)); } while (0) 221#define ev_child_init(ev,cb,pid) do { ev_watcher_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)
180 222
181#define ev_is_active(ev) (0 + (ev)->active) /* true when the watcher has been started */ 223#define ev_is_active(ev) (0 + (ev)->active) /* true when the watcher has been started */
182 224
183/* stopping (enabling, adding) a watcher does nothing if it is already running */ 225/* stopping (enabling, adding) a watcher does nothing if it is already running */
184/* stopping (disabling, deleting) a watcher does nothing unless its already running */ 226/* stopping (disabling, deleting) a watcher does nothing unless its already running */
185#if EV_PROTOTYPES 227#if EV_PROTOTYPES
186void evio_start (struct ev_io *w); 228void ev_io_start (struct ev_io *w);
187void evio_stop (struct ev_io *w); 229void ev_io_stop (struct ev_io *w);
188 230
189void evtimer_start (struct ev_timer *w); 231void ev_timer_start (struct ev_timer *w);
190void evtimer_stop (struct ev_timer *w); 232void ev_timer_stop (struct ev_timer *w);
191void evtimer_again (struct ev_timer *w); /* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */ 233void ev_timer_again (struct ev_timer *w); /* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
192 234
193void evperiodic_start (struct ev_periodic *w); 235void ev_periodic_start (struct ev_periodic *w);
194void evperiodic_stop (struct ev_periodic *w); 236void ev_periodic_stop (struct ev_periodic *w);
195 237
196void evsignal_start (struct ev_signal *w); 238void ev_signal_start (struct ev_signal *w);
197void evsignal_stop (struct ev_signal *w); 239void ev_signal_stop (struct ev_signal *w);
198 240
199void evidle_start (struct ev_idle *w); 241void ev_idle_start (struct ev_idle *w);
200void evidle_stop (struct ev_idle *w); 242void ev_idle_stop (struct ev_idle *w);
201 243
244void ev_prepare_start (struct ev_prepare *w);
245void ev_prepare_stop (struct ev_prepare *w);
246
202void evcheck_start (struct ev_check *w); 247void ev_check_start (struct ev_check *w);
203void evcheck_stop (struct ev_check *w); 248void ev_check_stop (struct ev_check *w);
204#endif
205 249
250void ev_child_start (struct ev_child *w);
251void ev_child_stop (struct ev_child *w);
206#endif 252#endif
207 253
254#ifdef __cplusplus
255}
256#endif
257
258#endif
259

Diff Legend

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