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

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

Diff Legend

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

Comparing libev/ev.h (file contents): Revision 1.138 by root, Tue Mar 16 20:32:20 2010 UTC vs. Revision 1.176 by root, Tue Sep 9 13:28:21 2014 UTC

Diff Legend

Comparing libev/ev.h (file contents):
Revision 1.138 by root, Tue Mar 16 20:32:20 2010 UTC vs.
Revision 1.176 by root, Tue Sep 9 13:28:21 2014 UTC