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

Comparing libev/ev.h (file contents):
Revision 1.7 by root, Wed Oct 31 10:50:05 2007 UTC vs.
Revision 1.166 by root, Mon Apr 2 23:46:11 2012 UTC

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

Diff Legend

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

Comparing libev/ev.h (file contents): Revision 1.7 by root, Wed Oct 31 10:50:05 2007 UTC vs. Revision 1.166 by root, Mon Apr 2 23:46:11 2012 UTC

Diff Legend

Comparing libev/ev.h (file contents):
Revision 1.7 by root, Wed Oct 31 10:50:05 2007 UTC vs.
Revision 1.166 by root, Mon Apr 2 23:46:11 2012 UTC