ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libev/ev.h
Revision: 1.11
Committed: Wed Oct 31 18:28:00 2007 UTC (16 years, 6 months ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.10: +17 -4 lines
Log Message:
add prepare watcher

File Contents

# Content
1 /*
2 * Copyright (c) 2007 Marc Alexander Lehmann <libev@schmorp.de>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met:
8 *
9 * * Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 *
12 * * Redistributions in binary form must reproduce the above
13 * copyright notice, this list of conditions and the following
14 * disclaimer in the documentation and/or other materials provided
15 * with the distribution.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
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.
28 */
29
30 #ifndef EV_H
31 #define EV_H
32
33 typedef double ev_tstamp;
34
35 /* eventmask, revents, events... */
36 #define EV_UNDEF -1 /* guaranteed to be invalid */
37 #define EV_NONE 0x00
38 #define EV_READ 0x01
39 #define EV_WRITE 0x02
40 #define EV_TIMEOUT 0x04
41 #define EV_SIGNAL 0x08
42 #define EV_IDLE 0x10
43 #define EV_CHECK 0x20
44 #define EV_PREPARE 0x40
45 #define EV_ERROR (0x7f|0x80)
46
47 /* can be used to add custom fields to all watchers */
48 #ifndef EV_COMMON
49 # define EV_COMMON void *data
50 #endif
51 #ifndef EV_PROTOTYPES
52 # define EV_PROTOTYPES 1
53 #endif
54
55 /*
56 * struct member types:
57 * 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
59 * rw: can be read and modified anytime, even when the watcher is active
60 */
61
62 /* shared by all watchers */
63 #define EV_WATCHER(type) \
64 int active; /* private */ \
65 int pending; /* private */ \
66 EV_COMMON; /* rw */ \
67 void (*cb)(struct type *, int revents); /* rw */ /* gets invoked with an eventmask */
68
69 #define EV_WATCHER_LIST(type) \
70 EV_WATCHER (type); \
71 struct type *next /* private */
72
73 #define EV_WATCHER_TIME(type) \
74 EV_WATCHER (type); \
75 ev_tstamp at /* private */
76
77 /* base class, nothing to see here unless you subclass */
78 struct ev_watcher {
79 EV_WATCHER (ev_watcher);
80 };
81
82 /* base class, nothing to see here unless you subclass */
83 struct ev_watcher_list {
84 EV_WATCHER_LIST (ev_watcher_list);
85 };
86
87 /* base class, nothing to see here unless you subclass */
88 struct ev_watcher_time {
89 EV_WATCHER_TIME (ev_watcher_time);
90 };
91
92 /* invoked after a specific time, repeatable (based on monotonic clock) */
93 struct ev_timer
94 {
95 EV_WATCHER_TIME (ev_timer);
96
97 ev_tstamp repeat; /* rw */
98 };
99
100 /* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
101 struct ev_periodic
102 {
103 EV_WATCHER_TIME (ev_periodic);
104
105 ev_tstamp interval; /* rw */
106 };
107
108 /* invoked when fd is either EV_READable or EV_WRITEable */
109 struct ev_io
110 {
111 EV_WATCHER_LIST (ev_io);
112
113 int fd; /* ro */
114 int events; /* ro */
115 };
116
117 /* invoked when the given signal has been received */
118 struct ev_signal
119 {
120 EV_WATCHER_LIST (ev_signal);
121
122 int signum; /* ro */
123 };
124
125 /* invoked when the nothing else needs to be done, keeps the process from blocking */
126 struct ev_idle
127 {
128 EV_WATCHER (ev_idle);
129 };
130
131 /* invoked for each run of the mainloop, just before the blocking call */
132 /* you can still change events in any way you like */
133 struct ev_prepare
134 {
135 EV_WATCHER (ev_prepare);
136 };
137
138 /* invoked for each run of the mainloop, just after the blocking call */
139 struct ev_check
140 {
141 EV_WATCHER (ev_check);
142 };
143
144 #define EVMETHOD_NONE 0
145 #define EVMETHOD_SELECT 1
146 #define EVMETHOD_EPOLL 2
147 #if EV_PROTOTYPES
148 extern int ev_method;
149 int ev_init (int flags); /* returns ev_method */
150
151 /* these three calls are suitable for plugging into pthread_atfork */
152 void ev_prefork (void);
153 void ev_postfork_parent (void);
154 void ev_postfork_child (void);
155
156 extern ev_tstamp ev_now; /* time w.r.t. timers and the eventloop, updated after each poll */
157 ev_tstamp ev_time (void);
158 #endif
159
160 #define EVLOOP_NONBLOCK 1 /* do not block/wait */
161 #define EVLOOP_ONESHOT 2 /* block *once* only */
162 #if EV_PROTOTYPES
163 void ev_loop (int flags);
164 extern int ev_loop_done; /* set to 1 to break out of event loop, set to 2 to break out of all event loops */
165
166 /* convinience function, wait for a single event, without registering an event watcher */
167 /* if timeout is < 0, do wait indefinitely */
168 void ev_once (int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
169 #endif
170
171 /* 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 */
173 #define evw_init(ev,cb_) do { (ev)->active = 0; (ev)->pending = 0; (ev)->cb = (cb_); } while (0)
174
175 #define evio_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)
177 #define evperiodic_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)
179 #define evidle_set(ev) /* nop, yes, this is a serious in-joke */
180 #define evprepare_set(ev) /* nop, yes, this is a serious in-joke */
181 #define evcheck_set(ev) /* nop, yes, this is a serious in-joke */
182
183 #define evio_init(ev,cb,fd,events) do { evw_init ((ev), (cb)); evio_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)
185 #define evperiodic_init(ev,cb,at,interval) do { evw_init ((ev), (cb)); evperiodic_set ((ev),(at),(interval)); } while (0)
186 #define evsignal_init(ev,cb,signum) do { evw_init ((ev), (cb)); evsignal_set ((ev), (signum)); } while (0)
187 #define evidle_init(ev,cb) do { evw_init ((ev), (cb)); evidle_set ((ev)); } while (0)
188 #define evprepare_init(ev,cb) do { evw_init ((ev), (cb)); evprepare_set ((ev)); } while (0)
189 #define evcheck_init(ev,cb) do { evw_init ((ev), (cb)); evcheck_set ((ev)); } while (0)
190
191 #define ev_is_active(ev) (0 + (ev)->active) /* true when the watcher has been started */
192
193 /* stopping (enabling, adding) a watcher does nothing if it is already running */
194 /* stopping (disabling, deleting) a watcher does nothing unless its already running */
195 #if EV_PROTOTYPES
196 void evio_start (struct ev_io *w);
197 void evio_stop (struct ev_io *w);
198
199 void evtimer_start (struct ev_timer *w);
200 void evtimer_stop (struct ev_timer *w);
201 void evtimer_again (struct ev_timer *w); /* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
202
203 void evperiodic_start (struct ev_periodic *w);
204 void evperiodic_stop (struct ev_periodic *w);
205
206 void evsignal_start (struct ev_signal *w);
207 void evsignal_stop (struct ev_signal *w);
208
209 void evidle_start (struct ev_idle *w);
210 void evidle_stop (struct ev_idle *w);
211
212 void evprepare_start (struct ev_prepare *w);
213 void evprepare_stop (struct ev_prepare *w);
214
215 void evcheck_start (struct ev_check *w);
216 void evcheck_stop (struct ev_check *w);
217 #endif
218
219 #endif
220