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

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

Diff Legend

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