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

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

Diff Legend

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

Comparing libev/ev.h (file contents): Revision 1.24 by root, Sat Nov 3 09:19:58 2007 UTC vs. Revision 1.149 by root, Sun Oct 24 17:58:41 2010 UTC

Diff Legend

Comparing libev/ev.h (file contents):
Revision 1.24 by root, Sat Nov 3 09:19:58 2007 UTC vs.
Revision 1.149 by root, Sun Oct 24 17:58:41 2010 UTC