ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libev/ev.h
Revision: 1.6
Committed: Wed Oct 31 09:23:18 2007 UTC (16 years, 6 months ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.5: +54 -19 lines
Log Message:
*** empty log message ***

File Contents

# Content
1 #ifndef EV_H
2 #define EV_H
3
4 typedef double ev_tstamp;
5
6 /* eventmask, revents, events... */
7 #define EV_UNDEF -1 /* guaranteed to be invalid */
8 #define EV_NONE 0x00
9 #define EV_READ 0x01
10 #define EV_WRITE 0x02
11 #define EV_TIMEOUT 0x04
12 #define EV_SIGNAL 0x08
13 #define EV_IDLE 0x10
14 #define EV_CHECK 0x20
15
16 /* can be used to add custom fields to all watchers */
17 #ifndef EV_COMMON
18 # define EV_COMMON void *data
19 #endif
20
21 /*
22 * struct member types:
23 * private: you can look at them, but not change them, and they might not mean anything to you.
24 * ro: can be read anytime, but only changed when the watcher isn't active
25 * rw: can be read and modified anytime, even when the watcher is active
26 */
27
28 /* shared by all watchers */
29 #define EV_WATCHER(type) \
30 int active; /* private */ \
31 int pending; /* private */ \
32 EV_COMMON; /* rw */ \
33 void (*cb)(struct type *, int revents); /* rw */ /* gets invoked with an eventmask */
34
35 #define EV_WATCHER_LIST(type) \
36 EV_WATCHER (type); \
37 struct type *next /* private */
38
39 #define EV_WATCHER_TIME(type) \
40 EV_WATCHER (type); \
41 ev_tstamp at /* private */
42
43 /* invoked after a specific time, repeatable (based on monotonic clock) */
44 struct ev_timer
45 {
46 EV_WATCHER_TIME (ev_timer);
47
48 ev_tstamp repeat; /* rw */
49 };
50
51 /* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
52 struct ev_periodic
53 {
54 EV_WATCHER_TIME (ev_periodic);
55
56 ev_tstamp interval; /* rw */
57 };
58
59 /* invoked when fd is either EV_READable or EV_WRITEable */
60 struct ev_io
61 {
62 EV_WATCHER_LIST (ev_io);
63
64 int fd; /* ro */
65 int events; /* ro */
66 };
67
68 /* invoked when the given signal has been received */
69 struct ev_signal
70 {
71 EV_WATCHER_LIST (ev_signal);
72
73 int signum; /* ro */
74 };
75
76 /* invoked when the nothing else needs to be done, keeps the process from blocking */
77 struct ev_idle
78 {
79 EV_WATCHER (ev_idle);
80 };
81
82 /* invoked for each run of the mainloop, just before the next blocking vall is initiated */
83 struct ev_check
84 {
85 EV_WATCHER (ev_check);
86 };
87
88 #define EVMETHOD_NONE 0
89 #define EVMETHOD_SELECT 1
90 #define EVMETHOD_EPOLL 2
91 int ev_init (int flags); /* returns ev_method */
92 extern int ev_method;
93
94 /* these three calls are suitable for plugging into pthread_atfork */
95 void ev_prefork (void);
96 void ev_postfork_parent (void);
97 void ev_postfork_child (void);
98
99 extern ev_tstamp ev_now; /* time w.r.t. timers and the eventloop, updated after each poll */
100 ev_tstamp ev_time (void);
101
102 #define EVLOOP_NONBLOCK 1 /* do not block/wait */
103 #define EVLOOP_ONESHOT 2 /* block *once* only */
104 void ev_loop (int flags);
105 extern int ev_loop_done; /* set to 1 to break out of event loop */
106
107 /* these may evaluate ev multiple times, and the other arguments at most once */
108 /* either use evw_init + evXXX_set, or the evXXX_init macro, below, to first initialise a watcher */
109 #define evw_init(ev,cb_) do { (ev)->active = 0; (ev)->cb = (cb_); } while (0)
110
111 #define evio_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0)
112 #define evtimer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)
113 #define evperiodic_set(ev,at_,interval_) do { (ev)->at = (at_); (ev)->interval = (interval_); } while (0)
114 #define evsignal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
115 #define evcheck_set(ev) /* nop, yes this is a serious in-joke */
116 #define evidle_set(ev) /* nop, yes this is a serious in-joke */
117
118 #define evio_init(ev,cb,fd,events) do { evw_init ((ev), (cb)); evio_set ((ev),(fd),(events)); } while (0)
119 #define evtimer_init(ev,cb,after,repeat) do { evw_init ((ev), (cb)); evtimer_set ((ev),(after),(repeat)); } while (0)
120 #define evperiodic_init(ev,cb,at,interval) do { evw_init ((ev), (cb)); evperiodic_set ((ev),(at),(interval)); } while (0)
121 #define evsignal_init(ev,cb,signum) do { evw_init ((ev), (cb)); evsignal_set ((ev), (signum)); } while (0)
122 #define evcheck_init(ev,cb) do { evw_init ((ev), (cb)); evcheck_set ((ev)); } while (0)
123 #define evidle_init(ev,cb) do { evw_init ((ev), (cb)); evidle_set ((ev)); } while (0)
124
125 #define ev_is_active(ev) (0 + (ev)->active) /* true when the watcher has been started */
126
127 /* stopping (enabling, adding) a watcher does nothing if it is already running */
128 /* stopping (disabling, deleting) a watcher does nothing unless its already running */
129 void evio_start (struct ev_io *w);
130 void evio_stop (struct ev_io *w);
131
132 void evtimer_start (struct ev_timer *w);
133 void evtimer_stop (struct ev_timer *w);
134
135 void evperiodic_start (struct ev_periodic *w);
136 void evperiodic_stop (struct ev_periodic *w);
137
138 void evsignal_start (struct ev_signal *w);
139 void evsignal_stop (struct ev_signal *w);
140
141 void evidle_start (struct ev_idle *w);
142 void evidle_stop (struct ev_idle *w);
143
144 void evcheck_start (struct ev_check *w);
145 void evcheck_stop (struct ev_check *w);
146
147 #endif
148