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

Comparing libev/ev.h (file contents):
Revision 1.135 by root, Tue Mar 16 00:26:41 2010 UTC vs.
Revision 1.167 by root, Wed Apr 18 05:44:42 2012 UTC

…		…
1	/*	1	/*
2	* libev native API header	2	* libev native API header
3	*	3	*
4	* Copyright (c) 2007,2008,2009,2010 Marc Alexander Lehmann <libev@schmorp.de>	4	* Copyright (c) 2007,2008,2009,2010,2011,2012 Marc Alexander Lehmann <libev@schmorp.de>
5	* All rights reserved.	5	* All rights reserved.
6	*	6	*
7	* Redistribution and use in source and binary forms, with or without modifica-	7	* Redistribution and use in source and binary forms, with or without modifica-
8	* tion, are permitted provided that the following conditions are met:	8	* tion, are permitted provided that the following conditions are met:
9	*	9	*
10	* 1. Redistributions of source code must retain the above copyright notice,	10	* 1. Redistributions of source code must retain the above copyright notice,
11	* this list of conditions and the following disclaimer.	11	* this list of conditions and the following disclaimer.
12	*	12	*
13	* 2. Redistributions in binary form must reproduce the above copyright	13	* 2. Redistributions in binary form must reproduce the above copyright
14	* notice, this list of conditions and the following disclaimer in the	14	* notice, this list of conditions and the following disclaimer in the
15	* documentation and/or other materials provided with the distribution.	15	* documentation and/or other materials provided with the distribution.
16	*	16	*
17	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED	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-	18	* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MER-
19	* CHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO	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-	20	* EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPE-
21	* CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,	21	* CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
39		39
40	#ifndef EV_H_	40	#ifndef EV_H_
41	#define EV_H_	41	#define EV_H_
42		42
43	#ifdef __cplusplus	43	#ifdef __cplusplus
		44	# define EV_CPP(x) x
		45	#else
		46	# define EV_CPP(x)
		47	#endif
		48
		49	#define EV_THROW EV_CPP(throw())
		50
44	extern "C" {	51	EV_CPP(extern "C" {)
45	#endif
46		52
47	/*****************************************************************************/	53	/*****************************************************************************/
48		54
		55	/* pre-4.0 compatibility */
		56	#ifndef EV_COMPAT3
		57	# define EV_COMPAT3 1
		58	#endif
		59
49	#ifndef EV_FEATURES	60	#ifndef EV_FEATURES
		61	# if defined __OPTIMIZE_SIZE__
		62	# define EV_FEATURES 0x7c
		63	# else
50	# define EV_FEATURES 0x3f	64	# define EV_FEATURES 0x7f
		65	# endif
51	#endif	66	#endif
52		67
53	#define EV_FEATURE_CODE ((EV_FEATURES) & 1)	68	#define EV_FEATURE_CODE ((EV_FEATURES) & 1)
54	#define EV_FEATURE_DATA ((EV_FEATURES) & 2)	69	#define EV_FEATURE_DATA ((EV_FEATURES) & 2)
		70	#define EV_FEATURE_CONFIG ((EV_FEATURES) & 4)
55	#define EV_FEATURE_API ((EV_FEATURES) & 4)	71	#define EV_FEATURE_API ((EV_FEATURES) & 8)
56	#define EV_FEATURE_WATCHERS ((EV_FEATURES) & 8)	72	#define EV_FEATURE_WATCHERS ((EV_FEATURES) & 16)
57	#define EV_FEATURE_BACKENDS ((EV_FEATURES) & 16)	73	#define EV_FEATURE_BACKENDS ((EV_FEATURES) & 32)
58	#define EV_FEATURE_OS ((EV_FEATURES) & 32)	74	#define EV_FEATURE_OS ((EV_FEATURES) & 64)
59		75
60	/* these priorities are inclusive, higher priorities will be called earlier */	76	/* these priorities are inclusive, higher priorities will be invoked earlier */
61	#ifndef EV_MINPRI	77	#ifndef EV_MINPRI
62	# define EV_MINPRI (EV_FEATURE_API ? -2 : 0)	78	# define EV_MINPRI (EV_FEATURE_CONFIG ? -2 : 0)
63	#endif	79	#endif
64	#ifndef EV_MAXPRI	80	#ifndef EV_MAXPRI
65	# define EV_MAXPRI (EV_FEATURE_API ? +2 : 0)	81	# define EV_MAXPRI (EV_FEATURE_CONFIG ? +2 : 0)
66	#endif	82	#endif
67		83
68	#ifndef EV_MULTIPLICITY	84	#ifndef EV_MULTIPLICITY
69	# define EV_MULTIPLICITY EV_FEATURE_API	85	# define EV_MULTIPLICITY EV_FEATURE_CONFIG
70	#endif	86	#endif
71		87
72	#ifndef EV_PERIODIC_ENABLE	88	#ifndef EV_PERIODIC_ENABLE
73	# define EV_PERIODIC_ENABLE EV_FEATURE_WATCHERS	89	# define EV_PERIODIC_ENABLE EV_FEATURE_WATCHERS
74	#endif	90	#endif
…		…
89	# define EV_IDLE_ENABLE EV_FEATURE_WATCHERS	105	# define EV_IDLE_ENABLE EV_FEATURE_WATCHERS
90	#endif	106	#endif
91		107
92	#ifndef EV_FORK_ENABLE	108	#ifndef EV_FORK_ENABLE
93	# define EV_FORK_ENABLE EV_FEATURE_WATCHERS	109	# define EV_FORK_ENABLE EV_FEATURE_WATCHERS
		110	#endif
		111
		112	#ifndef EV_CLEANUP_ENABLE
		113	# define EV_CLEANUP_ENABLE EV_FEATURE_WATCHERS
94	#endif	114	#endif
95		115
96	#ifndef EV_SIGNAL_ENABLE	116	#ifndef EV_SIGNAL_ENABLE
97	# define EV_SIGNAL_ENABLE EV_FEATURE_WATCHERS	117	# define EV_SIGNAL_ENABLE EV_FEATURE_WATCHERS
98	#endif	118	#endif
…		…
142	#endif	162	#endif
143		163
144	/* support multiple event loops? */	164	/* support multiple event loops? */
145	#if EV_MULTIPLICITY	165	#if EV_MULTIPLICITY
146	struct ev_loop;	166	struct ev_loop;
147	# define EV_P struct ev_loop *loop	167	# define EV_P struct ev_loop loop / a loop as sole parameter in a declaration */
148	# define EV_P_ EV_P,	168	# define EV_P_ EV_P, /* a loop as first of multiple parameters */
149	# define EV_A loop	169	# define EV_A loop /* a loop as sole argument to a function call */
150	# define EV_A_ EV_A,	170	# define EV_A_ EV_A, /* a loop as first of multiple arguments */
151	# define EV_DEFAULT_UC ev_default_loop_uc ()	171	# define EV_DEFAULT_UC ev_default_loop_uc_ () /* the default loop, if initialised, as sole arg */
152	# define EV_DEFAULT_UC_ EV_DEFAULT_UC,	172	# define EV_DEFAULT_UC_ EV_DEFAULT_UC, /* the default loop as first of multiple arguments */
153	# define EV_DEFAULT ev_default_loop (0)	173	# define EV_DEFAULT ev_default_loop (0) /* the default loop as sole arg */
154	# define EV_DEFAULT_ EV_DEFAULT,	174	# define EV_DEFAULT_ EV_DEFAULT, /* the default loop as first of multiple arguments */
155	#else	175	#else
156	# define EV_P void	176	# define EV_P void
157	# define EV_P_	177	# define EV_P_
158	# define EV_A	178	# define EV_A
159	# define EV_A_	179	# define EV_A_
…		…
162	# define EV_DEFAULT_UC	182	# define EV_DEFAULT_UC
163	# define EV_DEFAULT_UC_	183	# define EV_DEFAULT_UC_
164	# undef EV_EMBED_ENABLE	184	# undef EV_EMBED_ENABLE
165	#endif	185	#endif
166		186
		187	/* EV_INLINE is used for functions in header files */
167	#if __STDC_VERSION__ >= 199901L \|\| __GNUC__ >= 3	188	#if __STDC_VERSION__ >= 199901L \|\| __GNUC__ >= 3
168	# define EV_INLINE static inline	189	# define EV_INLINE static inline
169	#else	190	#else
170	# define EV_INLINE static	191	# define EV_INLINE static
171	#endif	192	#endif
172		193
		194	#ifdef EV_API_STATIC
		195	# define EV_API_DECL static
		196	#else
		197	# define EV_API_DECL extern
		198	#endif
		199
		200	/* EV_PROTOTYPES can be used to switch of prototype declarations */
		201	#ifndef EV_PROTOTYPES
		202	# define EV_PROTOTYPES 1
		203	#endif
		204
173	/*****************************************************************************/	205	/*****************************************************************************/
174		206
		207	#define EV_VERSION_MAJOR 4
		208	#define EV_VERSION_MINOR 11
		209
175	/* eventmask, revents, events... */	210	/* eventmask, revents, events... */
176	#define EV_UNDEF -1 /* guaranteed to be invalid */	211	enum {
		212	EV_UNDEF = 0xFFFFFFFF, /* guaranteed to be invalid */
177	#define EV_NONE 0x00 /* no events */	213	EV_NONE = 0x00, /* no events */
178	#define EV_READ 0x01 /* ev_io detected read will not block */	214	EV_READ = 0x01, /* ev_io detected read will not block */
179	#define EV_WRITE 0x02 /* ev_io detected write will not block */	215	EV_WRITE = 0x02, /* ev_io detected write will not block */
180	#define EV__IOFDSET 0x80 /* internal use only */	216	EV__IOFDSET = 0x80, /* internal use only */
181	#define EV_IO EV_READ /* alias for type-detection */	217	EV_IO = EV_READ, /* alias for type-detection */
182	#define EV_TIMEOUT 0x00000100 /* timer timed out */	218	EV_TIMER = 0x00000100, /* timer timed out */
183	#define EV_TIMER EV_TIMEOUT /* alias for type-detection */	219	#if EV_COMPAT3
		220	EV_TIMEOUT = EV_TIMER, /* pre 4.0 API compatibility */
		221	#endif
184	#define EV_PERIODIC 0x00000200 /* periodic timer timed out */	222	EV_PERIODIC = 0x00000200, /* periodic timer timed out */
185	#define EV_SIGNAL 0x00000400 /* signal was received */	223	EV_SIGNAL = 0x00000400, /* signal was received */
186	#define EV_CHILD 0x00000800 /* child/pid had status change */	224	EV_CHILD = 0x00000800, /* child/pid had status change */
187	#define EV_STAT 0x00001000 /* stat data changed */	225	EV_STAT = 0x00001000, /* stat data changed */
188	#define EV_IDLE 0x00002000 /* event loop is idling */	226	EV_IDLE = 0x00002000, /* event loop is idling */
189	#define EV_PREPARE 0x00004000 /* event loop about to poll */	227	EV_PREPARE = 0x00004000, /* event loop about to poll */
190	#define EV_CHECK 0x00008000 /* event loop finished poll */	228	EV_CHECK = 0x00008000, /* event loop finished poll */
191	#define EV_EMBED 0x00010000 /* embedded event loop needs sweep */	229	EV_EMBED = 0x00010000, /* embedded event loop needs sweep */
192	#define EV_FORK 0x00020000 /* event loop resumed in child */	230	EV_FORK = 0x00020000, /* event loop resumed in child */
		231	EV_CLEANUP = 0x00040000, /* event loop resumed in child */
193	#define EV_ASYNC 0x00040000 /* async intra-loop signal */	232	EV_ASYNC = 0x00080000, /* async intra-loop signal */
194	#define EV_CUSTOM 0x01000000 /* for use by user code */	233	EV_CUSTOM = 0x01000000, /* for use by user code */
195	#define EV_ERROR 0x80000000 /* sent when an error occurs */	234	EV_ERROR = 0x80000000 /* sent when an error occurs */
		235	};
196		236
197	/* can be used to add custom fields to all watchers, while losing binary compatibility */	237	/* can be used to add custom fields to all watchers, while losing binary compatibility */
198	#ifndef EV_COMMON	238	#ifndef EV_COMMON
199	# define EV_COMMON void *data;	239	# define EV_COMMON void *data;
200	#endif	240	#endif
201	#ifndef EV_PROTOTYPES
202	# define EV_PROTOTYPES 1
203	#endif
204
205	#define EV_VERSION_MAJOR 3
206	#define EV_VERSION_MINOR 9
207		241
208	#ifndef EV_CB_DECLARE	242	#ifndef EV_CB_DECLARE
209	# define EV_CB_DECLARE(type) void (cb)(EV_P_ struct type w, int revents);	243	# define EV_CB_DECLARE(type) void (cb)(EV_P_ struct type w, int revents);
210	#endif	244	#endif
211	#ifndef EV_CB_INVOKE	245	#ifndef EV_CB_INVOKE
212	# define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents))	246	# define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents))
213	#endif	247	#endif
		248
		249	/* not official, do not use */
		250	#define EV_CB(type,name) void name (EV_P_ struct ev_ ## type *w, int revents)
214		251
215	/*	252	/*
216	* struct member types:	253	* struct member types:
217	* private: you may look at them, but not change them,	254	* private: you may look at them, but not change them,
218	* and they might not mean anything to you.	255	* and they might not mean anything to you.
…		…
229	* or the array index + 1 in the pendings array.	266	* or the array index + 1 in the pendings array.
230	*/	267	*/
231		268
232	#if EV_MINPRI == EV_MAXPRI	269	#if EV_MINPRI == EV_MAXPRI
233	# define EV_DECL_PRIORITY	270	# define EV_DECL_PRIORITY
234	#else	271	#elif !defined (EV_DECL_PRIORITY)
235	# define EV_DECL_PRIORITY int priority;	272	# define EV_DECL_PRIORITY int priority;
236	#endif	273	#endif
237		274
238	/* shared by all watchers */	275	/* shared by all watchers */
239	#define EV_WATCHER(type) \	276	#define EV_WATCHER(type) \
…		…
369	EV_WATCHER (ev_check)	406	EV_WATCHER (ev_check)
370	} ev_check;	407	} ev_check;
371		408
372	#if EV_FORK_ENABLE	409	#if EV_FORK_ENABLE
373	/* the callback gets invoked before check in the child process when a fork was detected */	410	/* the callback gets invoked before check in the child process when a fork was detected */
		411	/* revent EV_FORK */
374	typedef struct ev_fork	412	typedef struct ev_fork
375	{	413	{
376	EV_WATCHER (ev_fork)	414	EV_WATCHER (ev_fork)
377	} ev_fork;	415	} ev_fork;
		416	#endif
		417
		418	#if EV_CLEANUP_ENABLE
		419	/* is invoked just before the loop gets destroyed */
		420	/* revent EV_CLEANUP */
		421	typedef struct ev_cleanup
		422	{
		423	EV_WATCHER (ev_cleanup)
		424	} ev_cleanup;
378	#endif	425	#endif
379		426
380	#if EV_EMBED_ENABLE	427	#if EV_EMBED_ENABLE
381	/* used to embed an event loop inside another */	428	/* used to embed an event loop inside another */
382	/* the callback gets invoked when the event loop has handled events, and can be 0 */	429	/* the callback gets invoked when the event loop has handled events, and can be 0 */
…		…
390	ev_check check; /* unused */	437	ev_check check; /* unused */
391	ev_timer timer; /* unused */	438	ev_timer timer; /* unused */
392	ev_periodic periodic; /* unused */	439	ev_periodic periodic; /* unused */
393	ev_idle idle; /* unused */	440	ev_idle idle; /* unused */
394	ev_fork fork; /* private */	441	ev_fork fork; /* private */
		442	#if EV_CLEANUP_ENABLE
		443	ev_cleanup cleanup; /* unused */
		444	#endif
395	} ev_embed;	445	} ev_embed;
396	#endif	446	#endif
397		447
398	#if EV_ASYNC_ENABLE	448	#if EV_ASYNC_ENABLE
399	/* invoked when somebody calls ev_async_send on the watcher */	449	/* invoked when somebody calls ev_async_send on the watcher */
…		…
428	struct ev_prepare prepare;	478	struct ev_prepare prepare;
429	struct ev_check check;	479	struct ev_check check;
430	#if EV_FORK_ENABLE	480	#if EV_FORK_ENABLE
431	struct ev_fork fork;	481	struct ev_fork fork;
432	#endif	482	#endif
		483	#if EV_CLEANUP_ENABLE
		484	struct ev_cleanup cleanup;
		485	#endif
433	#if EV_EMBED_ENABLE	486	#if EV_EMBED_ENABLE
434	struct ev_embed embed;	487	struct ev_embed embed;
435	#endif	488	#endif
436	#if EV_ASYNC_ENABLE	489	#if EV_ASYNC_ENABLE
437	struct ev_async async;	490	struct ev_async async;
438	#endif	491	#endif
439	};	492	};
440		493
441	/* bits for ev_default_loop and ev_loop_new */	494	/* flag bits for ev_default_loop and ev_loop_new */
		495	enum {
442	/* the default */	496	/* the default */
443	#define EVFLAG_AUTO 0x00000000U /* not quite a mask */	497	EVFLAG_AUTO = 0x00000000U, /* not quite a mask */
444	/* flag bits */	498	/* flag bits */
445	#define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */	499	EVFLAG_NOENV = 0x01000000U, /* do NOT consult environment */
446	#define EVFLAG_FORKCHECK 0x02000000U /* check for a fork in each iteration */	500	EVFLAG_FORKCHECK = 0x02000000U, /* check for a fork in each iteration */
447	/* debugging/feature disable */	501	/* debugging/feature disable */
448	#define EVFLAG_NOINOTIFY 0x00100000U /* do not attempt to use inotify */	502	EVFLAG_NOINOTIFY = 0x00100000U, /* do not attempt to use inotify */
		503	#if EV_COMPAT3
449	#define EVFLAG_NOSIGFD 0 /* compatibility to pre-3.9 */	504	EVFLAG_NOSIGFD = 0, /* compatibility to pre-3.9 */
		505	#endif
450	#define EVFLAG_SIGNALFD 0x00200000U /* attempt to use signalfd */	506	EVFLAG_SIGNALFD = 0x00200000U, /* attempt to use signalfd */
		507	EVFLAG_NOSIGMASK = 0x00400000U /* avoid modifying the signal mask */
		508	};
		509
451	/* method bits to be ored together */	510	/* method bits to be ored together */
		511	enum {
452	#define EVBACKEND_SELECT 0x00000001U /* about anywhere */	512	EVBACKEND_SELECT = 0x00000001U, /* about anywhere */
453	#define EVBACKEND_POLL 0x00000002U /* !win */	513	EVBACKEND_POLL = 0x00000002U, /* !win */
454	#define EVBACKEND_EPOLL 0x00000004U /* linux */	514	EVBACKEND_EPOLL = 0x00000004U, /* linux */
455	#define EVBACKEND_KQUEUE 0x00000008U /* bsd */	515	EVBACKEND_KQUEUE = 0x00000008U, /* bsd */
456	#define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 / / NYI */	516	EVBACKEND_DEVPOLL = 0x00000010U, /* solaris 8 / / NYI */
457	#define EVBACKEND_PORT 0x00000020U /* solaris 10 */	517	EVBACKEND_PORT = 0x00000020U, /* solaris 10 */
458	#define EVBACKEND_ALL 0x0000003FU	518	EVBACKEND_ALL = 0x0000003FU, /* all known backends */
		519	EVBACKEND_MASK = 0x0000FFFFU /* all future backends */
		520	};
459		521
460	#if EV_PROTOTYPES	522	#if EV_PROTOTYPES
461	int ev_version_major (void);	523	EV_API_DECL int ev_version_major (void) EV_THROW;
462	int ev_version_minor (void);	524	EV_API_DECL int ev_version_minor (void) EV_THROW;
463		525
464	unsigned int ev_supported_backends (void);	526	EV_API_DECL unsigned int ev_supported_backends (void) EV_THROW;
465	unsigned int ev_recommended_backends (void);	527	EV_API_DECL unsigned int ev_recommended_backends (void) EV_THROW;
466	unsigned int ev_embeddable_backends (void);	528	EV_API_DECL unsigned int ev_embeddable_backends (void) EV_THROW;
467		529
468	ev_tstamp ev_time (void);	530	EV_API_DECL ev_tstamp ev_time (void) EV_THROW;
469	void ev_sleep (ev_tstamp delay); /* sleep for a while */	531	EV_API_DECL void ev_sleep (ev_tstamp delay) EV_THROW; /* sleep for a while */
470		532
471	/* Sets the allocation function to use, works like realloc.	533	/* Sets the allocation function to use, works like realloc.
472	* It is used to allocate and free memory.	534	* It is used to allocate and free memory.
473	* If it returns zero when memory needs to be allocated, the library might abort	535	* If it returns zero when memory needs to be allocated, the library might abort
474	* or take some potentially destructive action.	536	* or take some potentially destructive action.
475	* The default is your system realloc function.	537	* The default is your system realloc function.
476	*/	538	*/
477	void ev_set_allocator (void (cb)(void *ptr, long size));	539	EV_API_DECL void ev_set_allocator (void (cb)(void *ptr, long size) EV_THROW) EV_THROW;
478		540
479	/* set the callback function to call on a	541	/* set the callback function to call on a
480	* retryable syscall error	542	* retryable syscall error
481	* (such as failed select, poll, epoll_wait)	543	* (such as failed select, poll, epoll_wait)
482	*/	544	*/
483	void ev_set_syserr_cb (void (cb)(const char msg));	545	EV_API_DECL void ev_set_syserr_cb (void (cb)(const char msg) EV_THROW) EV_THROW;
484		546
485	#if EV_MULTIPLICITY	547	#if EV_MULTIPLICITY
		548
		549	/* the default loop is the only one that handles signals and child watchers */
		550	/* you can call this as often as you like */
		551	EV_API_DECL struct ev_loop *ev_default_loop (unsigned int flags EV_CPP (= 0)) EV_THROW;
		552
		553	#ifdef EV_API_STATIC
		554	EV_API_DECL struct ev_loop *ev_default_loop_ptr;
		555	#endif
		556
486	EV_INLINE struct ev_loop *	557	EV_INLINE struct ev_loop *
487	ev_default_loop_uc (void)	558	ev_default_loop_uc_ (void) EV_THROW
488	{	559	{
489	extern struct ev_loop *ev_default_loop_ptr;	560	extern struct ev_loop *ev_default_loop_ptr;
490		561
491	return ev_default_loop_ptr;	562	return ev_default_loop_ptr;
492	}	563	}
493		564
494	/* the default loop is the only one that handles signals and child watchers */	565	EV_INLINE int
495	/* you can call this as often as you like */	566	ev_is_default_loop (EV_P) EV_THROW
496	EV_INLINE struct ev_loop *
497	ev_default_loop (unsigned int flags)
498	{	567	{
499	struct ev_loop *loop = ev_default_loop_uc ();	568	return EV_A == EV_DEFAULT_UC;
500
501	if (!loop)
502	{
503	extern struct ev_loop *ev_default_loop_init (unsigned int flags);
504
505	loop = ev_default_loop_init (flags);
506	}
507
508	return loop;
509	}	569	}
510		570
511	/* create and destroy alternative loops that don't handle signals */	571	/* create and destroy alternative loops that don't handle signals */
512	struct ev_loop *ev_loop_new (unsigned int flags);	572	EV_API_DECL struct ev_loop *ev_loop_new (unsigned int flags EV_CPP (= 0)) EV_THROW;
513	void ev_loop_destroy (EV_P);
514	void ev_loop_fork (EV_P);
515		573
516	ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */	574	EV_API_DECL ev_tstamp ev_now (EV_P) EV_THROW; /* time w.r.t. timers and the eventloop, updated after each poll */
517		575
518	#else	576	#else
519		577
520	int ev_default_loop (unsigned int flags); /* returns true when successful */	578	EV_API_DECL int ev_default_loop (unsigned int flags EV_CPP (= 0)) EV_THROW; /* returns true when successful */
		579
		580	EV_API_DECL ev_tstamp ev_rt_now;
521		581
522	EV_INLINE ev_tstamp	582	EV_INLINE ev_tstamp
523	ev_now (void)	583	ev_now (void) EV_THROW
524	{	584	{
525	extern ev_tstamp ev_rt_now;
526
527	return ev_rt_now;	585	return ev_rt_now;
528	}	586	}
		587
		588	/* looks weird, but ev_is_default_loop (EV_A) still works if this exists */
		589	EV_INLINE int
		590	ev_is_default_loop (void) EV_THROW
		591	{
		592	return 1;
		593	}
		594
529	#endif /* multiplicity */	595	#endif /* multiplicity */
530		596
531	EV_INLINE int	597	/* destroy event loops, also works for the default loop */
532	ev_is_default_loop (EV_P)	598	EV_API_DECL void ev_loop_destroy (EV_P) EV_THROW;
533	{
534	#if EV_MULTIPLICITY
535	extern struct ev_loop *ev_default_loop_ptr;
536		599
537	return !!(EV_A == ev_default_loop_ptr);
538	#else
539	return 1;
540	#endif
541	}
542
543	void ev_default_destroy (void); /* destroy the default loop */
544	/* this needs to be called after fork, to duplicate the default loop */	600	/* this needs to be called after fork, to duplicate the loop */
545	/* if you create alternative loops you have to call ev_loop_fork on them */	601	/* when you want to re-use it in the child */
546	/* you can call it in either the parent or the child */	602	/* you can call it in either the parent or the child */
547	/* you can actually call it at any time, anywhere :) */	603	/* you can actually call it at any time, anywhere :) */
548	void ev_default_fork (void);	604	EV_API_DECL void ev_loop_fork (EV_P) EV_THROW;
549		605
550	unsigned int ev_backend (EV_P); /* backend in use by loop */	606	EV_API_DECL unsigned int ev_backend (EV_P) EV_THROW; /* backend in use by loop */
551		607
552	void ev_now_update (EV_P); /* update event loop time */	608	EV_API_DECL void ev_now_update (EV_P) EV_THROW; /* update event loop time */
553		609
554	#if EV_WALK_ENABLE	610	#if EV_WALK_ENABLE
555	/* walk (almost) all watchers in the loop of a given type, invoking the */	611	/* walk (almost) all watchers in the loop of a given type, invoking the */
556	/* callback on every such watcher. The callback might stop the watcher, */	612	/* callback on every such watcher. The callback might stop the watcher, */
557	/* but do nothing else with the loop */	613	/* but do nothing else with the loop */
558	void ev_walk (EV_P_ int types, void (cb)(EV_P_ int type, void w));	614	EV_API_DECL void ev_walk (EV_P_ int types, void (cb)(EV_P_ int type, void w)) EV_THROW;
559	#endif	615	#endif
560		616
561	#endif /* prototypes */	617	#endif /* prototypes */
562		618
563	#define EVLOOP_NONBLOCK 1 /* do not block/wait */	619	/* ev_run flags values */
564	#define EVLOOP_ONESHOT 2 /* block once only */	620	enum {
565	#define EVUNLOOP_CANCEL 0 /* undo unloop */	621	EVRUN_NOWAIT = 1, /* do not block/wait */
566	#define EVUNLOOP_ONE 1 /* unloop once */	622	EVRUN_ONCE = 2 /* block once only */
		623	};
		624
		625	/* ev_break how values */
		626	enum {
		627	EVBREAK_CANCEL = 0, /* undo unloop */
		628	EVBREAK_ONE = 1, /* unloop once */
567	#define EVUNLOOP_ALL 2 /* unloop all loops */	629	EVBREAK_ALL = 2 /* unloop all loops */
		630	};
568		631
569	#if EV_PROTOTYPES	632	#if EV_PROTOTYPES
570	void ev_loop (EV_P_ int flags);	633	EV_API_DECL int ev_run (EV_P_ int flags EV_CPP (= 0));
571	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 */	634	EV_API_DECL void ev_break (EV_P_ int how EV_CPP (= EVBREAK_ONE)) EV_THROW; /* break out of the loop */
572		635
573	/*	636	/*
574	* ref/unref can be used to add or remove a refcount on the mainloop. every watcher	637	* ref/unref can be used to add or remove a refcount on the mainloop. every watcher
575	* keeps one reference. if you have a long-running watcher you never unregister that	638	* keeps one reference. if you have a long-running watcher you never unregister that
576	* should not keep ev_loop from running, unref() after starting, and ref() before stopping.	639	* should not keep ev_loop from running, unref() after starting, and ref() before stopping.
577	*/	640	*/
578	void ev_ref (EV_P);	641	EV_API_DECL void ev_ref (EV_P) EV_THROW;
579	void ev_unref (EV_P);	642	EV_API_DECL void ev_unref (EV_P) EV_THROW;
580		643
581	/*	644	/*
582	* convenience function, wait for a single event, without registering an event watcher	645	* convenience function, wait for a single event, without registering an event watcher
583	* if timeout is < 0, do wait indefinitely	646	* if timeout is < 0, do wait indefinitely
584	*/	647	*/
585	void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (cb)(int revents, void arg), void *arg);	648	EV_API_DECL void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (cb)(int revents, void arg), void *arg) EV_THROW;
586		649
587	# if EV_FEATURE_API	650	# if EV_FEATURE_API
588	unsigned int ev_loop_count (EV_P); /* number of loop iterations */	651	EV_API_DECL unsigned int ev_iteration (EV_P) EV_THROW; /* number of loop iterations */
589	unsigned int ev_loop_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */	652	EV_API_DECL unsigned int ev_depth (EV_P) EV_THROW; /* #ev_loop enters - #ev_loop leaves */
590	void ev_loop_verify (EV_P); /* abort if loop data corrupted */	653	EV_API_DECL void ev_verify (EV_P) EV_THROW; /* abort if loop data corrupted */
591		654
592	void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */	655	EV_API_DECL void ev_set_io_collect_interval (EV_P_ ev_tstamp interval) EV_THROW; /* sleep at least this time, default 0 */
593	void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */	656	EV_API_DECL void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval) EV_THROW; /* sleep at least this time, default 0 */
594		657
595	/* advanced stuff for threading etc. support, see docs */	658	/* advanced stuff for threading etc. support, see docs */
596	void ev_set_userdata (EV_P_ void *data);	659	EV_API_DECL void ev_set_userdata (EV_P_ void *data) EV_THROW;
597	void *ev_userdata (EV_P);	660	EV_API_DECL void *ev_userdata (EV_P) EV_THROW;
598	void ev_set_invoke_pending_cb (EV_P_ void (*invoke_pending_cb)(EV_P));	661	EV_API_DECL void ev_set_invoke_pending_cb (EV_P_ void (*invoke_pending_cb)(EV_P)) EV_THROW;
599	void ev_set_loop_release_cb (EV_P_ void (release)(EV_P), void (acquire)(EV_P));	662	EV_API_DECL void ev_set_loop_release_cb (EV_P_ void (release)(EV_P), void (acquire)(EV_P)) EV_THROW;
600		663
601	unsigned int ev_pending_count (EV_P); /* number of pending events, if any */	664	EV_API_DECL unsigned int ev_pending_count (EV_P) EV_THROW; /* number of pending events, if any */
602	void ev_invoke_pending (EV_P); /* invoke all pending watchers */	665	EV_API_DECL void ev_invoke_pending (EV_P); /* invoke all pending watchers */
603		666
604	/*	667	/*
605	* stop/start the timer handling.	668	* stop/start the timer handling.
606	*/	669	*/
607	void ev_suspend (EV_P);	670	EV_API_DECL void ev_suspend (EV_P) EV_THROW;
608	void ev_resume (EV_P);	671	EV_API_DECL void ev_resume (EV_P) EV_THROW;
609	#endif	672	#endif
610		673
611	#endif	674	#endif
612		675
613	/* these may evaluate ev multiple times, and the other arguments at most once */	676	/* these may evaluate ev multiple times, and the other arguments at most once */
…		…
628	#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */	691	#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
629	#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */	692	#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
630	#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */	693	#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
631	#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0)	694	#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0)
632	#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */	695	#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */
633	#define ev_async_set(ev) do { (ev)->sent = 0; } while (0)	696	#define ev_cleanup_set(ev) /* nop, yes, this is a serious in-joke */
		697	#define ev_async_set(ev) /* nop, yes, this is a serious in-joke */
634		698
635	#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)	699	#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
636	#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)	700	#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
637	#define ev_periodic_init(ev,cb,ofs,ival,rcb) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(ofs),(ival),(rcb)); } while (0)	701	#define ev_periodic_init(ev,cb,ofs,ival,rcb) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(ofs),(ival),(rcb)); } while (0)
638	#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)	702	#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
…		…
641	#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)	705	#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
642	#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)	706	#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
643	#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)	707	#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
644	#define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0)	708	#define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0)
645	#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0)	709	#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0)
		710	#define ev_cleanup_init(ev,cb) do { ev_init ((ev), (cb)); ev_cleanup_set ((ev)); } while (0)
646	#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0)	711	#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0)
647		712
648	#define ev_is_pending(ev) (0 + ((ev_watcher )(void )(ev))->pending) /* ro, true when watcher is waiting for callback invocation */	713	#define ev_is_pending(ev) (0 + ((ev_watcher )(void )(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
649	#define ev_is_active(ev) (0 + ((ev_watcher )(void )(ev))->active) /* ro, true when the watcher has been started */	714	#define ev_is_active(ev) (0 + ((ev_watcher )(void )(ev))->active) /* ro, true when the watcher has been started */
650		715
…		…
666		731
667	/* stopping (enabling, adding) a watcher does nothing if it is already running */	732	/* stopping (enabling, adding) a watcher does nothing if it is already running */
668	/* stopping (disabling, deleting) a watcher does nothing unless its already running */	733	/* stopping (disabling, deleting) a watcher does nothing unless its already running */
669	#if EV_PROTOTYPES	734	#if EV_PROTOTYPES
670		735
671	/* feeds an event into a watcher as if the event actually occured */	736	/* feeds an event into a watcher as if the event actually occurred */
672	/* accepts any ev_watcher type */	737	/* accepts any ev_watcher type */
673	void ev_feed_event (EV_P_ void *w, int revents);	738	EV_API_DECL void ev_feed_event (EV_P_ void *w, int revents) EV_THROW;
674	void ev_feed_fd_event (EV_P_ int fd, int revents);	739	EV_API_DECL void ev_feed_fd_event (EV_P_ int fd, int revents) EV_THROW;
675	#if EV_SIGNAL_ENABLE	740	#if EV_SIGNAL_ENABLE
		741	EV_API_DECL void ev_feed_signal (int signum) EV_THROW;
676	void ev_feed_signal_event (EV_P_ int signum);	742	EV_API_DECL void ev_feed_signal_event (EV_P_ int signum) EV_THROW;
677	#endif	743	#endif
678	void ev_invoke (EV_P_ void *w, int revents);	744	EV_API_DECL void ev_invoke (EV_P_ void *w, int revents);
679	int ev_clear_pending (EV_P_ void *w);	745	EV_API_DECL int ev_clear_pending (EV_P_ void *w) EV_THROW;
680		746
681	void ev_io_start (EV_P_ ev_io *w);	747	EV_API_DECL void ev_io_start (EV_P_ ev_io *w) EV_THROW;
682	void ev_io_stop (EV_P_ ev_io *w);	748	EV_API_DECL void ev_io_stop (EV_P_ ev_io *w) EV_THROW;
683		749
684	void ev_timer_start (EV_P_ ev_timer *w);	750	EV_API_DECL void ev_timer_start (EV_P_ ev_timer *w) EV_THROW;
685	void ev_timer_stop (EV_P_ ev_timer *w);	751	EV_API_DECL void ev_timer_stop (EV_P_ ev_timer *w) EV_THROW;
686	/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */	752	/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
687	void ev_timer_again (EV_P_ ev_timer *w);	753	EV_API_DECL void ev_timer_again (EV_P_ ev_timer *w) EV_THROW;
688	/* return remaining time */	754	/* return remaining time */
689	ev_tstamp ev_timer_remaining (EV_P_ ev_timer *w);	755	EV_API_DECL ev_tstamp ev_timer_remaining (EV_P_ ev_timer *w) EV_THROW;
690		756
691	#if EV_PERIODIC_ENABLE	757	#if EV_PERIODIC_ENABLE
692	void ev_periodic_start (EV_P_ ev_periodic *w);	758	EV_API_DECL void ev_periodic_start (EV_P_ ev_periodic *w) EV_THROW;
693	void ev_periodic_stop (EV_P_ ev_periodic *w);	759	EV_API_DECL void ev_periodic_stop (EV_P_ ev_periodic *w) EV_THROW;
694	void ev_periodic_again (EV_P_ ev_periodic *w);	760	EV_API_DECL void ev_periodic_again (EV_P_ ev_periodic *w) EV_THROW;
695	#endif	761	#endif
696		762
697	/* only supported in the default loop */	763	/* only supported in the default loop */
698	#if EV_SIGNAL_ENABLE	764	#if EV_SIGNAL_ENABLE
699	void ev_signal_start (EV_P_ ev_signal *w);	765	EV_API_DECL void ev_signal_start (EV_P_ ev_signal *w) EV_THROW;
700	void ev_signal_stop (EV_P_ ev_signal *w);	766	EV_API_DECL void ev_signal_stop (EV_P_ ev_signal *w) EV_THROW;
701	#endif	767	#endif
702		768
703	/* only supported in the default loop */	769	/* only supported in the default loop */
704	# if EV_CHILD_ENABLE	770	# if EV_CHILD_ENABLE
705	void ev_child_start (EV_P_ ev_child *w);	771	EV_API_DECL void ev_child_start (EV_P_ ev_child *w) EV_THROW;
706	void ev_child_stop (EV_P_ ev_child *w);	772	EV_API_DECL void ev_child_stop (EV_P_ ev_child *w) EV_THROW;
707	# endif	773	# endif
708		774
709	# if EV_STAT_ENABLE	775	# if EV_STAT_ENABLE
710	void ev_stat_start (EV_P_ ev_stat *w);	776	EV_API_DECL void ev_stat_start (EV_P_ ev_stat *w) EV_THROW;
711	void ev_stat_stop (EV_P_ ev_stat *w);	777	EV_API_DECL void ev_stat_stop (EV_P_ ev_stat *w) EV_THROW;
712	void ev_stat_stat (EV_P_ ev_stat *w);	778	EV_API_DECL void ev_stat_stat (EV_P_ ev_stat *w) EV_THROW;
713	# endif	779	# endif
714		780
715	# if EV_IDLE_ENABLE	781	# if EV_IDLE_ENABLE
716	void ev_idle_start (EV_P_ ev_idle *w);	782	EV_API_DECL void ev_idle_start (EV_P_ ev_idle *w) EV_THROW;
717	void ev_idle_stop (EV_P_ ev_idle *w);	783	EV_API_DECL void ev_idle_stop (EV_P_ ev_idle *w) EV_THROW;
718	# endif	784	# endif
719		785
720	#if EV_PREPARE_ENABLE	786	#if EV_PREPARE_ENABLE
721	void ev_prepare_start (EV_P_ ev_prepare *w);	787	EV_API_DECL void ev_prepare_start (EV_P_ ev_prepare *w) EV_THROW;
722	void ev_prepare_stop (EV_P_ ev_prepare *w);	788	EV_API_DECL void ev_prepare_stop (EV_P_ ev_prepare *w) EV_THROW;
723	#endif	789	#endif
724		790
725	#if EV_CHECK_ENABLE	791	#if EV_CHECK_ENABLE
726	void ev_check_start (EV_P_ ev_check *w);	792	EV_API_DECL void ev_check_start (EV_P_ ev_check *w) EV_THROW;
727	void ev_check_stop (EV_P_ ev_check *w);	793	EV_API_DECL void ev_check_stop (EV_P_ ev_check *w) EV_THROW;
728	#endif	794	#endif
729		795
730	# if EV_FORK_ENABLE	796	# if EV_FORK_ENABLE
731	void ev_fork_start (EV_P_ ev_fork *w);	797	EV_API_DECL void ev_fork_start (EV_P_ ev_fork *w) EV_THROW;
732	void ev_fork_stop (EV_P_ ev_fork *w);	798	EV_API_DECL void ev_fork_stop (EV_P_ ev_fork *w) EV_THROW;
		799	# endif
		800
		801	# if EV_CLEANUP_ENABLE
		802	EV_API_DECL void ev_cleanup_start (EV_P_ ev_cleanup *w) EV_THROW;
		803	EV_API_DECL void ev_cleanup_stop (EV_P_ ev_cleanup *w) EV_THROW;
733	# endif	804	# endif
734		805
735	# if EV_EMBED_ENABLE	806	# if EV_EMBED_ENABLE
736	/* only supported when loop to be embedded is in fact embeddable */	807	/* only supported when loop to be embedded is in fact embeddable */
737	void ev_embed_start (EV_P_ ev_embed *w);	808	EV_API_DECL void ev_embed_start (EV_P_ ev_embed *w) EV_THROW;
738	void ev_embed_stop (EV_P_ ev_embed *w);	809	EV_API_DECL void ev_embed_stop (EV_P_ ev_embed *w) EV_THROW;
739	void ev_embed_sweep (EV_P_ ev_embed *w);	810	EV_API_DECL void ev_embed_sweep (EV_P_ ev_embed *w) EV_THROW;
740	# endif	811	# endif
741		812
742	# if EV_ASYNC_ENABLE	813	# if EV_ASYNC_ENABLE
743	void ev_async_start (EV_P_ ev_async *w);	814	EV_API_DECL void ev_async_start (EV_P_ ev_async *w) EV_THROW;
744	void ev_async_stop (EV_P_ ev_async *w);	815	EV_API_DECL void ev_async_stop (EV_P_ ev_async *w) EV_THROW;
745	void ev_async_send (EV_P_ ev_async *w);	816	EV_API_DECL void ev_async_send (EV_P_ ev_async *w) EV_THROW;
746	# endif
747
748	#endif	817	# endif
749		818
750	#ifdef __cplusplus	819	#if EV_COMPAT3
751	}	820	#define EVLOOP_NONBLOCK EVRUN_NOWAIT
		821	#define EVLOOP_ONESHOT EVRUN_ONCE
		822	#define EVUNLOOP_CANCEL EVBREAK_CANCEL
		823	#define EVUNLOOP_ONE EVBREAK_ONE
		824	#define EVUNLOOP_ALL EVBREAK_ALL
		825	#if EV_PROTOTYPES
		826	EV_INLINE void ev_loop (EV_P_ int flags) { ev_run (EV_A_ flags); }
		827	EV_INLINE void ev_unloop (EV_P_ int how ) { ev_break (EV_A_ how ); }
		828	EV_INLINE void ev_default_destroy (void) { ev_loop_destroy (EV_DEFAULT); }
		829	EV_INLINE void ev_default_fork (void) { ev_loop_fork (EV_DEFAULT); }
		830	#if EV_FEATURE_API
		831	EV_INLINE unsigned int ev_loop_count (EV_P) { return ev_iteration (EV_A); }
		832	EV_INLINE unsigned int ev_loop_depth (EV_P) { return ev_depth (EV_A); }
		833	EV_INLINE void ev_loop_verify (EV_P) { ev_verify (EV_A); }
		834	#endif
752	#endif	835	#endif
753		836	#else
		837	typedef struct ev_loop ev_loop;
754	#endif	838	#endif
755		839
		840	#endif
		841
		842	EV_CPP(})
		843
		844	#endif
		845

Diff Legend

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

Comparing libev/ev.h (file contents): Revision 1.135 by root, Tue Mar 16 00:26:41 2010 UTC vs. Revision 1.167 by root, Wed Apr 18 05:44:42 2012 UTC

Diff Legend

Comparing libev/ev.h (file contents):
Revision 1.135 by root, Tue Mar 16 00:26:41 2010 UTC vs.
Revision 1.167 by root, Wed Apr 18 05:44:42 2012 UTC