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

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

Diff Legend

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

Comparing libev/ev.h (file contents): Revision 1.24 by root, Sat Nov 3 09:19:58 2007 UTC vs. Revision 1.133 by root, Wed Mar 10 09:23:07 2010 UTC

Diff Legend

Comparing libev/ev.h (file contents):
Revision 1.24 by root, Sat Nov 3 09:19:58 2007 UTC vs.
Revision 1.133 by root, Wed Mar 10 09:23:07 2010 UTC