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

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

Diff Legend

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

Comparing libev/ev.h (file contents): Revision 1.14 by root, Wed Oct 31 20:46:44 2007 UTC vs. Revision 1.138 by root, Tue Mar 16 20:32:20 2010 UTC

Diff Legend

Comparing libev/ev.h (file contents):
Revision 1.14 by root, Wed Oct 31 20:46:44 2007 UTC vs.
Revision 1.138 by root, Tue Mar 16 20:32:20 2010 UTC