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

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

Diff Legend

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

Comparing libev/ev.h (file contents): Revision 1.49 by root, Sat Nov 10 21:19:30 2007 UTC vs. Revision 1.125 by root, Mon Aug 3 12:12:40 2009 UTC

Diff Legend

Comparing libev/ev.h (file contents):
Revision 1.49 by root, Sat Nov 10 21:19:30 2007 UTC vs.
Revision 1.125 by root, Mon Aug 3 12:12:40 2009 UTC