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

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

Diff Legend

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