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

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

Diff Legend

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