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

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

Diff Legend

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

Comparing libev/ev.h (file contents): Revision 1.69 by root, Mon Nov 26 19:49:36 2007 UTC vs. Revision 1.123 by root, Wed Jul 15 16:58:53 2009 UTC

Diff Legend

Comparing libev/ev.h (file contents):
Revision 1.69 by root, Mon Nov 26 19:49:36 2007 UTC vs.
Revision 1.123 by root, Wed Jul 15 16:58:53 2009 UTC