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

Comparing libev/ev.h (file contents):
Revision 1.3 by root, Tue Oct 30 23:10:33 2007 UTC vs.
Revision 1.148 by root, Sun Oct 24 14:44:40 2010 UTC

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

Diff Legend

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

Comparing libev/ev.h (file contents): Revision 1.3 by root, Tue Oct 30 23:10:33 2007 UTC vs. Revision 1.148 by root, Sun Oct 24 14:44:40 2010 UTC

Diff Legend

Comparing libev/ev.h (file contents):
Revision 1.3 by root, Tue Oct 30 23:10:33 2007 UTC vs.
Revision 1.148 by root, Sun Oct 24 14:44:40 2010 UTC