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

Comparing libev/ev.h (file contents):
Revision 1.117 by root, Wed Jul 8 04:29:31 2009 UTC vs.
Revision 1.134 by root, Tue Mar 16 00:20:17 2010 UTC

…		…
1	/*	1	/*
2	* libev native API header	2	* libev native API header
3	*	3	*
4	* Copyright (c) 2007,2008,2009 Marc Alexander Lehmann <libev@schmorp.de>	4	* Copyright (c) 2007,2008,2009,2010 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	*
35	* and other provisions required by the GPL. If you do not delete the	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	36	* provisions above, a recipient may use your version of this file under
37	* either the BSD or the GPL.	37	* either the BSD or the GPL.
38	*/	38	*/
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	extern "C" {	44	extern "C" {
45	#endif	45	#endif
46		46
47	typedef double ev_tstamp;	47	/*****************************************************************************/
		48
		49	#ifndef EV_FEATURES
		50	# define EV_FEATURES 0x3f
		51	#endif
		52
		53	#define EV_FEATURE_CODE ((EV_FEATURES) & 1)
		54	#define EV_FEATURE_DATA ((EV_FEATURES) & 2)
		55	#define EV_FEATURE_API ((EV_FEATURES) & 4)
		56	#define EV_FEATURE_WATCHERS ((EV_FEATURES) & 8)
		57	#define EV_FEATURE_BACKENDS ((EV_FEATURES) & 16)
		58	#define EV_FEATURE_OS ((EV_FEATURES) & 32)
48		59
49	/* these priorities are inclusive, higher priorities will be called earlier */	60	/* these priorities are inclusive, higher priorities will be called earlier */
50	#ifndef EV_MINPRI	61	#ifndef EV_MINPRI
51	# define EV_MINPRI -2	62	# define EV_MINPRI (EV_FEATURE_API ? -2 : 0)
52	#endif	63	#endif
53	#ifndef EV_MAXPRI	64	#ifndef EV_MAXPRI
54	# define EV_MAXPRI +2	65	# define EV_MAXPRI (EV_FEATURE_API ? +2 : 0)
55	#endif	66	#endif
56		67
57	#ifndef EV_MULTIPLICITY	68	#ifndef EV_MULTIPLICITY
58	# define EV_MULTIPLICITY 1	69	# define EV_MULTIPLICITY EV_FEATURE_API
59	#endif	70	#endif
60		71
61	#ifndef EV_PERIODIC_ENABLE	72	#ifndef EV_PERIODIC_ENABLE
62	# define EV_PERIODIC_ENABLE 1	73	# define EV_PERIODIC_ENABLE EV_FEATURE_WATCHERS
63	#endif	74	#endif
64		75
65	#ifndef EV_STAT_ENABLE	76	#ifndef EV_STAT_ENABLE
66	# define EV_STAT_ENABLE 1	77	# define EV_STAT_ENABLE EV_FEATURE_WATCHERS
		78	#endif
		79
		80	#ifndef EV_PREPARE_ENABLE
		81	# define EV_PREPARE_ENABLE EV_FEATURE_WATCHERS
		82	#endif
		83
		84	#ifndef EV_CHECK_ENABLE
		85	# define EV_CHECK_ENABLE EV_FEATURE_WATCHERS
67	#endif	86	#endif
68		87
69	#ifndef EV_IDLE_ENABLE	88	#ifndef EV_IDLE_ENABLE
70	# define EV_IDLE_ENABLE 1	89	# define EV_IDLE_ENABLE EV_FEATURE_WATCHERS
71	#endif	90	#endif
72		91
73	#ifndef EV_FORK_ENABLE	92	#ifndef EV_FORK_ENABLE
		93	# define EV_FORK_ENABLE EV_FEATURE_WATCHERS
		94	#endif
		95
		96	#ifndef EV_SIGNAL_ENABLE
		97	# define EV_SIGNAL_ENABLE EV_FEATURE_WATCHERS
		98	#endif
		99
		100	#ifndef EV_CHILD_ENABLE
		101	# ifdef _WIN32
74	# define EV_FORK_ENABLE 1	102	# define EV_CHILD_ENABLE 0
		103	# else
		104	# define EV_CHILD_ENABLE EV_FEATURE_WATCHERS
		105	#endif
		106	#endif
		107
		108	#ifndef EV_ASYNC_ENABLE
		109	# define EV_ASYNC_ENABLE EV_FEATURE_WATCHERS
75	#endif	110	#endif
76		111
77	#ifndef EV_EMBED_ENABLE	112	#ifndef EV_EMBED_ENABLE
78	# define EV_EMBED_ENABLE 1	113	# define EV_EMBED_ENABLE EV_FEATURE_WATCHERS
79	#endif
80
81	#ifndef EV_ASYNC_ENABLE
82	# define EV_ASYNC_ENABLE 1
83	#endif	114	#endif
84		115
85	#ifndef EV_WALK_ENABLE	116	#ifndef EV_WALK_ENABLE
86	# define EV_WALK_ENABLE 0 /* not yet */	117	# define EV_WALK_ENABLE 0 /* not yet */
87	#endif	118	#endif
		119
		120	/*****************************************************************************/
		121
		122	#if EV_CHILD_ENABLE && !EV_SIGNAL_ENABLE
		123	# undef EV_SIGNAL_ENABLE
		124	# define EV_SIGNAL_ENABLE 1
		125	#endif
		126
		127	/*****************************************************************************/
		128
		129	#if !EV_FEATURE_CODE && !defined (NDEBUG)
		130	# define NDEBUG 1
		131	# include <assert.h>
		132	#endif
		133
		134	typedef double ev_tstamp;
88		135
89	#ifndef EV_ATOMIC_T	136	#ifndef EV_ATOMIC_T
90	# include <signal.h>	137	# include <signal.h>
91	# define EV_ATOMIC_T sig_atomic_t volatile	138	# define EV_ATOMIC_T sig_atomic_t volatile
92	#endif	139	#endif
93
94	/*****************************************************************************/
95		140
96	#if EV_STAT_ENABLE	141	#if EV_STAT_ENABLE
97	# ifdef _WIN32	142	# ifdef _WIN32
98	# include <time.h>	143	# include <time.h>
99	# include <sys/types.h>	144	# include <sys/types.h>
…		…
161	#ifndef EV_PROTOTYPES	206	#ifndef EV_PROTOTYPES
162	# define EV_PROTOTYPES 1	207	# define EV_PROTOTYPES 1
163	#endif	208	#endif
164		209
165	#define EV_VERSION_MAJOR 3	210	#define EV_VERSION_MAJOR 3
166	#define EV_VERSION_MINOR 0	211	#define EV_VERSION_MINOR 9
167		212
168	#ifndef EV_CB_DECLARE	213	#ifndef EV_CB_DECLARE
169	# define EV_CB_DECLARE(type) void (cb)(EV_P_ struct type w, int revents);	214	# define EV_CB_DECLARE(type) void (cb)(EV_P_ struct type w, int revents);
170	#endif	215	#endif
171	#ifndef EV_CB_INVOKE	216	#ifndef EV_CB_INVOKE
…		…
363	EV_WATCHER (ev_async)	408	EV_WATCHER (ev_async)
364		409
365	EV_ATOMIC_T sent; /* private */	410	EV_ATOMIC_T sent; /* private */
366	} ev_async;	411	} ev_async;
367		412
368	# define ev_async_pending(w) ((w)->sent + 0)	413	# define ev_async_pending(w) (+(w)->sent)
369	#endif	414	#endif
370		415
371	/* the presence of this union forces similar struct layout */	416	/* the presence of this union forces similar struct layout */
372	union ev_any_watcher	417	union ev_any_watcher
373	{	418	{
…		…
402	/* the default */	447	/* the default */
403	#define EVFLAG_AUTO 0x00000000U /* not quite a mask */	448	#define EVFLAG_AUTO 0x00000000U /* not quite a mask */
404	/* flag bits */	449	/* flag bits */
405	#define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */	450	#define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */
406	#define EVFLAG_FORKCHECK 0x02000000U /* check for a fork in each iteration */	451	#define EVFLAG_FORKCHECK 0x02000000U /* check for a fork in each iteration */
		452	/* debugging/feature disable */
		453	#define EVFLAG_NOINOTIFY 0x00100000U /* do not attempt to use inotify */
		454	#define EVFLAG_NOSIGFD 0 /* compatibility to pre-3.9 */
		455	#define EVFLAG_SIGNALFD 0x00200000U /* attempt to use signalfd */
407	/* method bits to be ored together */	456	/* method bits to be ored together */
408	#define EVBACKEND_SELECT 0x00000001U /* about anywhere */	457	#define EVBACKEND_SELECT 0x00000001U /* about anywhere */
409	#define EVBACKEND_POLL 0x00000002U /* !win */	458	#define EVBACKEND_POLL 0x00000002U /* !win */
410	#define EVBACKEND_EPOLL 0x00000004U /* linux */	459	#define EVBACKEND_EPOLL 0x00000004U /* linux */
411	#define EVBACKEND_KQUEUE 0x00000008U /* bsd */	460	#define EVBACKEND_KQUEUE 0x00000008U /* bsd */
412	#define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 / / NYI */	461	#define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 / / NYI */
413	#define EVBACKEND_PORT 0x00000020U /* solaris 10 */	462	#define EVBACKEND_PORT 0x00000020U /* solaris 10 */
		463	#define EVBACKEND_ALL 0x0000003FU
414		464
415	#if EV_PROTOTYPES	465	#if EV_PROTOTYPES
416	int ev_version_major (void);	466	int ev_version_major (void);
417	int ev_version_minor (void);	467	int ev_version_minor (void);
418		468
…		…
467	struct ev_loop *ev_loop_new (unsigned int flags);	517	struct ev_loop *ev_loop_new (unsigned int flags);
468	void ev_loop_destroy (EV_P);	518	void ev_loop_destroy (EV_P);
469	void ev_loop_fork (EV_P);	519	void ev_loop_fork (EV_P);
470		520
471	ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */	521	ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
472	void ev_now_update (EV_P);
473		522
474	#else	523	#else
475		524
476	int ev_default_loop (unsigned int flags); /* returns true when successful */	525	int ev_default_loop (unsigned int flags); /* returns true when successful */
477		526
…		…
501	/* if you create alternative loops you have to call ev_loop_fork on them */	550	/* if you create alternative loops you have to call ev_loop_fork on them */
502	/* you can call it in either the parent or the child */	551	/* you can call it in either the parent or the child */
503	/* you can actually call it at any time, anywhere :) */	552	/* you can actually call it at any time, anywhere :) */
504	void ev_default_fork (void);	553	void ev_default_fork (void);
505		554
506	unsigned int ev_backend (EV_P); /* backend in use by loop */	555	unsigned int ev_backend (EV_P); /* backend in use by loop */
507	unsigned int ev_loop_count (EV_P); /* number of loop iterations */	556
508	unsigned int ev_loop_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */	557	void ev_now_update (EV_P); /* update event loop time */
509	void ev_loop_verify (EV_P); /* abort if loop data corrupted */
510		558
511	#if EV_WALK_ENABLE	559	#if EV_WALK_ENABLE
512	/* walk (almost) all watchers in the loop of a given type, invoking the */	560	/* walk (almost) all watchers in the loop of a given type, invoking the */
513	/* callback on every such watcher. The callback might stop the watcher, */	561	/* callback on every such watcher. The callback might stop the watcher, */
514	/* but do nothing else with the loop */	562	/* but do nothing else with the loop */
…		…
525		573
526	#if EV_PROTOTYPES	574	#if EV_PROTOTYPES
527	void ev_loop (EV_P_ int flags);	575	void ev_loop (EV_P_ int flags);
528	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 */	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 */
529		577
530	void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
531	void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
532
533	/*	578	/*
534	* ref/unref can be used to add or remove a refcount on the mainloop. every watcher	579	* ref/unref can be used to add or remove a refcount on the mainloop. every watcher
535	* keeps one reference. if you have a long-runing watcher you never unregister that	580	* keeps one reference. if you have a long-running watcher you never unregister that
536	* should not keep ev_loop from running, unref() after starting, and ref() before stopping.	581	* should not keep ev_loop from running, unref() after starting, and ref() before stopping.
537	*/	582	*/
538	void ev_ref (EV_P);	583	void ev_ref (EV_P);
539	void ev_unref (EV_P);	584	void ev_unref (EV_P);
		585
		586	/*
		587	* convenience function, wait for a single event, without registering an event watcher
		588	* if timeout is < 0, do wait indefinitely
		589	*/
		590	void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (cb)(int revents, void arg), void *arg);
		591
		592	# if EV_FEATURE_API
		593	unsigned int ev_loop_count (EV_P); /* number of loop iterations */
		594	unsigned int ev_loop_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */
		595	void ev_loop_verify (EV_P); /* abort if loop data corrupted */
		596
		597	void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
		598	void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
		599
		600	/* advanced stuff for threading etc. support, see docs */
		601	void ev_set_userdata (EV_P_ void *data);
		602	void *ev_userdata (EV_P);
		603	void ev_set_invoke_pending_cb (EV_P_ void (*invoke_pending_cb)(EV_P));
		604	void ev_set_loop_release_cb (EV_P_ void (release)(EV_P), void (acquire)(EV_P));
		605
		606	unsigned int ev_pending_count (EV_P); /* number of pending events, if any */
		607	void ev_invoke_pending (EV_P); /* invoke all pending watchers */
540		608
541	/*	609	/*
542	* stop/start the timer handling.	610	* stop/start the timer handling.
543	*/	611	*/
544	void ev_suspend (EV_P);	612	void ev_suspend (EV_P);
545	void ev_resume (EV_P);	613	void ev_resume (EV_P);
		614	#endif
546		615
547	/*
548	* convenience function, wait for a single event, without registering an event watcher
549	* if timeout is < 0, do wait indefinitely
550	*/
551	void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (cb)(int revents, void arg), void *arg);
552	#endif	616	#endif
553		617
554	/* these may evaluate ev multiple times, and the other arguments at most once */	618	/* these may evaluate ev multiple times, and the other arguments at most once */
555	/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */	619	/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
556	#define ev_init(ev,cb_) do { \	620	#define ev_init(ev,cb_) do { \
…		…
593		657
594	#if EV_MINPRI == EV_MAXPRI	658	#if EV_MINPRI == EV_MAXPRI
595	# define ev_priority(ev) ((ev), EV_MINPRI)	659	# define ev_priority(ev) ((ev), EV_MINPRI)
596	# define ev_set_priority(ev,pri) ((ev), (pri))	660	# define ev_set_priority(ev,pri) ((ev), (pri))
597	#else	661	#else
598	# define ev_priority(ev) ((((ev_watcher )(void )(ev))->priority) + 0)	662	# define ev_priority(ev) (+(((ev_watcher )(void )(ev))->priority))
599	# define ev_set_priority(ev,pri) ( (ev_watcher )(void )(ev))->priority = (pri)	663	# define ev_set_priority(ev,pri) ( (ev_watcher )(void )(ev))->priority = (pri)
600	#endif	664	#endif
601		665
602	#define ev_periodic_at(ev) (((ev_watcher_time *)(ev))->at + 0.)	666	#define ev_periodic_at(ev) (+((ev_watcher_time *)(ev))->at)
603		667
604	#ifndef ev_set_cb	668	#ifndef ev_set_cb
605	# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)	669	# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
606	#endif	670	#endif
607		671
…		…
611		675
612	/* feeds an event into a watcher as if the event actually occured */	676	/* feeds an event into a watcher as if the event actually occured */
613	/* accepts any ev_watcher type */	677	/* accepts any ev_watcher type */
614	void ev_feed_event (EV_P_ void *w, int revents);	678	void ev_feed_event (EV_P_ void *w, int revents);
615	void ev_feed_fd_event (EV_P_ int fd, int revents);	679	void ev_feed_fd_event (EV_P_ int fd, int revents);
		680	#if EV_SIGNAL_ENABLE
616	void ev_feed_signal_event (EV_P_ int signum);	681	void ev_feed_signal_event (EV_P_ int signum);
		682	#endif
617	void ev_invoke (EV_P_ void *w, int revents);	683	void ev_invoke (EV_P_ void *w, int revents);
618	int ev_clear_pending (EV_P_ void *w);	684	int ev_clear_pending (EV_P_ void *w);
619		685
620	void ev_io_start (EV_P_ ev_io *w);	686	void ev_io_start (EV_P_ ev_io *w);
621	void ev_io_stop (EV_P_ ev_io *w);	687	void ev_io_stop (EV_P_ ev_io *w);
622		688
623	void ev_timer_start (EV_P_ ev_timer *w);	689	void ev_timer_start (EV_P_ ev_timer *w);
624	void ev_timer_stop (EV_P_ ev_timer *w);	690	void ev_timer_stop (EV_P_ ev_timer *w);
625	/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */	691	/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
626	void ev_timer_again (EV_P_ ev_timer *w);	692	void ev_timer_again (EV_P_ ev_timer *w);
		693	/* return remaining time */
		694	ev_tstamp ev_timer_remaining (EV_P_ ev_timer *w);
627		695
628	#if EV_PERIODIC_ENABLE	696	#if EV_PERIODIC_ENABLE
629	void ev_periodic_start (EV_P_ ev_periodic *w);	697	void ev_periodic_start (EV_P_ ev_periodic *w);
630	void ev_periodic_stop (EV_P_ ev_periodic *w);	698	void ev_periodic_stop (EV_P_ ev_periodic *w);
631	void ev_periodic_again (EV_P_ ev_periodic *w);	699	void ev_periodic_again (EV_P_ ev_periodic *w);
632	#endif	700	#endif
633		701
634	/* only supported in the default loop */	702	/* only supported in the default loop */
		703	#if EV_SIGNAL_ENABLE
635	void ev_signal_start (EV_P_ ev_signal *w);	704	void ev_signal_start (EV_P_ ev_signal *w);
636	void ev_signal_stop (EV_P_ ev_signal *w);	705	void ev_signal_stop (EV_P_ ev_signal *w);
		706	#endif
637		707
638	/* only supported in the default loop */	708	/* only supported in the default loop */
		709	# if EV_CHILD_ENABLE
639	void ev_child_start (EV_P_ ev_child *w);	710	void ev_child_start (EV_P_ ev_child *w);
640	void ev_child_stop (EV_P_ ev_child *w);	711	void ev_child_stop (EV_P_ ev_child *w);
		712	# endif
641		713
642	# if EV_STAT_ENABLE	714	# if EV_STAT_ENABLE
643	void ev_stat_start (EV_P_ ev_stat *w);	715	void ev_stat_start (EV_P_ ev_stat *w);
644	void ev_stat_stop (EV_P_ ev_stat *w);	716	void ev_stat_stop (EV_P_ ev_stat *w);
645	void ev_stat_stat (EV_P_ ev_stat *w);	717	void ev_stat_stat (EV_P_ ev_stat *w);
…		…
648	# if EV_IDLE_ENABLE	720	# if EV_IDLE_ENABLE
649	void ev_idle_start (EV_P_ ev_idle *w);	721	void ev_idle_start (EV_P_ ev_idle *w);
650	void ev_idle_stop (EV_P_ ev_idle *w);	722	void ev_idle_stop (EV_P_ ev_idle *w);
651	# endif	723	# endif
652		724
		725	#if EV_PREPARE_ENABLE
653	void ev_prepare_start (EV_P_ ev_prepare *w);	726	void ev_prepare_start (EV_P_ ev_prepare *w);
654	void ev_prepare_stop (EV_P_ ev_prepare *w);	727	void ev_prepare_stop (EV_P_ ev_prepare *w);
		728	#endif
655		729
		730	#if EV_CHECK_ENABLE
656	void ev_check_start (EV_P_ ev_check *w);	731	void ev_check_start (EV_P_ ev_check *w);
657	void ev_check_stop (EV_P_ ev_check *w);	732	void ev_check_stop (EV_P_ ev_check *w);
		733	#endif
658		734
659	# if EV_FORK_ENABLE	735	# if EV_FORK_ENABLE
660	void ev_fork_start (EV_P_ ev_fork *w);	736	void ev_fork_start (EV_P_ ev_fork *w);
661	void ev_fork_stop (EV_P_ ev_fork *w);	737	void ev_fork_stop (EV_P_ ev_fork *w);
662	# endif	738	# endif

Diff Legend

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

Comparing libev/ev.h (file contents): Revision 1.117 by root, Wed Jul 8 04:29:31 2009 UTC vs. Revision 1.134 by root, Tue Mar 16 00:20:17 2010 UTC

Diff Legend

Comparing libev/ev.h (file contents):
Revision 1.117 by root, Wed Jul 8 04:29:31 2009 UTC vs.
Revision 1.134 by root, Tue Mar 16 00:20:17 2010 UTC