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.15 by root, Wed Oct 31 22:16:36 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 0x00 37#define EV_NONE 0x00
9#define EV_READ 0x01 38#define EV_READ 0x01
10#define EV_WRITE 0x02 39#define EV_WRITE 0x02
40#define EV_REIFY 0x04 /* private */
11#define EV_TIMEOUT 0x04 41#define EV_TIMEOUT 0x000100
12#define EV_SIGNAL 0x08 42#define EV_SIGNAL 0x000200
13#define EV_IDLE 0x10 43#define EV_IDLE 0x000400
14#define EV_CHECK 0x20 44#define EV_CHECK 0x000800
45#define EV_PREPARE 0x001000
46#define EV_CHILD 0x002000
47#define EV_ERROR 0x800000 /* sent when an error occurs */
15 48
16/* can be used to add custom fields to all watchers */ 49/* can be used to add custom fields to all watchers */
17#ifndef EV_COMMON 50#ifndef EV_COMMON
18# define EV_COMMON void *data 51# define EV_COMMON void *data
19#endif 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
20 59
21/* 60/*
22 * struct member types: 61 * struct member types:
23 * private: you can look at them, but not change them, and they might not mean anything to you. 62 * 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 63 * ro: can be read anytime, but only changed when the watcher isn't active
… …
92struct ev_idle 131struct ev_idle
93{ 132{
94 EV_WATCHER (ev_idle); 133 EV_WATCHER (ev_idle);
95}; 134};
96 135
97/* invoked for each run of the mainloop, just before the next blocking vall is initiated */ 136/* invoked for each run of the mainloop, just before the blocking call */
137/* you can still change events in any way you like */
138struct ev_prepare
139{
140 EV_WATCHER (ev_prepare);
141};
142
143/* invoked for each run of the mainloop, just after the blocking call */
98struct ev_check 144struct ev_check
99{ 145{
100 EV_WATCHER (ev_check); 146 EV_WATCHER (ev_check);
147};
148
149/* invoked when sigchld is received and waitpid indicates the givne pid */
150struct ev_child
151{
152 EV_WATCHER_LIST (ev_child);
153
154 int pid; /* ro */
155 int status; /* rw, holds the exit status, use the macros from sys/wait.h */
101}; 156};
102 157
103#define EVMETHOD_NONE 0 158#define EVMETHOD_NONE 0
104#define EVMETHOD_SELECT 1 159#define EVMETHOD_SELECT 1
105#define EVMETHOD_EPOLL 2 160#define EVMETHOD_EPOLL 2
161#if EV_PROTOTYPES
162extern int ev_method;
106int ev_init (int flags); /* returns ev_method */ 163int ev_init (int flags); /* returns ev_method */
107extern int ev_method; 164int ev_version_major (void);
165int ev_version_minor (void);
108 166
109/* these three calls are suitable for plugging into pthread_atfork */ 167/* these three calls are suitable for plugging into pthread_atfork */
110void ev_prefork (void); 168void ev_prefork (void);
111void ev_postfork_parent (void); 169void ev_postfork_parent (void);
112void ev_postfork_child (void); 170void ev_postfork_child (void);
113 171
114extern ev_tstamp ev_now; /* time w.r.t. timers and the eventloop, updated after each poll */ 172extern ev_tstamp ev_now; /* time w.r.t. timers and the eventloop, updated after each poll */
115ev_tstamp ev_time (void); 173ev_tstamp ev_time (void);
174#endif
116 175
117#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 176#define EVLOOP_NONBLOCK 1 /* do not block/wait */
118#define EVLOOP_ONESHOT 2 /* block *once* only */ 177#define EVLOOP_ONESHOT 2 /* block *once* only */
178#if EV_PROTOTYPES
119void ev_loop (int flags); 179void 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 */ 180extern int ev_loop_done; /* set to 1 to break out of event loop, set to 2 to break out of all event loops */
121 181
182/* convinience function, wait for a single event, without registering an event watcher */
183/* if timeout is < 0, do wait indefinitely */
184void ev_once (int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
185#endif
186
122/* these may evaluate ev multiple times, and the other arguments at most once */ 187/* 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 */ 188/* either use evw_init + evXXX_set, or the evXXX_init macro, below, to first initialise a watcher */
124#define evw_init(ev,cb_) do { (ev)->active = 0; (ev)->cb = (cb_); } while (0) 189#define evw_init(ev,cb_) do { (ev)->active = 0; (ev)->pending = 0; (ev)->cb = (cb_); } while (0)
125 190
126#define evio_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0) 191#define evio_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) 192#define evtimer_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) 193#define evperiodic_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) 194#define evsignal_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 */ 195#define evidle_set(ev) /* nop, yes, this is a serious in-joke */
196#define evprepare_set(ev) /* nop, yes, this is a serious in-joke */
197#define evcheck_set(ev) /* nop, yes, this is a serious in-joke */
198#define evchild_set(ev,pid_) do { (ev)->pid = (pid_); } while (0)
132 199
133#define evio_init(ev,cb,fd,events) do { evw_init ((ev), (cb)); evio_set ((ev),(fd),(events)); } while (0) 200#define evio_init(ev,cb,fd,events) do { evw_init ((ev), (cb)); evio_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) 201#define evtimer_init(ev,cb,after,repeat) do { evw_init ((ev), (cb)); evtimer_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) 202#define evperiodic_init(ev,cb,at,interval) do { evw_init ((ev), (cb)); evperiodic_set ((ev),(at),(interval)); } while (0)
136#define evsignal_init(ev,cb,signum) do { evw_init ((ev), (cb)); evsignal_set ((ev), (signum)); } while (0) 203#define evsignal_init(ev,cb,signum) do { evw_init ((ev), (cb)); evsignal_set ((ev), (signum)); } while (0)
204#define evidle_init(ev,cb) do { evw_init ((ev), (cb)); evidle_set ((ev)); } while (0)
205#define evprepare_init(ev,cb) do { evw_init ((ev), (cb)); evprepare_set ((ev)); } while (0)
137#define evcheck_init(ev,cb) do { evw_init ((ev), (cb)); evcheck_set ((ev)); } while (0) 206#define evcheck_init(ev,cb) do { evw_init ((ev), (cb)); evcheck_set ((ev)); } while (0)
138#define evidle_init(ev,cb) do { evw_init ((ev), (cb)); evidle_set ((ev)); } while (0) 207#define evchild_init(ev,cb,pid) do { evw_init ((ev), (cb)); evchild_set ((ev),(pid)); } while (0)
139 208
140#define ev_is_active(ev) (0 + (ev)->active) /* true when the watcher has been started */ 209#define ev_is_active(ev) (0 + (ev)->active) /* true when the watcher has been started */
141 210
142/* stopping (enabling, adding) a watcher does nothing if it is already running */ 211/* stopping (enabling, adding) a watcher does nothing if it is already running */
143/* stopping (disabling, deleting) a watcher does nothing unless its already running */ 212/* stopping (disabling, deleting) a watcher does nothing unless its already running */
213#if EV_PROTOTYPES
144void evio_start (struct ev_io *w); 214void evio_start (struct ev_io *w);
145void evio_stop (struct ev_io *w); 215void evio_stop (struct ev_io *w);
146 216
147void evtimer_start (struct ev_timer *w); 217void evtimer_start (struct ev_timer *w);
148void evtimer_stop (struct ev_timer *w); 218void evtimer_stop (struct ev_timer *w);
219void evtimer_again (struct ev_timer *w); /* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
149 220
150void evperiodic_start (struct ev_periodic *w); 221void evperiodic_start (struct ev_periodic *w);
151void evperiodic_stop (struct ev_periodic *w); 222void evperiodic_stop (struct ev_periodic *w);
152 223
153void evsignal_start (struct ev_signal *w); 224void evsignal_start (struct ev_signal *w);
154void evsignal_stop (struct ev_signal *w); 225void evsignal_stop (struct ev_signal *w);
155 226
156void evidle_start (struct ev_idle *w); 227void evidle_start (struct ev_idle *w);
157void evidle_stop (struct ev_idle *w); 228void evidle_stop (struct ev_idle *w);
158 229
230void evprepare_start (struct ev_prepare *w);
231void evprepare_stop (struct ev_prepare *w);
232
159void evcheck_start (struct ev_check *w); 233void evcheck_start (struct ev_check *w);
160void evcheck_stop (struct ev_check *w); 234void evcheck_stop (struct ev_check *w);
161 235
236void evchild_start (struct ev_child *w);
237void evchild_stop (struct ev_child *w);
162#endif 238#endif
163 239
240#endif
241

Diff Legend

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