[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.135 by root, Tue Mar 16 00:26:41 2010 UTC

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

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.135 by root, Tue Mar 16 00:26:41 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.135 by root, Tue Mar 16 00:26:41 2010 UTC