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

Comparing libev/ev.h (file contents):
Revision 1.7 by root, Wed Oct 31 10:50:05 2007 UTC vs.
Revision 1.23 by root, Fri Nov 2 22:03:00 2007 UTC

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
1#ifndef EV_H 30#ifndef EV_H
2#define EV_H 31#define EV_H
3 32
33#ifdef __cplusplus
34extern "C" {
35#endif
36
4typedef double ev_tstamp; 37typedef double ev_tstamp;
5 38
39/* these priorities are inclusive, higher priorities will be called earlier */
40#ifndef EV_MINPRI
41# define EV_MINPRI -2
42#endif
43#ifndef EV_MAXPRI
44# define EV_MAXPRI +2
45#endif
46
6/* eventmask, revents, events... */ 47/* eventmask, revents, events... */
7#define EV_UNDEF -1 /* guaranteed to be invalid */ 48#define EV_UNDEF -1 /* guaranteed to be invalid */
8#define EV_NONE 0x00 49#define EV_NONE 0x00
9#define EV_READ 0x01 50#define EV_READ 0x01
10#define EV_WRITE 0x02 51#define EV_WRITE 0x02
11#define EV_TIMEOUT 0x04 52#define EV_TIMEOUT 0x000100
53#define EV_PERIODIC 0x000200
12#define EV_SIGNAL 0x08 54#define EV_SIGNAL 0x000400
13#define EV_IDLE 0x10 55#define EV_IDLE 0x000800
14#define EV_CHECK 0x20 56#define EV_CHECK 0x001000
57#define EV_PREPARE 0x002000
58#define EV_CHILD 0x004000
59#define EV_ERROR 0x800000 /* sent when an error occurs */
15 60
16/* can be used to add custom fields to all watchers */ 61/* can be used to add custom fields to all watchers */
17#ifndef EV_COMMON 62#ifndef EV_COMMON
18# define EV_COMMON void *data 63# define EV_COMMON void *data
19#endif 64#endif
65#ifndef EV_PROTOTYPES
66# define EV_PROTOTYPES 1
67#endif
68
69#define EV_VERSION_MAJOR 1
70#define EV_VERSION_MINOR 1
20 71
21/* 72/*
22 * struct member types: 73 * struct member types:
23 * private: you can look at them, but not change them, and they might not mean anything to you. 74 * 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 75 * ro: can be read anytime, but only changed when the watcher isn't active
… …
27 78
28/* shared by all watchers */ 79/* shared by all watchers */
29#define EV_WATCHER(type) \ 80#define EV_WATCHER(type) \
30 int active; /* private */ \ 81 int active; /* private */ \
31 int pending; /* private */ \ 82 int pending; /* private */ \
83 int priority; /* ro */ \
32 EV_COMMON; /* rw */ \ 84 EV_COMMON; /* rw */ \
33 void (*cb)(struct type *, int revents); /* rw */ /* gets invoked with an eventmask */ 85 void (*cb)(struct type *, int revents); /* rw */ /* gets invoked with an eventmask */
34 86
35#define EV_WATCHER_LIST(type) \ 87#define EV_WATCHER_LIST(type) \
36 EV_WATCHER (type); \ 88 EV_WATCHER (type); \
… …
54struct ev_watcher_time { 106struct ev_watcher_time {
55 EV_WATCHER_TIME (ev_watcher_time); 107 EV_WATCHER_TIME (ev_watcher_time);
56}; 108};
57 109
58/* invoked after a specific time, repeatable (based on monotonic clock) */ 110/* invoked after a specific time, repeatable (based on monotonic clock) */
111/* revent EV_TIMEOUT */
59struct ev_timer 112struct ev_timer
60{ 113{
61 EV_WATCHER_TIME (ev_timer); 114 EV_WATCHER_TIME (ev_timer);
62 115
63 ev_tstamp repeat; /* rw */ 116 ev_tstamp repeat; /* rw */
64}; 117};
65 118
66/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */ 119/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
120/* revent EV_PERIODIC */
67struct ev_periodic 121struct ev_periodic
68{ 122{
69 EV_WATCHER_TIME (ev_periodic); 123 EV_WATCHER_TIME (ev_periodic);
70 124
71 ev_tstamp interval; /* rw */ 125 ev_tstamp interval; /* rw */
72}; 126};
73 127
74/* invoked when fd is either EV_READable or EV_WRITEable */ 128/* invoked when fd is either EV_READable or EV_WRITEable */
129/* revent EV_READ, EV_WRITE */
75struct ev_io 130struct ev_io
76{ 131{
77 EV_WATCHER_LIST (ev_io); 132 EV_WATCHER_LIST (ev_io);
78 133
79 int fd; /* ro */ 134 int fd; /* ro */
80 int events; /* ro */ 135 int events; /* ro */
81}; 136};
82 137
83/* invoked when the given signal has been received */ 138/* invoked when the given signal has been received */
139/* revent EV_SIGNAL */
84struct ev_signal 140struct ev_signal
85{ 141{
86 EV_WATCHER_LIST (ev_signal); 142 EV_WATCHER_LIST (ev_signal);
87 143
88 int signum; /* ro */ 144 int signum; /* ro */
89}; 145};
90 146
91/* invoked when the nothing else needs to be done, keeps the process from blocking */ 147/* invoked when the nothing else needs to be done, keeps the process from blocking */
148/* revent EV_IDLE */
92struct ev_idle 149struct ev_idle
93{ 150{
94 EV_WATCHER (ev_idle); 151 EV_WATCHER (ev_idle);
95}; 152};
96 153
97/* invoked for each run of the mainloop, just before the next blocking vall is initiated */ 154/* invoked for each run of the mainloop, just before the blocking call */
155/* you can still change events in any way you like */
156/* revent EV_PREPARE */
157struct ev_prepare
158{
159 EV_WATCHER (ev_prepare);
160};
161
162/* invoked for each run of the mainloop, just after the blocking call */
163/* revent EV_CHECK */
98struct ev_check 164struct ev_check
99{ 165{
100 EV_WATCHER (ev_check); 166 EV_WATCHER (ev_check);
101}; 167};
102 168
103#define EVMETHOD_NONE 0 169/* invoked when sigchld is received and waitpid indicates the givne pid */
170/* revent EV_CHILD */
171struct ev_child
172{
173 EV_WATCHER_LIST (ev_child);
174
175 int pid; /* ro */
176 int status; /* rw, holds the exit status, use the macros from sys/wait.h */
177};
178
179#define EVMETHOD_AUTO 0 /* consults environment */
104#define EVMETHOD_SELECT 1 180#define EVMETHOD_SELECT 1
105#define EVMETHOD_EPOLL 2 181#define EVMETHOD_POLL 2
106int ev_init (int flags); /* returns ev_method */ 182#define EVMETHOD_EPOLL 4
183#define EVMETHOD_KQUEUE 8
184#define EVMETHOD_DEVPOLL 16 /* NYI */
185#define EVMETHOD_PORT 32 /* NYI */
186#define EVMETHOD_ANY ~0 /* any method, do not consult env */
187#if EV_PROTOTYPES
107extern int ev_method; 188extern int ev_method;
189int ev_init (int methods); /* returns ev_method */
190int ev_version_major (void);
191int ev_version_minor (void);
108 192
109/* these three calls are suitable for plugging into pthread_atfork */ 193/* these three calls are suitable for plugging into pthread_atfork */
110void ev_prefork (void); 194void ev_fork_prepare (void);
111void ev_postfork_parent (void); 195void ev_fork_parent (void);
112void ev_postfork_child (void); 196void ev_fork_child (void);
113 197
114extern ev_tstamp ev_now; /* time w.r.t. timers and the eventloop, updated after each poll */ 198extern ev_tstamp ev_now; /* time w.r.t. timers and the eventloop, updated after each poll */
115ev_tstamp ev_time (void); 199ev_tstamp ev_time (void);
200#endif
116 201
117#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 202#define EVLOOP_NONBLOCK 1 /* do not block/wait */
118#define EVLOOP_ONESHOT 2 /* block *once* only */ 203#define EVLOOP_ONESHOT 2 /* block *once* only */
204#if EV_PROTOTYPES
119void ev_loop (int flags); 205void ev_loop (int flags);
120extern int ev_loop_done; /* set to 1 to break out of event loop, set to 2 to break out of all event loops */ 206extern int ev_loop_done; /* set to 1 to break out of event loop, set to 2 to break out of all event loops */
121 207
208/* convinience function, wait for a single event, without registering an event watcher */
209/* if timeout is < 0, do wait indefinitely */
210void ev_once (int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
211#endif
212
122/* these may evaluate ev multiple times, and the other arguments at most once */ 213/* these may evaluate ev multiple times, and the other arguments at most once */
123/* either use evw_init + evXXX_set, or the evXXX_init macro, below, to first initialise a watcher */ 214/* either use ev_watcher_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
124#define evw_init(ev,cb_) do { (ev)->active = 0; (ev)->cb = (cb_); } while (0) 215#define ev_watcher_init(ev,cb_) do { (ev)->active = (ev)->pending = (ev)->priority = 0; (ev)->cb = (cb_); } while (0)
125 216
126#define evio_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0) 217#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0)
127#define evtimer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0) 218#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)
128#define evperiodic_set(ev,at_,interval_) do { (ev)->at = (at_); (ev)->interval = (interval_); } while (0) 219#define ev_periodic_set(ev,at_,interval_) do { (ev)->at = (at_); (ev)->interval = (interval_); } while (0)
129#define evsignal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) 220#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
130#define evcheck_set(ev) /* nop, yes this is a serious in-joke */
131#define evidle_set(ev) /* nop, yes this is a serious in-joke */ 221#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
222#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
223#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
224#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0)
132 225
133#define evio_init(ev,cb,fd,events) do { evw_init ((ev), (cb)); evio_set ((ev),(fd),(events)); } while (0) 226#define ev_io_init(ev,cb,fd,events) do { ev_watcher_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
134#define evtimer_init(ev,cb,after,repeat) do { evw_init ((ev), (cb)); evtimer_set ((ev),(after),(repeat)); } while (0) 227#define ev_timer_init(ev,cb,after,repeat) do { ev_watcher_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
135#define evperiodic_init(ev,cb,at,interval) do { evw_init ((ev), (cb)); evperiodic_set ((ev),(at),(interval)); } while (0) 228#define ev_periodic_init(ev,cb,at,interval) do { ev_watcher_init ((ev), (cb)); ev_periodic_set ((ev),(at),(interval)); } while (0)
136#define evsignal_init(ev,cb,signum) do { evw_init ((ev), (cb)); evsignal_set ((ev), (signum)); } while (0) 229#define ev_signal_init(ev,cb,signum) do { ev_watcher_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
230#define ev_idle_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
231#define ev_prepare_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
137#define evcheck_init(ev,cb) do { evw_init ((ev), (cb)); evcheck_set ((ev)); } while (0) 232#define ev_check_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
138#define evidle_init(ev,cb) do { evw_init ((ev), (cb)); evidle_set ((ev)); } while (0) 233#define ev_child_init(ev,cb,pid) do { ev_watcher_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)
139 234
140#define ev_is_active(ev) (0 + (ev)->active) /* true when the watcher has been started */ 235#define ev_is_active(ev) (0 + (ev)->active) /* true when the watcher has been started */
236#define ev_set_priority(ev,pri) (ev)->priority = pri
141 237
142/* stopping (enabling, adding) a watcher does nothing if it is already running */ 238/* stopping (enabling, adding) a watcher does nothing if it is already running */
143/* stopping (disabling, deleting) a watcher does nothing unless its already running */ 239/* stopping (disabling, deleting) a watcher does nothing unless its already running */
240#if EV_PROTOTYPES
144void evio_start (struct ev_io *w); 241void ev_io_start (struct ev_io *w);
145void evio_stop (struct ev_io *w); 242void ev_io_stop (struct ev_io *w);
146 243
147void evtimer_start (struct ev_timer *w); 244void ev_timer_start (struct ev_timer *w);
148void evtimer_stop (struct ev_timer *w); 245void ev_timer_stop (struct ev_timer *w);
246void ev_timer_again (struct ev_timer *w); /* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
149 247
150void evperiodic_start (struct ev_periodic *w); 248void ev_periodic_start (struct ev_periodic *w);
151void evperiodic_stop (struct ev_periodic *w); 249void ev_periodic_stop (struct ev_periodic *w);
152 250
153void evsignal_start (struct ev_signal *w); 251void ev_signal_start (struct ev_signal *w);
154void evsignal_stop (struct ev_signal *w); 252void ev_signal_stop (struct ev_signal *w);
155 253
156void evidle_start (struct ev_idle *w); 254void ev_idle_start (struct ev_idle *w);
157void evidle_stop (struct ev_idle *w); 255void ev_idle_stop (struct ev_idle *w);
158 256
257void ev_prepare_start (struct ev_prepare *w);
258void ev_prepare_stop (struct ev_prepare *w);
259
159void evcheck_start (struct ev_check *w); 260void ev_check_start (struct ev_check *w);
160void evcheck_stop (struct ev_check *w); 261void ev_check_stop (struct ev_check *w);
161 262
263void ev_child_start (struct ev_child *w);
264void ev_child_stop (struct ev_child *w);
162#endif 265#endif
163 266
267#ifdef __cplusplus
268}
269#endif
270
271#endif
272

Diff Legend

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