[ViewVC] Diff of: cvs/libev/ev.h

Comparing libev/ev.h (file contents):
Revision 1.29 by root, Sun Nov 4 00:24:17 2007 UTC vs.
Revision 1.142 by root, Thu Oct 21 14:50:58 2010 UTC

1	/*	1	/*
		2	* libev native API header
		3	*
2	* Copyright (c) 2007 Marc Alexander Lehmann <libev@schmorp.de>	4	* Copyright (c) 2007,2008,2009,2010 Marc Alexander Lehmann <libev@schmorp.de>
3	* All rights reserved.	5	* All rights reserved.
4	*	6	*
5	* Redistribution and use in source and binary forms, with or without	7	* Redistribution and use in source and binary forms, with or without modifica-
6	* modification, are permitted provided that the following conditions are	8	* tion, are permitted provided that the following conditions are met:
7	* met:	9	*
		10	* 1. Redistributions of source code must retain the above copyright notice,
		11	* this list of conditions and the following disclaimer.
		12	*
		13	* 2. Redistributions in binary form must reproduce the above copyright
		14	* notice, this list of conditions and the following disclaimer in the
		15	* documentation and/or other materials provided with the distribution.
		16	*
		17	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
		18	* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MER-
		19	* CHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
		20	* EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPE-
		21	* CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
		22	* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
		23	* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
		24	* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTH-
		25	* ERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
		26	* OF THE POSSIBILITY OF SUCH DAMAGE.
8	*	27	*
9	* * Redistributions of source code must retain the above copyright	28	* Alternatively, the contents of this file may be used under the terms of
10	* notice, this list of conditions and the following disclaimer.	29	* the GNU General Public License ("GPL") version 2 or any later version,
11	*	30	* in which case the provisions of the GPL are applicable instead of
12	* * Redistributions in binary form must reproduce the above	31	* the above. If you wish to allow the use of your version of this file
13	* copyright notice, this list of conditions and the following	32	* only under the terms of the GPL and not to allow others to use your
14	* disclaimer in the documentation and/or other materials provided	33	* version of this file under the BSD license, indicate your decision
15	* with the distribution.	34	* by deleting the provisions above and replace them with the notice
16	*	35	* and other provisions required by the GPL. If you do not delete the
17	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS	36	* provisions above, a recipient may use your version of this file under
18	* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT	37	* either the BSD or the GPL.
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	*/	38	*/
29		39
30	#ifndef EV_H	40	#ifndef EV_H_
31	#define EV_H	41	#define EV_H_
32		42
33	#ifdef __cplusplus	43	#ifdef __cplusplus
34	extern "C" {	44	extern "C" {
35	#endif	45	#endif
36		46
		47	/*****************************************************************************/
		48
		49	/* pre-4.0 compatibility */
		50	#ifndef EV_COMPAT3
		51	# define EV_COMPAT3 1
		52	#endif
		53
		54	#ifndef EV_FEATURES
		55	# define EV_FEATURES 0x7f
		56	#endif
		57
		58	#define EV_FEATURE_CODE ((EV_FEATURES) & 1)
		59	#define EV_FEATURE_DATA ((EV_FEATURES) & 2)
		60	#define EV_FEATURE_CONFIG ((EV_FEATURES) & 4)
		61	#define EV_FEATURE_API ((EV_FEATURES) & 8)
		62	#define EV_FEATURE_WATCHERS ((EV_FEATURES) & 16)
		63	#define EV_FEATURE_BACKENDS ((EV_FEATURES) & 32)
		64	#define EV_FEATURE_OS ((EV_FEATURES) & 64)
		65
		66	/* these priorities are inclusive, higher priorities will be invoked earlier */
		67	#ifndef EV_MINPRI
		68	# define EV_MINPRI (EV_FEATURE_CONFIG ? -2 : 0)
		69	#endif
		70	#ifndef EV_MAXPRI
		71	# define EV_MAXPRI (EV_FEATURE_CONFIG ? +2 : 0)
		72	#endif
		73
		74	#ifndef EV_MULTIPLICITY
		75	# define EV_MULTIPLICITY EV_FEATURE_CONFIG
		76	#endif
		77
		78	#ifndef EV_PERIODIC_ENABLE
		79	# define EV_PERIODIC_ENABLE EV_FEATURE_WATCHERS
		80	#endif
		81
		82	#ifndef EV_STAT_ENABLE
		83	# define EV_STAT_ENABLE EV_FEATURE_WATCHERS
		84	#endif
		85
		86	#ifndef EV_PREPARE_ENABLE
		87	# define EV_PREPARE_ENABLE EV_FEATURE_WATCHERS
		88	#endif
		89
		90	#ifndef EV_CHECK_ENABLE
		91	# define EV_CHECK_ENABLE EV_FEATURE_WATCHERS
		92	#endif
		93
		94	#ifndef EV_IDLE_ENABLE
		95	# define EV_IDLE_ENABLE EV_FEATURE_WATCHERS
		96	#endif
		97
		98	#ifndef EV_FORK_ENABLE
		99	# define EV_FORK_ENABLE EV_FEATURE_WATCHERS
		100	#endif
		101
		102	#ifndef EV_SIGNAL_ENABLE
		103	# define EV_SIGNAL_ENABLE EV_FEATURE_WATCHERS
		104	#endif
		105
		106	#ifndef EV_CHILD_ENABLE
		107	# ifdef _WIN32
		108	# define EV_CHILD_ENABLE 0
		109	# else
		110	# define EV_CHILD_ENABLE EV_FEATURE_WATCHERS
		111	#endif
		112	#endif
		113
		114	#ifndef EV_ASYNC_ENABLE
		115	# define EV_ASYNC_ENABLE EV_FEATURE_WATCHERS
		116	#endif
		117
		118	#ifndef EV_EMBED_ENABLE
		119	# define EV_EMBED_ENABLE EV_FEATURE_WATCHERS
		120	#endif
		121
		122	#ifndef EV_WALK_ENABLE
		123	# define EV_WALK_ENABLE 0 /* not yet */
		124	#endif
		125
		126	/*****************************************************************************/
		127
		128	#if EV_CHILD_ENABLE && !EV_SIGNAL_ENABLE
		129	# undef EV_SIGNAL_ENABLE
		130	# define EV_SIGNAL_ENABLE 1
		131	#endif
		132
		133	/*****************************************************************************/
		134
37	typedef double ev_tstamp;	135	typedef double ev_tstamp;
38		136
39	/* these priorities are inclusive, higher priorities will be called earlier */	137	#ifndef EV_ATOMIC_T
40	#ifndef EV_MINPRI	138	# include <signal.h>
41	# define EV_MINPRI -2	139	# define EV_ATOMIC_T sig_atomic_t volatile
		140	#endif
		141
		142	#if EV_STAT_ENABLE
		143	# ifdef _WIN32
		144	# include <time.h>
		145	# include <sys/types.h>
42	#endif	146	# endif
43	#ifndef EV_MAXPRI	147	# include <sys/stat.h>
44	# define EV_MAXPRI +2
45	#endif
46
47	#ifndef EV_MULTIPLICITY
48	# define EV_MULTIPLICITY 1
49	#endif	148	#endif
50		149
51	/* support multiple event loops? */	150	/* support multiple event loops? */
52	#if EV_MULTIPLICITY	151	#if EV_MULTIPLICITY
53	struct ev_loop;	152	struct ev_loop;
54	# define EV_P struct ev_loop *loop	153	# define EV_P struct ev_loop *loop
55	# define EV_P_ EV_P,	154	# define EV_P_ EV_P,
56	# define EV_A loop	155	# define EV_A loop
57	# define EV_A_ EV_A,	156	# define EV_A_ EV_A,
		157	# define EV_DEFAULT_UC ev_default_loop_uc ()
		158	# define EV_DEFAULT_UC_ EV_DEFAULT_UC,
		159	# define EV_DEFAULT ev_default_loop (0)
		160	# define EV_DEFAULT_ EV_DEFAULT,
58	#else	161	#else
59	# define EV_P void	162	# define EV_P void
60	# define EV_P_	163	# define EV_P_
61	# define EV_A	164	# define EV_A
62	# define EV_A_	165	# define EV_A_
		166	# define EV_DEFAULT
		167	# define EV_DEFAULT_
		168	# define EV_DEFAULT_UC
		169	# define EV_DEFAULT_UC_
		170	# undef EV_EMBED_ENABLE
63	#endif	171	#endif
64		172
65	/* eventmask, revents, events... */	173	#if __STDC_VERSION__ >= 199901L \|\| __GNUC__ >= 3
66	#define EV_UNDEF -1 /* guaranteed to be invalid */	174	# define EV_INLINE static inline
67	#define EV_NONE 0x00	175	#else
68	#define EV_READ 0x01	176	# define EV_INLINE static
69	#define EV_WRITE 0x02
70	#define EV_TIMEOUT 0x000100
71	#define EV_PERIODIC 0x000200
72	#define EV_SIGNAL 0x000400
73	#define EV_IDLE 0x000800
74	#define EV_CHECK 0x001000
75	#define EV_PREPARE 0x002000
76	#define EV_CHILD 0x004000
77	#define EV_ERROR 0x800000 /* sent when an error occurs */
78
79	/* can be used to add custom fields to all watchers */
80	#ifndef EV_COMMON
81	# define EV_COMMON void *data
82	#endif	177	#endif
		178
83	#ifndef EV_PROTOTYPES	179	#ifndef EV_PROTOTYPES
84	# define EV_PROTOTYPES 1	180	# define EV_PROTOTYPES 1
85	#endif	181	#endif
86		182
		183	/*****************************************************************************/
		184
87	#define EV_VERSION_MAJOR 1	185	#define EV_VERSION_MAJOR 4
88	#define EV_VERSION_MINOR 1	186	#define EV_VERSION_MINOR 0
		187
		188	/* eventmask, revents, events... */
		189	enum {
		190	EV_UNDEF = -1, /* guaranteed to be invalid */
		191	EV_NONE = 0x00, /* no events */
		192	EV_READ = 0x01, /* ev_io detected read will not block */
		193	EV_WRITE = 0x02, /* ev_io detected write will not block */
		194	EV__IOFDSET = 0x80, /* internal use only */
		195	EV_IO = EV_READ, /* alias for type-detection */
		196	EV_TIMER = 0x00000100, /* timer timed out */
		197	EV_TIMEOUT = EV_TIMER, /* pre 4.0 API compatibility */
		198	EV_PERIODIC = 0x00000200, /* periodic timer timed out */
		199	EV_SIGNAL = 0x00000400, /* signal was received */
		200	EV_CHILD = 0x00000800, /* child/pid had status change */
		201	EV_STAT = 0x00001000, /* stat data changed */
		202	EV_IDLE = 0x00002000, /* event loop is idling */
		203	EV_PREPARE = 0x00004000, /* event loop about to poll */
		204	EV_CHECK = 0x00008000, /* event loop finished poll */
		205	EV_EMBED = 0x00010000, /* embedded event loop needs sweep */
		206	EV_FORK = 0x00020000, /* event loop resumed in child */
		207	EV_ASYNC = 0x00040000, /* async intra-loop signal */
		208	EV_CUSTOM = 0x01000000, /* for use by user code */
		209	EV_ERROR = 0x80000000 /* sent when an error occurs */
		210	};
		211
		212	/* can be used to add custom fields to all watchers, while losing binary compatibility */
		213	#ifndef EV_COMMON
		214	# define EV_COMMON void *data;
		215	#endif
		216
		217	#ifndef EV_CB_DECLARE
		218	# define EV_CB_DECLARE(type) void (cb)(EV_P_ struct type w, int revents);
		219	#endif
		220	#ifndef EV_CB_INVOKE
		221	# define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents))
		222	#endif
		223
		224	/* not official, do not use */
		225	#define EV_CB(type,name) void name (EV_P_ struct ev_ ## type *w, int revents)
89		226
90	/*	227	/*
91	* struct member types:	228	* struct member types:
92	* private: you can look at them, but not change them, and they might not mean anything to you.	229	* private: you may look at them, but not change them,
		230	* and they might not mean anything to you.
93	* ro: can be read anytime, but only changed when the watcher isn't active	231	* ro: can be read anytime, but only changed when the watcher isn't active.
94	* rw: can be read and modified anytime, even when the watcher is active	232	* rw: can be read and modified anytime, even when the watcher is active.
		233	*
		234	* some internal details that might be helpful for debugging:
		235	*
		236	* active is either 0, which means the watcher is not active,
		237	* or the array index of the watcher (periodics, timers)
		238	* or the array index + 1 (most other watchers)
		239	* or simply 1 for watchers that aren't in some array.
		240	* pending is either 0, in which case the watcher isn't,
		241	* or the array index + 1 in the pendings array.
95	*/	242	*/
		243
		244	#if EV_MINPRI == EV_MAXPRI
		245	# define EV_DECL_PRIORITY
		246	#elif !defined (EV_DECL_PRIORITY)
		247	# define EV_DECL_PRIORITY int priority;
		248	#endif
96		249
97	/* shared by all watchers */	250	/* shared by all watchers */
98	#define EV_WATCHER(type) \	251	#define EV_WATCHER(type) \
99	int active; /* private */ \	252	int active; /* private */ \
100	int pending; /* private */ \	253	int pending; /* private */ \
101	int priority; /* ro */ \	254	EV_DECL_PRIORITY /* private */ \
102	EV_COMMON; /* rw */ \	255	EV_COMMON /* rw */ \
103	void (cb)(EV_P_ struct type , int revents); /* rw / / gets invoked with an eventmask */	256	EV_CB_DECLARE (type) /* private */
104		257
105	#define EV_WATCHER_LIST(type) \	258	#define EV_WATCHER_LIST(type) \
106	EV_WATCHER (type); \	259	EV_WATCHER (type) \
107	struct ev_watcher_list next / private */	260	struct ev_watcher_list next; / private */
108		261
109	#define EV_WATCHER_TIME(type) \	262	#define EV_WATCHER_TIME(type) \
110	EV_WATCHER (type); \	263	EV_WATCHER (type) \
111	ev_tstamp at /* private */	264	ev_tstamp at; /* private */
112		265
113	/* base class, nothing to see here unless you subclass */	266	/* base class, nothing to see here unless you subclass */
114	struct ev_watcher {	267	typedef struct ev_watcher
		268	{
115	EV_WATCHER (ev_watcher);	269	EV_WATCHER (ev_watcher)
116	};	270	} ev_watcher;
117		271
118	/* base class, nothing to see here unless you subclass */	272	/* base class, nothing to see here unless you subclass */
119	struct ev_watcher_list {	273	typedef struct ev_watcher_list
		274	{
120	EV_WATCHER_LIST (ev_watcher_list);	275	EV_WATCHER_LIST (ev_watcher_list)
121	};	276	} ev_watcher_list;
122		277
123	/* base class, nothing to see here unless you subclass */	278	/* base class, nothing to see here unless you subclass */
124	struct ev_watcher_time {	279	typedef struct ev_watcher_time
		280	{
125	EV_WATCHER_TIME (ev_watcher_time);	281	EV_WATCHER_TIME (ev_watcher_time)
126	};	282	} ev_watcher_time;
		283
		284	/* invoked when fd is either EV_READable or EV_WRITEable */
		285	/* revent EV_READ, EV_WRITE */
		286	typedef struct ev_io
		287	{
		288	EV_WATCHER_LIST (ev_io)
		289
		290	int fd; /* ro */
		291	int events; /* ro */
		292	} ev_io;
127		293
128	/* invoked after a specific time, repeatable (based on monotonic clock) */	294	/* invoked after a specific time, repeatable (based on monotonic clock) */
129	/* revent EV_TIMEOUT */	295	/* revent EV_TIMEOUT */
130	struct ev_timer	296	typedef struct ev_timer
131	{	297	{
132	EV_WATCHER_TIME (ev_timer);	298	EV_WATCHER_TIME (ev_timer)
133		299
134	ev_tstamp repeat; /* rw */	300	ev_tstamp repeat; /* rw */
135	};	301	} ev_timer;
136		302
137	/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */	303	/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
138	/* revent EV_PERIODIC */	304	/* revent EV_PERIODIC */
139	struct ev_periodic	305	typedef struct ev_periodic
140	{	306	{
141	EV_WATCHER_TIME (ev_periodic);	307	EV_WATCHER_TIME (ev_periodic)
142		308
		309	ev_tstamp offset; /* rw */
143	ev_tstamp interval; /* rw */	310	ev_tstamp interval; /* rw */
144	};	311	ev_tstamp (reschedule_cb)(struct ev_periodic w, ev_tstamp now); /* rw */
145		312	} ev_periodic;
146	/* invoked when fd is either EV_READable or EV_WRITEable */
147	/* revent EV_READ, EV_WRITE */
148	struct ev_io
149	{
150	EV_WATCHER_LIST (ev_io);
151
152	int fd; /* ro */
153	int events; /* ro */
154	};
155		313
156	/* invoked when the given signal has been received */	314	/* invoked when the given signal has been received */
157	/* revent EV_SIGNAL */	315	/* revent EV_SIGNAL */
158	struct ev_signal	316	typedef struct ev_signal
159	{	317	{
160	EV_WATCHER_LIST (ev_signal);	318	EV_WATCHER_LIST (ev_signal)
161	#if EV_MULTIPLICITY
162	struct ev_loop *loop;
163	#endif
164		319
165	int signum; /* ro */	320	int signum; /* ro */
166	};	321	} ev_signal;
167		322
		323	/* invoked when sigchld is received and waitpid indicates the given pid */
		324	/* revent EV_CHILD */
		325	/* does not support priorities */
		326	typedef struct ev_child
		327	{
		328	EV_WATCHER_LIST (ev_child)
		329
		330	int flags; /* private */
		331	int pid; /* ro */
		332	int rpid; /* rw, holds the received pid */
		333	int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
		334	} ev_child;
		335
		336	#if EV_STAT_ENABLE
		337	/* st_nlink = 0 means missing file or other error */
		338	# ifdef _WIN32
		339	typedef struct _stati64 ev_statdata;
		340	# else
		341	typedef struct stat ev_statdata;
		342	# endif
		343
		344	/* invoked each time the stat data changes for a given path */
		345	/* revent EV_STAT */
		346	typedef struct ev_stat
		347	{
		348	EV_WATCHER_LIST (ev_stat)
		349
		350	ev_timer timer; /* private */
		351	ev_tstamp interval; /* ro */
		352	const char path; / ro */
		353	ev_statdata prev; /* ro */
		354	ev_statdata attr; /* ro */
		355
		356	int wd; /* wd for inotify, fd for kqueue */
		357	} ev_stat;
		358	#endif
		359
		360	#if EV_IDLE_ENABLE
168	/* invoked when the nothing else needs to be done, keeps the process from blocking */	361	/* invoked when the nothing else needs to be done, keeps the process from blocking */
169	/* revent EV_IDLE */	362	/* revent EV_IDLE */
170	struct ev_idle	363	typedef struct ev_idle
171	{	364	{
172	EV_WATCHER (ev_idle);	365	EV_WATCHER (ev_idle)
173	};	366	} ev_idle;
		367	#endif
174		368
175	/* invoked for each run of the mainloop, just before the blocking call */	369	/* invoked for each run of the mainloop, just before the blocking call */
176	/* you can still change events in any way you like */	370	/* you can still change events in any way you like */
177	/* revent EV_PREPARE */	371	/* revent EV_PREPARE */
178	struct ev_prepare	372	typedef struct ev_prepare
179	{	373	{
180	EV_WATCHER (ev_prepare);	374	EV_WATCHER (ev_prepare)
181	};	375	} ev_prepare;
182		376
183	/* invoked for each run of the mainloop, just after the blocking call */	377	/* invoked for each run of the mainloop, just after the blocking call */
184	/* revent EV_CHECK */	378	/* revent EV_CHECK */
185	struct ev_check	379	typedef struct ev_check
186	{	380	{
187	EV_WATCHER (ev_check);	381	EV_WATCHER (ev_check)
		382	} ev_check;
		383
		384	#if EV_FORK_ENABLE
		385	/* the callback gets invoked before check in the child process when a fork was detected */
		386	typedef struct ev_fork
		387	{
		388	EV_WATCHER (ev_fork)
		389	} ev_fork;
		390	#endif
		391
		392	#if EV_EMBED_ENABLE
		393	/* used to embed an event loop inside another */
		394	/* the callback gets invoked when the event loop has handled events, and can be 0 */
		395	typedef struct ev_embed
		396	{
		397	EV_WATCHER (ev_embed)
		398
		399	struct ev_loop other; / ro */
		400	ev_io io; /* private */
		401	ev_prepare prepare; /* private */
		402	ev_check check; /* unused */
		403	ev_timer timer; /* unused */
		404	ev_periodic periodic; /* unused */
		405	ev_idle idle; /* unused */
		406	ev_fork fork; /* private */
		407	} ev_embed;
		408	#endif
		409
		410	#if EV_ASYNC_ENABLE
		411	/* invoked when somebody calls ev_async_send on the watcher */
		412	/* revent EV_ASYNC */
		413	typedef struct ev_async
		414	{
		415	EV_WATCHER (ev_async)
		416
		417	EV_ATOMIC_T sent; /* private */
		418	} ev_async;
		419
		420	# define ev_async_pending(w) (+(w)->sent)
		421	#endif
		422
		423	/* the presence of this union forces similar struct layout */
		424	union ev_any_watcher
		425	{
		426	struct ev_watcher w;
		427	struct ev_watcher_list wl;
		428
		429	struct ev_io io;
		430	struct ev_timer timer;
		431	struct ev_periodic periodic;
		432	struct ev_signal signal;
		433	struct ev_child child;
		434	#if EV_STAT_ENABLE
		435	struct ev_stat stat;
		436	#endif
		437	#if EV_IDLE_ENABLE
		438	struct ev_idle idle;
		439	#endif
		440	struct ev_prepare prepare;
		441	struct ev_check check;
		442	#if EV_FORK_ENABLE
		443	struct ev_fork fork;
		444	#endif
		445	#if EV_EMBED_ENABLE
		446	struct ev_embed embed;
		447	#endif
		448	#if EV_ASYNC_ENABLE
		449	struct ev_async async;
		450	#endif
188	};	451	};
189		452
190	/* invoked when sigchld is received and waitpid indicates the givne pid */	453	/* flag bits for ev_default_loop and ev_loop_new */
191	/* revent EV_CHILD */	454	enum {
192	/* does not support priorities */	455	/* the default */
193	struct ev_child	456	EVFLAG_AUTO = 0x00000000U, /* not quite a mask */
194	{	457	/* flag bits */
195	EV_WATCHER_LIST (ev_child);	458	EVFLAG_NOENV = 0x01000000U, /* do NOT consult environment */
196		459	EVFLAG_FORKCHECK = 0x02000000U, /* check for a fork in each iteration */
197	int pid; /* ro */	460	/* debugging/feature disable */
198	int rpid; /* rw, holds the received pid */	461	EVFLAG_NOINOTIFY = 0x00100000U, /* do not attempt to use inotify */
199	int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */	462	#if EV_COMPAT3
		463	EVFLAG_NOSIGFD = 0, /* compatibility to pre-3.9 */
		464	#endif
		465	EVFLAG_SIGNALFD = 0x00200000U /* attempt to use signalfd */
200	};	466	};
201		467
202	#define EVMETHOD_AUTO 0 /* consults environment */	468	/* method bits to be ored together */
203	#define EVMETHOD_SELECT 1	469	enum {
204	#define EVMETHOD_POLL 2	470	EVBACKEND_SELECT = 0x00000001U, /* about anywhere */
205	#define EVMETHOD_EPOLL 4	471	EVBACKEND_POLL = 0x00000002U, /* !win */
206	#define EVMETHOD_KQUEUE 8	472	EVBACKEND_EPOLL = 0x00000004U, /* linux */
207	#define EVMETHOD_DEVPOLL 16 /* NYI */	473	EVBACKEND_KQUEUE = 0x00000008U, /* bsd */
208	#define EVMETHOD_PORT 32 /* NYI */	474	EVBACKEND_DEVPOLL = 0x00000010U, /* solaris 8 / / NYI */
209	#define EVMETHOD_ANY ~0 /* any method, do not consult env */	475	EVBACKEND_PORT = 0x00000020U, /* solaris 10 */
		476	EVBACKEND_ALL = 0x0000003FU
		477	};
210		478
211	#if EV_PROTOTYPES	479	#if EV_PROTOTYPES
212	int ev_version_major (void);	480	int ev_version_major (void);
213	int ev_version_minor (void);	481	int ev_version_minor (void);
214		482
215	/* these three calls are suitable for plugging into pthread_atfork */	483	unsigned int ev_supported_backends (void);
216	void ev_fork_prepare (void);	484	unsigned int ev_recommended_backends (void);
217	void ev_fork_parent (void);	485	unsigned int ev_embeddable_backends (void);
218	void ev_fork_child (void);
219		486
220	ev_tstamp ev_time (void);	487	ev_tstamp ev_time (void);
		488	void ev_sleep (ev_tstamp delay); /* sleep for a while */
221		489
		490	/* Sets the allocation function to use, works like realloc.
		491	* It is used to allocate and free memory.
		492	* If it returns zero when memory needs to be allocated, the library might abort
		493	* or take some potentially destructive action.
		494	* The default is your system realloc function.
		495	*/
		496	void ev_set_allocator (void (cb)(void *ptr, long size));
		497
		498	/* set the callback function to call on a
		499	* retryable syscall error
		500	* (such as failed select, poll, epoll_wait)
		501	*/
		502	void ev_set_syserr_cb (void (cb)(const char msg));
		503
222	# if EV_MULTIPLICITY	504	#if EV_MULTIPLICITY
		505	EV_INLINE struct ev_loop *
		506	ev_default_loop_uc (void)
		507	{
		508	extern struct ev_loop *ev_default_loop_ptr;
		509
		510	return ev_default_loop_ptr;
		511	}
		512
		513	/* the default loop is the only one that handles signals and child watchers */
		514	/* you can call this as often as you like */
		515	EV_INLINE struct ev_loop *
		516	ev_default_loop (unsigned int flags)
		517	{
		518	struct ev_loop *loop = ev_default_loop_uc ();
		519
		520	if (!loop)
		521	{
		522	extern struct ev_loop *ev_default_loop_init (unsigned int flags);
		523
		524	loop = ev_default_loop_init (flags);
		525	}
		526
		527	return loop;
		528	}
		529
		530	/* create and destroy alternative loops that don't handle signals */
223	struct ev_loop *ev_loop_new (int methods);	531	struct ev_loop *ev_loop_new (unsigned int flags);
224	void ev_loop_delete (EV_P);	532	void ev_loop_destroy (EV_P);
		533	void ev_loop_fork (EV_P);
		534
		535	ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
		536
225	# else	537	#else
226	int ev_init (int methods); /* returns ev_method */	538
		539	int ev_default_loop (unsigned int flags); /* returns true when successful */
		540
		541	EV_INLINE ev_tstamp
		542	ev_now (void)
		543	{
		544	extern ev_tstamp ev_rt_now;
		545
		546	return ev_rt_now;
		547	}
		548	#endif /* multiplicity */
		549
		550	EV_INLINE int
		551	ev_is_default_loop (EV_P)
		552	{
		553	#if EV_MULTIPLICITY
		554	extern struct ev_loop *ev_default_loop_ptr;
		555
		556	return !!(EV_A == ev_default_loop_ptr);
		557	#else
		558	return 1;
227	# endif	559	#endif
		560	}
228		561
229	int ev_method (EV_P);	562	void ev_default_destroy (void); /* destroy the default loop */
		563	/* this needs to be called after fork, to duplicate the default loop */
		564	/* if you create alternative loops you have to call ev_loop_fork on them */
		565	/* you can call it in either the parent or the child */
		566	/* you can actually call it at any time, anywhere :) */
		567	void ev_default_fork (void);
230		568
231	#endif	569	unsigned int ev_backend (EV_P); /* backend in use by loop */
232		570
233	#define EVLOOP_NONBLOCK 1 /* do not block/wait */	571	void ev_now_update (EV_P); /* update event loop time */
234	#define EVLOOP_ONESHOT 2 /* block once only */	572
235	#define EVUNLOOP_ONCE 1 /* unloop once */	573	#if EV_WALK_ENABLE
		574	/* walk (almost) all watchers in the loop of a given type, invoking the */
		575	/* callback on every such watcher. The callback might stop the watcher, */
		576	/* but do nothing else with the loop */
		577	void ev_walk (EV_P_ int types, void (cb)(EV_P_ int type, void w));
		578	#endif
		579
		580	#endif /* prototypes */
		581
		582	/* ev_run flags values */
		583	enum {
		584	EVRUN_NOWAIT = 1, /* do not block/wait */
		585	EVRUN_ONCE = 2 /* block once only */
		586	};
		587
		588	/* ev_break how values */
		589	enum {
		590	EVBREAK_CANCEL = 0, /* undo unloop */
		591	EVBREAK_ONE = 1, /* unloop once */
236	#define EVUNLOOP_ALL 2 /* unloop all loops */	592	EVBREAK_ALL = 2 /* unloop all loops */
		593	};
237		594
238	#if EV_PROTOTYPES	595	#if EV_PROTOTYPES
239	void ev_loop (EV_P_ int flags);	596	void ev_run (EV_P_ int flags);
240	void ev_unloop (EV_P_ int how); /* set to 1 to break out of event loop, set to 2 to break out of all event loops */	597	void ev_break (EV_P_ int how); /* set to 1 to break out of event loop, set to 2 to break out of all event loops */
241
242	ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
243		598
244	/*	599	/*
245	* ref/unref can be used to add or remove a refcount on the mainloop. every watcher	600	* ref/unref can be used to add or remove a refcount on the mainloop. every watcher
246	* keeps one reference. if you have a long-runing watcher you never unregister that	601	* keeps one reference. if you have a long-running watcher you never unregister that
247	* should not keep ev_loop from running, unref() after starting, and ref() before stopping.	602	* should not keep ev_loop from running, unref() after starting, and ref() before stopping.
248	*/	603	*/
249	void ev_ref (EV_P);	604	void ev_ref (EV_P);
250	void ev_unref (EV_P);	605	void ev_unref (EV_P);
251		606
		607	/*
252	/* convinience function, wait for a single event, without registering an event watcher */	608	* convenience function, wait for a single event, without registering an event watcher
253	/* if timeout is < 0, do wait indefinitely */	609	* if timeout is < 0, do wait indefinitely
		610	*/
254	void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (cb)(int revents, void arg), void *arg);	611	void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (cb)(int revents, void arg), void *arg);
		612
		613	# if EV_FEATURE_API
		614	unsigned int ev_iteration (EV_P); /* number of loop iterations */
		615	unsigned int ev_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */
		616	void ev_verify (EV_P); /* abort if loop data corrupted */
		617
		618	void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
		619	void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
		620
		621	/* advanced stuff for threading etc. support, see docs */
		622	void ev_set_userdata (EV_P_ void *data);
		623	void *ev_userdata (EV_P);
		624	void ev_set_invoke_pending_cb (EV_P_ void (*invoke_pending_cb)(EV_P));
		625	void ev_set_loop_release_cb (EV_P_ void (release)(EV_P), void (acquire)(EV_P));
		626
		627	unsigned int ev_pending_count (EV_P); /* number of pending events, if any */
		628	void ev_invoke_pending (EV_P); /* invoke all pending watchers */
		629
		630	/*
		631	* stop/start the timer handling.
		632	*/
		633	void ev_suspend (EV_P);
		634	void ev_resume (EV_P);
		635	#endif
		636
255	#endif	637	#endif
256		638
257	/* these may evaluate ev multiple times, and the other arguments at most once */	639	/* these may evaluate ev multiple times, and the other arguments at most once */
258	/* either use ev_watcher_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */	640	/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
259	#define ev_watcher_init(ev,cb_) do { (ev)->active = (ev)->pending = (ev)->priority = 0; (ev)->cb = (cb_); } while (0)	641	#define ev_init(ev,cb_) do { \
		642	((ev_watcher )(void )(ev))->active = \
		643	((ev_watcher )(void )(ev))->pending = 0; \
		644	ev_set_priority ((ev), 0); \
		645	ev_set_cb ((ev), cb_); \
		646	} while (0)
260		647
261	#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0)	648	#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) \| EV__IOFDSET; } while (0)
262	#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)	649	#define ev_timer_set(ev,after_,repeat_) do { ((ev_watcher_time *)(ev))->at = (after_); (ev)->repeat = (repeat_); } while (0)
263	#define ev_periodic_set(ev,at_,interval_) do { (ev)->at = (at_); (ev)->interval = (interval_); } while (0)	650	#define ev_periodic_set(ev,ofs_,ival_,rcb_) do { (ev)->offset = (ofs_); (ev)->interval = (ival_); (ev)->reschedule_cb = (rcb_); } while (0)
264	#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)	651	#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
		652	#define ev_child_set(ev,pid_,trace_) do { (ev)->pid = (pid_); (ev)->flags = !!(trace_); } while (0)
		653	#define ev_stat_set(ev,path_,interval_) do { (ev)->path = (path_); (ev)->interval = (interval_); (ev)->wd = -2; } while (0)
265	#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */	654	#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
266	#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */	655	#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
267	#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */	656	#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
268	#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0)	657	#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0)
		658	#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */
		659	#define ev_async_set(ev) /* nop, yes, this is a serious in-joke */
269		660
270	#define ev_io_init(ev,cb,fd,events) do { ev_watcher_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)	661	#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
271	#define ev_timer_init(ev,cb,after,repeat) do { ev_watcher_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)	662	#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
272	#define ev_periodic_init(ev,cb,at,interval) do { ev_watcher_init ((ev), (cb)); ev_periodic_set ((ev),(at),(interval)); } while (0)	663	#define ev_periodic_init(ev,cb,ofs,ival,rcb) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(ofs),(ival),(rcb)); } while (0)
273	#define ev_signal_init(ev,cb,signum) do { ev_watcher_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)	664	#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
		665	#define ev_child_init(ev,cb,pid,trace) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid),(trace)); } while (0)
		666	#define ev_stat_init(ev,cb,path,interval) do { ev_init ((ev), (cb)); ev_stat_set ((ev),(path),(interval)); } while (0)
274	#define ev_idle_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)	667	#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
275	#define ev_prepare_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)	668	#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
276	#define ev_check_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_check_set ((ev)); } while (0)	669	#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
		670	#define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0)
		671	#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0)
277	#define ev_child_init(ev,cb,pid) do { ev_watcher_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)	672	#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0)
278		673
		674	#define ev_is_pending(ev) (0 + ((ev_watcher )(void )(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
279	#define ev_is_active(ev) (0 + (ev)->active) /* true when the watcher has been started */	675	#define ev_is_active(ev) (0 + ((ev_watcher )(void )(ev))->active) /* ro, true when the watcher has been started */
		676
		677	#define ev_cb(ev) (ev)->cb /* rw */
		678
		679	#if EV_MINPRI == EV_MAXPRI
		680	# define ev_priority(ev) ((ev), EV_MINPRI)
280	#define ev_set_priority(ev,pri) (ev)->priority = pri	681	# define ev_set_priority(ev,pri) ((ev), (pri))
		682	#else
		683	# define ev_priority(ev) (+(((ev_watcher )(void )(ev))->priority))
		684	# define ev_set_priority(ev,pri) ( (ev_watcher )(void )(ev))->priority = (pri)
		685	#endif
		686
		687	#define ev_periodic_at(ev) (+((ev_watcher_time *)(ev))->at)
		688
		689	#ifndef ev_set_cb
		690	# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
		691	#endif
281		692
282	/* stopping (enabling, adding) a watcher does nothing if it is already running */	693	/* stopping (enabling, adding) a watcher does nothing if it is already running */
283	/* stopping (disabling, deleting) a watcher does nothing unless its already running */	694	/* stopping (disabling, deleting) a watcher does nothing unless its already running */
284	#if EV_PROTOTYPES	695	#if EV_PROTOTYPES
		696
		697	/* feeds an event into a watcher as if the event actually occured */
		698	/* accepts any ev_watcher type */
		699	void ev_feed_event (EV_P_ void *w, int revents);
		700	void ev_feed_fd_event (EV_P_ int fd, int revents);
		701	#if EV_SIGNAL_ENABLE
		702	void ev_feed_signal_event (EV_P_ int signum);
		703	#endif
		704	void ev_invoke (EV_P_ void *w, int revents);
		705	int ev_clear_pending (EV_P_ void *w);
		706
285	void ev_io_start (EV_P_ struct ev_io *w);	707	void ev_io_start (EV_P_ ev_io *w);
286	void ev_io_stop (EV_P_ struct ev_io *w);	708	void ev_io_stop (EV_P_ ev_io *w);
287		709
288	void ev_timer_start (EV_P_ struct ev_timer *w);	710	void ev_timer_start (EV_P_ ev_timer *w);
289	void ev_timer_stop (EV_P_ struct ev_timer *w);	711	void ev_timer_stop (EV_P_ ev_timer *w);
290	void ev_timer_again (EV_P_ struct ev_timer w); / stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */	712	/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
		713	void ev_timer_again (EV_P_ ev_timer *w);
		714	/* return remaining time */
		715	ev_tstamp ev_timer_remaining (EV_P_ ev_timer *w);
291		716
		717	#if EV_PERIODIC_ENABLE
292	void ev_periodic_start (EV_P_ struct ev_periodic *w);	718	void ev_periodic_start (EV_P_ ev_periodic *w);
293	void ev_periodic_stop (EV_P_ struct ev_periodic *w);	719	void ev_periodic_stop (EV_P_ ev_periodic *w);
		720	void ev_periodic_again (EV_P_ ev_periodic *w);
		721	#endif
294		722
		723	/* only supported in the default loop */
		724	#if EV_SIGNAL_ENABLE
295	void ev_signal_start (EV_P_ struct ev_signal *w);	725	void ev_signal_start (EV_P_ ev_signal *w);
296	void ev_signal_stop (EV_P_ struct ev_signal *w);	726	void ev_signal_stop (EV_P_ ev_signal *w);
		727	#endif
297		728
		729	/* only supported in the default loop */
		730	# if EV_CHILD_ENABLE
		731	void ev_child_start (EV_P_ ev_child *w);
		732	void ev_child_stop (EV_P_ ev_child *w);
		733	# endif
		734
		735	# if EV_STAT_ENABLE
		736	void ev_stat_start (EV_P_ ev_stat *w);
		737	void ev_stat_stop (EV_P_ ev_stat *w);
		738	void ev_stat_stat (EV_P_ ev_stat *w);
		739	# endif
		740
		741	# if EV_IDLE_ENABLE
298	void ev_idle_start (EV_P_ struct ev_idle *w);	742	void ev_idle_start (EV_P_ ev_idle *w);
299	void ev_idle_stop (EV_P_ struct ev_idle *w);	743	void ev_idle_stop (EV_P_ ev_idle *w);
		744	# endif
300		745
		746	#if EV_PREPARE_ENABLE
301	void ev_prepare_start (EV_P_ struct ev_prepare *w);	747	void ev_prepare_start (EV_P_ ev_prepare *w);
302	void ev_prepare_stop (EV_P_ struct ev_prepare *w);	748	void ev_prepare_stop (EV_P_ ev_prepare *w);
		749	#endif
303		750
		751	#if EV_CHECK_ENABLE
304	void ev_check_start (EV_P_ struct ev_check *w);	752	void ev_check_start (EV_P_ ev_check *w);
305	void ev_check_stop (EV_P_ struct ev_check *w);	753	void ev_check_stop (EV_P_ ev_check *w);
		754	#endif
306		755
		756	# if EV_FORK_ENABLE
		757	void ev_fork_start (EV_P_ ev_fork *w);
		758	void ev_fork_stop (EV_P_ ev_fork *w);
		759	# endif
		760
		761	# if EV_EMBED_ENABLE
		762	/* only supported when loop to be embedded is in fact embeddable */
307	void ev_child_start (EV_P_ struct ev_child *w);	763	void ev_embed_start (EV_P_ ev_embed *w);
308	void ev_child_stop (EV_P_ struct ev_child *w);	764	void ev_embed_stop (EV_P_ ev_embed *w);
		765	void ev_embed_sweep (EV_P_ ev_embed *w);
		766	# endif
		767
		768	# if EV_ASYNC_ENABLE
		769	void ev_async_start (EV_P_ ev_async *w);
		770	void ev_async_stop (EV_P_ ev_async *w);
		771	void ev_async_send (EV_P_ ev_async *w);
		772	# endif
		773
		774	#if EV_COMPAT3
		775	#define EVLOOP_NONBLOCK EVRUN_NOWAIT
		776	#define EVLOOP_ONESHOT EVRUN_ONCE
		777	#define EVUNLOOP_CANCEL EVBREAK_CANCEL
		778	#define EVUNLOOP_ONE EVBREAK_ONE
		779	#define EVUNLOOP_ALL EVBREAK_ALL
		780	#if EV_PROTOTYPES
		781	EV_INLINE void ev_loop (EV_P_ int flags) { ev_run (EV_A_ flags); }
		782	EV_INLINE void ev_unloop (EV_P_ int how ) { ev_break (EV_A_ how ); }
		783	#if EV_FEATURE_API
		784	EV_INLINE void ev_loop_count (EV_P) { ev_iteration (EV_A); }
		785	EV_INLINE void ev_loop_depth (EV_P) { ev_depth (EV_A); }
		786	EV_INLINE void ev_loop_verify (EV_P) { ev_verify (EV_A); }
		787	#endif
		788	#endif
		789	#else
		790	typedef struct ev_loop ev_loop;
		791	#endif
		792
309	#endif	793	#endif
310		794
311	#ifdef __cplusplus	795	#ifdef __cplusplus
312	}	796	}
313	#endif	797	#endif

Diff Legend

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

Comparing libev/ev.h (file contents): Revision 1.29 by root, Sun Nov 4 00:24:17 2007 UTC vs. Revision 1.142 by root, Thu Oct 21 14:50:58 2010 UTC

Diff Legend

Comparing libev/ev.h (file contents):
Revision 1.29 by root, Sun Nov 4 00:24:17 2007 UTC vs.
Revision 1.142 by root, Thu Oct 21 14:50:58 2010 UTC