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

Comparing libev/ev.h (file contents):
Revision 1.34 by root, Sun Nov 4 23:29:48 2007 UTC vs.
Revision 1.48 by root, Sat Nov 10 03:19:21 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 32
33#ifdef __cplusplus 33#ifdef __cplusplus
34extern "C" { 34extern "C" {
35#endif 35#endif
36 36
… …
85#endif 85#endif
86 86
87#define EV_VERSION_MAJOR 1 87#define EV_VERSION_MAJOR 1
88#define EV_VERSION_MINOR 1 88#define EV_VERSION_MINOR 1
89 89
90#ifndef EV_CB_DECLARE
91# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents);
92#endif
93#ifndef EV_CB_INVOKE
94# define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents))
95#endif
96
90/* 97/*
91 * struct member types: 98 * struct member types:
92 * private: you can look at them, but not change them, and they might not mean anything to you. 99 * private: you can look at them, but not change them, and they might not mean anything to you.
93 * ro: can be read anytime, but only changed when the watcher isn't active 100 * ro: can be read anytime, but only changed when the watcher isn't active
94 * rw: can be read and modified anytime, even when the watcher is active 101 * rw: can be read and modified anytime, even when the watcher is active
… …
98#define EV_WATCHER(type) \ 105#define EV_WATCHER(type) \
99 int active; /* private */ \ 106 int active; /* private */ \
100 int pending; /* private */ \ 107 int pending; /* private */ \
101 int priority; /* private */ \ 108 int priority; /* private */ \
102 EV_COMMON; /* rw */ \ 109 EV_COMMON; /* rw */ \
103 void (*cb)(EV_P_ struct type *, int revents); /* private */ /* gets invoked with an eventmask */ 110 EV_CB_DECLARE (type) /* private */
104 111
105#define EV_WATCHER_LIST(type) \ 112#define EV_WATCHER_LIST(type) \
106 EV_WATCHER (type); \ 113 EV_WATCHER (type); \
107 struct ev_watcher_list *next /* private */ 114 struct ev_watcher_list *next /* private */
108 115
109#define EV_WATCHER_TIME(type) \ 116#define EV_WATCHER_TIME(type) \
110 EV_WATCHER (type); \ 117 EV_WATCHER (type); \
111 ev_tstamp at /* private */ 118 ev_tstamp at /* private */
112 119
113/* base class, nothing to see here unless you subclass */ 120/* base class, nothing to see here unless you subclass */
114struct ev_watcher { 121struct ev_watcher
122{
115 EV_WATCHER (ev_watcher); 123 EV_WATCHER (ev_watcher);
116}; 124};
117 125
118/* base class, nothing to see here unless you subclass */ 126/* base class, nothing to see here unless you subclass */
119struct ev_watcher_list { 127struct ev_watcher_list
128{
120 EV_WATCHER_LIST (ev_watcher_list); 129 EV_WATCHER_LIST (ev_watcher_list);
121}; 130};
122 131
123/* base class, nothing to see here unless you subclass */ 132/* base class, nothing to see here unless you subclass */
124struct ev_watcher_time { 133struct ev_watcher_time
134{
125 EV_WATCHER_TIME (ev_watcher_time); 135 EV_WATCHER_TIME (ev_watcher_time);
126}; 136};
127 137
128/* invoked after a specific time, repeatable (based on monotonic clock) */ 138/* invoked after a specific time, repeatable (based on monotonic clock) */
129/* revent EV_TIMEOUT */ 139/* revent EV_TIMEOUT */
… …
139struct ev_periodic 149struct ev_periodic
140{ 150{
141 EV_WATCHER_TIME (ev_periodic); 151 EV_WATCHER_TIME (ev_periodic);
142 152
143 ev_tstamp interval; /* rw */ 153 ev_tstamp interval; /* rw */
154 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */
144}; 155};
145 156
146/* invoked when fd is either EV_READable or EV_WRITEable */ 157/* invoked when fd is either EV_READable or EV_WRITEable */
147/* revent EV_READ, EV_WRITE */ 158/* revent EV_READ, EV_WRITE */
148struct ev_io 159struct ev_io
… …
156/* invoked when the given signal has been received */ 167/* invoked when the given signal has been received */
157/* revent EV_SIGNAL */ 168/* revent EV_SIGNAL */
158struct ev_signal 169struct ev_signal
159{ 170{
160 EV_WATCHER_LIST (ev_signal); 171 EV_WATCHER_LIST (ev_signal);
161#if EV_MULTIPLICITY
162 struct ev_loop *loop;
163#endif
164 172
165 int signum; /* ro */ 173 int signum; /* ro */
166}; 174};
167 175
168/* invoked when the nothing else needs to be done, keeps the process from blocking */ 176/* invoked when the nothing else needs to be done, keeps the process from blocking */
… …
195 EV_WATCHER_LIST (ev_child); 203 EV_WATCHER_LIST (ev_child);
196 204
197 int pid; /* ro */ 205 int pid; /* ro */
198 int rpid; /* rw, holds the received pid */ 206 int rpid; /* rw, holds the received pid */
199 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */ 207 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
208};
209
210/* the presence of this union forces similar struct layout */
211union ev_any_watcher
212{
213 struct ev_watcher w;
214 struct ev_watcher_list wl;
215
216 struct ev_io io;
217 struct ev_timer timer;
218 struct ev_periodic periodic;
219 struct ev_idle idle;
220 struct ev_prepare prepare;
221 struct ev_check check;
222 struct ev_signal signal;
223 struct ev_child child;
200}; 224};
201 225
202#define EVMETHOD_AUTO 0 /* consults environment */ 226#define EVMETHOD_AUTO 0 /* consults environment */
203#define EVMETHOD_SELECT 1 227#define EVMETHOD_SELECT 1
204#define EVMETHOD_POLL 2 228#define EVMETHOD_POLL 2
… …
213int ev_version_major (void); 237int ev_version_major (void);
214int ev_version_minor (void); 238int ev_version_minor (void);
215 239
216ev_tstamp ev_time (void); 240ev_tstamp ev_time (void);
217 241
242/* Sets the allocation function to use, works like realloc.
243 * It is used to allocate and free memory.
244 * If it returns zero when memory needs to be allocated, the library might abort
245 * or take some potentially destructive action.
246 * The default is your system realloc function.
247 */
248void ev_set_allocator (void *(*cb)(void *ptr, long size));
249
250/* set the callback function to call on a
251 * retryable syscall error
252 * (such as failed select, poll, epoll_wait)
253 */
254void ev_set_syserr_cb (void (*cb)(const char *msg));
255
218# if EV_MULTIPLICITY 256# if EV_MULTIPLICITY
219/* the default loop is the only one that handles signals and child watchers */ 257/* the default loop is the only one that handles signals and child watchers */
220/* you can call this as often as you like */ 258/* you can call this as often as you like */
221struct ev_loop *ev_default_loop (int methods); /* returns default loop */ 259struct ev_loop *ev_default_loop (int methods); /* returns default loop */
222 260
223/* create and destroy alternative loops that don't handle signals */ 261/* create and destroy alternative loops that don't handle signals */
224struct ev_loop *ev_loop_new (int methods); 262struct ev_loop *ev_loop_new (int methods);
225void ev_loop_destroy (EV_P); 263void ev_loop_destroy (EV_P);
226void ev_loop_fork (EV_P); 264void ev_loop_fork (EV_P);
265
266ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
267
227# else 268# else
269
228int ev_default_loop (int methods); /* returns true when successful */ 270int ev_default_loop (int methods); /* returns true when successful */
271
272static ev_tstamp
273ev_now ()
274{
275 extern ev_tstamp ev_rt_now;
276
277 return ev_rt_now;
278}
229# endif 279# endif
230 280
231void ev_default_destroy (void); /* destroy the default loop */ 281void ev_default_destroy (void); /* destroy the default loop */
232/* this needs to be called after fork, to duplicate the default loop */ 282/* this needs to be called after fork, to duplicate the default loop */
233/* if you create alternative loops you have to call ev_loop_fork on them */ 283/* if you create alternative loops you have to call ev_loop_fork on them */
… …
245 295
246#if EV_PROTOTYPES 296#if EV_PROTOTYPES
247void ev_loop (EV_P_ int flags); 297void ev_loop (EV_P_ int flags);
248void 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 */ 298void 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 */
249 299
250ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
251
252/* 300/*
253 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher 301 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
254 * keeps one reference. if you have a long-runing watcher you never unregister that 302 * keeps one reference. if you have a long-runing watcher you never unregister that
255 * should not keep ev_loop from running, unref() after starting, and ref() before stopping. 303 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
256 */ 304 */
… …
261/* if timeout is < 0, do wait indefinitely */ 309/* if timeout is < 0, do wait indefinitely */
262void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); 310void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
263#endif 311#endif
264 312
265/* these may evaluate ev multiple times, and the other arguments at most once */ 313/* these may evaluate ev multiple times, and the other arguments at most once */
266/* either use ev_watcher_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */ 314/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
267#define ev_watcher_init(ev,cb_) do { \ 315#define ev_init(ev,cb_) do { \
268 ((struct ev_watcher *)(void *)(ev))->active = \ 316 ((struct ev_watcher *)(void *)(ev))->active = \
269 ((struct ev_watcher *)(void *)(ev))->pending = \ 317 ((struct ev_watcher *)(void *)(ev))->pending = \
270 ((struct ev_watcher *)(void *)(ev))->priority = 0; \ 318 ((struct ev_watcher *)(void *)(ev))->priority = 0; \
271 (ev)->cb = (cb_); \ 319 ev_set_cb ((ev), cb_); \
272} while (0) 320} while (0)
273 321
274#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0) 322#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0)
275#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0) 323#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)
276#define ev_periodic_set(ev,at_,interval_) do { (ev)->at = (at_); (ev)->interval = (interval_); } while (0) 324#define ev_periodic_set(ev,at_,ival_,res_) do { (ev)->at = (at_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0)
277#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) 325#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
278#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */ 326#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
279#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */ 327#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
280#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */ 328#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
281#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0) 329#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0)
282 330
283#define ev_io_init(ev,cb,fd,events) do { ev_watcher_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) 331#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
284#define ev_timer_init(ev,cb,after,repeat) do { ev_watcher_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0) 332#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
285#define ev_periodic_init(ev,cb,at,interval) do { ev_watcher_init ((ev), (cb)); ev_periodic_set ((ev),(at),(interval)); } while (0) 333#define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0)
286#define ev_signal_init(ev,cb,signum) do { ev_watcher_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0) 334#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
287#define ev_idle_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_idle_set ((ev)); } while (0) 335#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
288#define ev_prepare_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0) 336#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
289#define ev_check_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_check_set ((ev)); } while (0) 337#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
290#define ev_child_init(ev,cb,pid) do { ev_watcher_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0) 338#define ev_child_init(ev,cb,pid) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)
291 339
292#define ev_is_pending(ev) (0 + ((struct ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ 340#define ev_is_pending(ev) (0 + ((struct ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
293#define ev_is_active(ev) (0 + ((struct ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */ 341#define ev_is_active(ev) (0 + ((struct ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
294 342
295#define ev_priority(ev) ((struct ev_watcher *)(void *)(ev))->priority /* rw */ 343#define ev_priority(ev) ((struct ev_watcher *)(void *)(ev))->priority /* rw */
296#define ev_cb(ev) (ev)->cb /* rw */ 344#define ev_cb(ev) (ev)->cb /* rw */
297#define ev_set_priority(ev,pri) ev_priority (ev) = (pri) 345#define ev_set_priority(ev,pri) ev_priority (ev) = (pri)
346
347#ifndef ev_set_cb
298#define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) 348# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
349#endif
299 350
300/* stopping (enabling, adding) a watcher does nothing if it is already running */ 351/* stopping (enabling, adding) a watcher does nothing if it is already running */
301/* stopping (disabling, deleting) a watcher does nothing unless its already running */ 352/* stopping (disabling, deleting) a watcher does nothing unless its already running */
302#if EV_PROTOTYPES 353#if EV_PROTOTYPES
354
355/* feeds an event into a watcher as if the event actually occured */
356/* accepts any ev_watcher type */
357void ev_feed_event (EV_P_ void *w, int revents);
358void ev_feed_fd_event (EV_P_ int fd, int revents);
359void ev_feed_signal_event (EV_P_ int signum);
360
303void ev_io_start (EV_P_ struct ev_io *w); 361void ev_io_start (EV_P_ struct ev_io *w);
304void ev_io_stop (EV_P_ struct ev_io *w); 362void ev_io_stop (EV_P_ struct ev_io *w);
305 363
306void ev_timer_start (EV_P_ struct ev_timer *w); 364void ev_timer_start (EV_P_ struct ev_timer *w);
307void ev_timer_stop (EV_P_ struct ev_timer *w); 365void ev_timer_stop (EV_P_ struct ev_timer *w);
308/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */ 366/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
309void ev_timer_again (EV_P_ struct ev_timer *w); 367void ev_timer_again (EV_P_ struct ev_timer *w);
310 368
311void ev_periodic_start (EV_P_ struct ev_periodic *w); 369void ev_periodic_start (EV_P_ struct ev_periodic *w);
312void ev_periodic_stop (EV_P_ struct ev_periodic *w); 370void ev_periodic_stop (EV_P_ struct ev_periodic *w);
371void ev_periodic_again (EV_P_ struct ev_periodic *w);
313 372
314void ev_idle_start (EV_P_ struct ev_idle *w); 373void ev_idle_start (EV_P_ struct ev_idle *w);
315void ev_idle_stop (EV_P_ struct ev_idle *w); 374void ev_idle_stop (EV_P_ struct ev_idle *w);
316 375
317void ev_prepare_start (EV_P_ struct ev_prepare *w); 376void ev_prepare_start (EV_P_ struct ev_prepare *w);

Diff Legend

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