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

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

Diff Legend

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

Comparing libev/ev.h (file contents): Revision 1.52 by root, Mon Nov 12 00:31:08 2007 UTC vs. Revision 1.115 by root, Sat Apr 25 14:12:48 2009 UTC

Diff Legend

Comparing libev/ev.h (file contents):
Revision 1.52 by root, Mon Nov 12 00:31:08 2007 UTC vs.
Revision 1.115 by root, Sat Apr 25 14:12:48 2009 UTC