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

Comparing libev/ev.h (file contents):
Revision 1.51 by root, Sun Nov 11 04:13:42 2007 UTC vs.
Revision 1.112 by root, Sat Mar 28 22:17:17 2009 UTC

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

Diff Legend

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

Comparing libev/ev.h (file contents): Revision 1.51 by root, Sun Nov 11 04:13:42 2007 UTC vs. Revision 1.112 by root, Sat Mar 28 22:17:17 2009 UTC

Diff Legend

Comparing libev/ev.h (file contents):
Revision 1.51 by root, Sun Nov 11 04:13:42 2007 UTC vs.
Revision 1.112 by root, Sat Mar 28 22:17:17 2009 UTC