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

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

Diff Legend

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

Comparing libev/ev.h (file contents): Revision 1.14 by root, Wed Oct 31 20:46:44 2007 UTC vs. Revision 1.124 by root, Sun Jul 19 06:35:25 2009 UTC

Diff Legend

Comparing libev/ev.h (file contents):
Revision 1.14 by root, Wed Oct 31 20:46:44 2007 UTC vs.
Revision 1.124 by root, Sun Jul 19 06:35:25 2009 UTC