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

Comparing libev/ev.h (file contents):
Revision 1.41 by root, Thu Nov 8 21:08:56 2007 UTC vs.
Revision 1.46 by root, Sat Nov 10 00:55:27 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 */
200/* the presence of this union forces similar struct layout */ 210/* the presence of this union forces similar struct layout */
201union ev_any_watcher 211union ev_any_watcher
202{ 212{
203 struct ev_watcher w; 213 struct ev_watcher w;
204 struct ev_watcher_list wl; 214 struct ev_watcher_list wl;
215
205 struct ev_io io; 216 struct ev_io io;
206 struct ev_timer timer; 217 struct ev_timer timer;
207 struct ev_periodic periodic; 218 struct ev_periodic periodic;
208 struct ev_signal signal;
209 struct ev_idle idle; 219 struct ev_idle idle;
210 struct ev_child child;
211 struct ev_prepare prepare; 220 struct ev_prepare prepare;
212 struct ev_check check; 221 struct ev_check check;
222 struct ev_signal signal;
223 struct ev_child child;
213}; 224};
214 225
215#define EVMETHOD_AUTO 0 /* consults environment */ 226#define EVMETHOD_AUTO 0 /* consults environment */
216#define EVMETHOD_SELECT 1 227#define EVMETHOD_SELECT 1
217#define EVMETHOD_POLL 2 228#define EVMETHOD_POLL 2
288/* if timeout is < 0, do wait indefinitely */ 299/* if timeout is < 0, do wait indefinitely */
289void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); 300void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
290#endif 301#endif
291 302
292/* these may evaluate ev multiple times, and the other arguments at most once */ 303/* these may evaluate ev multiple times, and the other arguments at most once */
293/* either use ev_watcher_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */ 304/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
294#define ev_watcher_init(ev,cb_) do { \ 305#define ev_init(ev,cb_) do { \
295 ((struct ev_watcher *)(void *)(ev))->active = \ 306 ((struct ev_watcher *)(void *)(ev))->active = \
296 ((struct ev_watcher *)(void *)(ev))->pending = \ 307 ((struct ev_watcher *)(void *)(ev))->pending = \
297 ((struct ev_watcher *)(void *)(ev))->priority = 0; \ 308 ((struct ev_watcher *)(void *)(ev))->priority = 0; \
298 (ev)->cb = (cb_); \ 309 ev_set_cb ((ev), cb_); \
299} while (0) 310} while (0)
300 311
301#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0) 312#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0)
302#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0) 313#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)
303#define ev_periodic_set(ev,at_,ival_,res_) do { (ev)->at = (at_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0) 314#define ev_periodic_set(ev,at_,ival_,res_) do { (ev)->at = (at_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0)
305#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */ 316#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
306#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */ 317#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
307#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */ 318#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
308#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0) 319#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0)
309 320
310#define ev_io_init(ev,cb,fd,events) do { ev_watcher_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) 321#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
311#define ev_timer_init(ev,cb,after,repeat) do { ev_watcher_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0) 322#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
312#define ev_periodic_init(ev,cb,at,ival,res) do { ev_watcher_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0) 323#define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0)
313#define ev_signal_init(ev,cb,signum) do { ev_watcher_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0) 324#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
314#define ev_idle_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_idle_set ((ev)); } while (0) 325#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
315#define ev_prepare_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0) 326#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
316#define ev_check_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_check_set ((ev)); } while (0) 327#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
317#define ev_child_init(ev,cb,pid) do { ev_watcher_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0) 328#define ev_child_init(ev,cb,pid) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)
318 329
319#define ev_is_pending(ev) (0 + ((struct ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ 330#define ev_is_pending(ev) (0 + ((struct ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
320#define ev_is_active(ev) (0 + ((struct ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */ 331#define ev_is_active(ev) (0 + ((struct ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
321 332
322#define ev_priority(ev) ((struct ev_watcher *)(void *)(ev))->priority /* rw */ 333#define ev_priority(ev) ((struct ev_watcher *)(void *)(ev))->priority /* rw */
323#define ev_cb(ev) (ev)->cb /* rw */ 334#define ev_cb(ev) (ev)->cb /* rw */
324#define ev_set_priority(ev,pri) ev_priority (ev) = (pri) 335#define ev_set_priority(ev,pri) ev_priority (ev) = (pri)
336
337#ifndef ev_set_cb
325#define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) 338# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
339#endif
326 340
327/* stopping (enabling, adding) a watcher does nothing if it is already running */ 341/* stopping (enabling, adding) a watcher does nothing if it is already running */
328/* stopping (disabling, deleting) a watcher does nothing unless its already running */ 342/* stopping (disabling, deleting) a watcher does nothing unless its already running */
329#if EV_PROTOTYPES 343#if EV_PROTOTYPES
330 344
331/* feeds an event into a watcher as if the event actually occured */ 345/* feeds an event into a watcher as if the event actually occured */
332/* accepts any ev_watcher type */ 346/* accepts any ev_watcher type */
333void ev_feed_event (EV_P_ void *w, int revents); 347void ev_feed_event (EV_P_ void *w, int revents);
348void ev_feed_fd_event (EV_P_ int fd, int revents);
349void ev_feed_signal_event (EV_P_ int signum);
334 350
335void ev_io_start (EV_P_ struct ev_io *w); 351void ev_io_start (EV_P_ struct ev_io *w);
336void ev_io_stop (EV_P_ struct ev_io *w); 352void ev_io_stop (EV_P_ struct ev_io *w);
337 353
338void ev_timer_start (EV_P_ struct ev_timer *w); 354void ev_timer_start (EV_P_ struct ev_timer *w);

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines