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

Comparing libev/ev.h (file contents):
Revision 1.5 by root, Wed Oct 31 07:24:17 2007 UTC vs.
Revision 1.31 by root, Sun Nov 4 19:45:09 2007 UTC

		1	/*
		2	* Copyright (c) 2007 Marc Alexander Lehmann <libev@schmorp.de>
		3	* All rights reserved.
		4	*
		5	* Redistribution and use in source and binary forms, with or without
		6	* modification, are permitted provided that the following conditions are
		7	* met:
		8	*
		9	* * Redistributions of source code must retain the above copyright
		10	* notice, this list of conditions and the following disclaimer.
		11	*
		12	* * Redistributions in binary form must reproduce the above
		13	* copyright notice, this list of conditions and the following
		14	* disclaimer in the documentation and/or other materials provided
		15	* with the distribution.
		16	*
		17	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
		18	* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
		19	* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
		20	* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
		21	* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
		22	* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
		23	* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
		24	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
		25	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
		26	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
		27	* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
		28	*/
		29
1	#ifndef EV_H	30	#ifndef EV_H
2	#define EV_H	31	#define EV_H
3		32
		33	#ifdef __cplusplus
		34	extern "C" {
		35	#endif
		36
4	typedef double ev_tstamp;	37	typedef double ev_tstamp;
5		38
		39	/* these priorities are inclusive, higher priorities will be called earlier */
		40	#ifndef EV_MINPRI
		41	# define EV_MINPRI -2
		42	#endif
		43	#ifndef EV_MAXPRI
		44	# define EV_MAXPRI +2
		45	#endif
		46
		47	#ifndef EV_MULTIPLICITY
		48	# define EV_MULTIPLICITY 1
		49	#endif
		50
		51	/* support multiple event loops? */
		52	#if EV_MULTIPLICITY
		53	struct ev_loop;
		54	# define EV_P struct ev_loop *loop
		55	# define EV_P_ EV_P,
		56	# define EV_A loop
		57	# define EV_A_ EV_A,
		58	#else
		59	# define EV_P void
		60	# define EV_P_
		61	# define EV_A
		62	# define EV_A_
		63	#endif
		64
6	/* eventmask, revents, events... */	65	/* eventmask, revents, events... */
7	#define EV_UNDEF -1 /* guaranteed to be invalid */	66	#define EV_UNDEF -1 /* guaranteed to be invalid */
8	#define EV_NONE 0x00	67	#define EV_NONE 0x00
9	#define EV_READ 0x01	68	#define EV_READ 0x01
10	#define EV_WRITE 0x02	69	#define EV_WRITE 0x02
11	#define EV_TIMEOUT 0x04	70	#define EV_TIMEOUT 0x000100
		71	#define EV_PERIODIC 0x000200
12	#define EV_SIGNAL 0x08	72	#define EV_SIGNAL 0x000400
13	#define EV_IDLE 0x10	73	#define EV_IDLE 0x000800
14	#define EV_CHECK 0x20	74	#define EV_CHECK 0x001000
		75	#define EV_PREPARE 0x002000
		76	#define EV_CHILD 0x004000
		77	#define EV_ERROR 0x800000 /* sent when an error occurs */
		78
		79	/* can be used to add custom fields to all watchers */
		80	#ifndef EV_COMMON
		81	# define EV_COMMON void *data
		82	#endif
		83	#ifndef EV_PROTOTYPES
		84	# define EV_PROTOTYPES 1
		85	#endif
		86
		87	#define EV_VERSION_MAJOR 1
		88	#define EV_VERSION_MINOR 1
		89
		90	/*
		91	* struct member types:
		92	* private: you can look at them, but not change them, and they might not mean anything to you.
		93	* ro: can be read anytime, but only changed when the watcher isn't active
		94	* rw: can be read and modified anytime, even when the watcher is active
		95	*/
15		96
16	/* shared by all watchers */	97	/* shared by all watchers */
17	#define EV_WATCHER(type) \	98	#define EV_WATCHER(type) \
18	int active; /* private */ \	99	int active; /* private */ \
19	int pending; /* private */ \	100	int pending; /* private */ \
20	void data; / rw */ \	101	int priority; /* ro */ \
		102	EV_COMMON; /* rw */ \
21	void (cb)(struct type , int revents) /* rw / / gets invoked with an eventmask */	103	void (cb)(EV_P_ struct type , int revents); /* rw / / gets invoked with an eventmask */
22		104
23	#define EV_WATCHER_LIST(type) \	105	#define EV_WATCHER_LIST(type) \
24	EV_WATCHER (type); \	106	EV_WATCHER (type); \
25	struct type next / private */	107	struct ev_watcher_list next / private */
26		108
27	/* invoked at a specific time or after a specific time, repeatable */	109	#define EV_WATCHER_TIME(type) \
		110	EV_WATCHER (type); \
		111	ev_tstamp at /* private */
		112
		113	/* base class, nothing to see here unless you subclass */
		114	struct ev_watcher {
		115	EV_WATCHER (ev_watcher);
		116	};
		117
		118	/* base class, nothing to see here unless you subclass */
		119	struct ev_watcher_list {
		120	EV_WATCHER_LIST (ev_watcher_list);
		121	};
		122
		123	/* base class, nothing to see here unless you subclass */
		124	struct ev_watcher_time {
		125	EV_WATCHER_TIME (ev_watcher_time);
		126	};
		127
		128	/* invoked after a specific time, repeatable (based on monotonic clock) */
		129	/* revent EV_TIMEOUT */
28	struct ev_timer	130	struct ev_timer
29	{	131	{
30	EV_WATCHER_LIST (ev_timer);	132	EV_WATCHER_TIME (ev_timer);
31		133
32	ev_tstamp at; /* private */
33	ev_tstamp repeat; /* rw */	134	ev_tstamp repeat; /* rw */
34	unsigned char is_abs; /* ro */	135	};
		136
		137	/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
		138	/* revent EV_PERIODIC */
		139	struct ev_periodic
		140	{
		141	EV_WATCHER_TIME (ev_periodic);
		142
		143	ev_tstamp interval; /* rw */
35	};	144	};
36		145
37	/* invoked when fd is either EV_READable or EV_WRITEable */	146	/* invoked when fd is either EV_READable or EV_WRITEable */
		147	/* revent EV_READ, EV_WRITE */
38	struct ev_io	148	struct ev_io
39	{	149	{
40	EV_WATCHER_LIST (ev_io);	150	EV_WATCHER_LIST (ev_io);
41		151
42	int fd; /* ro */	152	int fd; /* ro */
43	int events; /* ro */	153	int events; /* ro */
44	};	154	};
45		155
46	/* invoked when the given signal has been received */	156	/* invoked when the given signal has been received */
		157	/* revent EV_SIGNAL */
47	struct ev_signal	158	struct ev_signal
48	{	159	{
49	EV_WATCHER_LIST (ev_signal);	160	EV_WATCHER_LIST (ev_signal);
		161	#if EV_MULTIPLICITY
		162	struct ev_loop *loop;
		163	#endif
50		164
51	int signum; /* ro */	165	int signum; /* ro */
52	};	166	};
53		167
54	/* invoked when the nothing else needs to be done, keeps the process from blocking */	168	/* invoked when the nothing else needs to be done, keeps the process from blocking */
		169	/* revent EV_IDLE */
55	struct ev_idle	170	struct ev_idle
56	{	171	{
57	EV_WATCHER (ev_idle);	172	EV_WATCHER (ev_idle);
58	};	173	};
59		174
60	/* invoked for each run of the mainloop, just before the next blocking vall is initiated */	175	/* invoked for each run of the mainloop, just before the blocking call */
		176	/* you can still change events in any way you like */
		177	/* revent EV_PREPARE */
		178	struct ev_prepare
		179	{
		180	EV_WATCHER (ev_prepare);
		181	};
		182
		183	/* invoked for each run of the mainloop, just after the blocking call */
		184	/* revent EV_CHECK */
61	struct ev_check	185	struct ev_check
62	{	186	{
63	EV_WATCHER (ev_check);	187	EV_WATCHER (ev_check);
64	};	188	};
65		189
66	#define EVMETHOD_NONE 0	190	/* invoked when sigchld is received and waitpid indicates the givne pid */
		191	/* revent EV_CHILD */
		192	/* does not support priorities */
		193	struct ev_child
		194	{
		195	EV_WATCHER_LIST (ev_child);
		196
		197	int pid; /* ro */
		198	int rpid; /* rw, holds the received pid */
		199	int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
		200	};
		201
		202	#define EVMETHOD_AUTO 0 /* consults environment */
67	#define EVMETHOD_SELECT 1	203	#define EVMETHOD_SELECT 1
68	#define EVMETHOD_EPOLL 2	204	#define EVMETHOD_POLL 2
69	int ev_init (int flags); /* returns ev_method */	205	#define EVMETHOD_EPOLL 4
70	extern int ev_method;	206	#define EVMETHOD_KQUEUE 8
		207	#define EVMETHOD_DEVPOLL 16 /* NYI */
		208	#define EVMETHOD_PORT 32 /* NYI */
		209	#define EVMETHOD_ANY ~0 /* any method, do not consult env */
71		210
72	/* these three calls are suitable for plugging into pthread_atfork */	211	#if EV_PROTOTYPES
73	void ev_prefork (void);	212	int ev_version_major (void);
74	void ev_postfork_parent (void);	213	int ev_version_minor (void);
75	void ev_postfork_child (void);
76		214
77	extern ev_tstamp ev_now; /* time w.r.t. timers and the eventloop, updated after each poll */
78	ev_tstamp ev_time (void);	215	ev_tstamp ev_time (void);
		216
		217	# if EV_MULTIPLICITY
		218	/* the default loop is the only one that handles signals and child watchers */
		219	/* you can call this as often as you like */
		220	struct ev_loop ev_default_loop (int methods); / returns default loop */
		221
		222	/* create and destroy alternative loops that don't handle signals */
		223	struct ev_loop *ev_loop_new (int methods);
		224	void ev_loop_destroy (EV_P);
		225	void ev_loop_fork (EV_P);
		226	# else
		227	int ev_default_loop (int methods); /* returns true when successful */
		228	# endif
		229
		230	void ev_default_destroy (void); /* destroy the default loop */
		231	/* this needs to be called after fork, to duplicate the default loop */
		232	/* if you create alternative loops you have to call ev_loop_fork on them */
		233	/* you can call it in either the parent or the child */
		234	/* you can actually call it at any time, anywhere :) */
		235	void ev_default_fork (void);
		236
		237	int ev_method (EV_P);
		238	#endif
79		239
80	#define EVLOOP_NONBLOCK 1 /* do not block/wait */	240	#define EVLOOP_NONBLOCK 1 /* do not block/wait */
81	#define EVLOOP_ONESHOT 2 /* block once only */	241	#define EVLOOP_ONESHOT 2 /* block once only */
		242	#define EVUNLOOP_ONCE 1 /* unloop once */
		243	#define EVUNLOOP_ALL 2 /* unloop all loops */
		244
		245	#if EV_PROTOTYPES
82	void ev_loop (int flags);	246	void ev_loop (EV_P_ int flags);
83	extern int ev_loop_done; /* set to 1 to break out of event loop */	247	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 */
		248
		249	ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
		250
		251	/*
		252	* ref/unref can be used to add or remove a refcount on the mainloop. every watcher
		253	* keeps one reference. if you have a long-runing watcher you never unregister that
		254	* should not keep ev_loop from running, unref() after starting, and ref() before stopping.
		255	*/
		256	void ev_ref (EV_P);
		257	void ev_unref (EV_P);
		258
		259	/* convinience function, wait for a single event, without registering an event watcher */
		260	/* if timeout is < 0, do wait indefinitely */
		261	void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (cb)(int revents, void arg), void *arg);
		262	#endif
84		263
85	/* these may evaluate ev multiple times, and the other arguments at most once */	264	/* these may evaluate ev multiple times, and the other arguments at most once */
86	#define evw_init(ev,cb_,data_) do { (ev)->active = 0; (ev)->cb = (cb_); (ev)->data = (void *)data_; } while (0)	265	/* either use ev_watcher_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
		266	#define ev_watcher_init(ev,cb_) do { (ev)->active = (ev)->pending = (ev)->priority = 0; (ev)->cb = (cb_); } while (0)
87		267
88	#define evio_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0)	268	#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0)
89	#define evtimer_set_rel(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); (ev)->is_abs = 0; } while (0)	269	#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)
90	#define evtimer_set_abs(ev,at_,repeat_) do { (ev)->at = (at_); (ev)->repeat = (repeat_); (ev)->is_abs = 1; } while (0)	270	#define ev_periodic_set(ev,at_,interval_) do { (ev)->at = (at_); (ev)->interval = (interval_); } while (0)
91	#define evsignal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)	271	#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
		272	#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
		273	#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
		274	#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
		275	#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0)
92		276
		277	#define ev_io_init(ev,cb,fd,events) do { ev_watcher_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
		278	#define ev_timer_init(ev,cb,after,repeat) do { ev_watcher_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
		279	#define ev_periodic_init(ev,cb,at,interval) do { ev_watcher_init ((ev), (cb)); ev_periodic_set ((ev),(at),(interval)); } while (0)
		280	#define ev_signal_init(ev,cb,signum) do { ev_watcher_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
		281	#define ev_idle_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
		282	#define ev_prepare_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
		283	#define ev_check_init(ev,cb) do { ev_watcher_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
		284	#define ev_child_init(ev,cb,pid) do { ev_watcher_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)
		285
		286	#define ev_is_pending(ev) (0 + (ev)->pending) /* true when watcher is waiting for callback invocation */
93	#define ev_is_active(ev) (0 + (ev)->active) /* true when the watcher has been started */	287	#define ev_is_active(ev) (0 + (ev)->active) /* true when the watcher has been started */
		288	#define ev_set_priority(ev,pri) (ev)->priority = pri
94		289
95	/* stopping (enabling, adding) a watcher does nothing if it is already running */	290	/* stopping (enabling, adding) a watcher does nothing if it is already running */
96	/* stopping (disabling, deleting) a watcher does nothing unless its already running */	291	/* stopping (disabling, deleting) a watcher does nothing unless its already running */
		292	#if EV_PROTOTYPES
97	void evio_start (struct ev_io *w);	293	void ev_io_start (EV_P_ struct ev_io *w);
98	void evio_stop (struct ev_io *w);	294	void ev_io_stop (EV_P_ struct ev_io *w);
99		295
100	void evtimer_start (struct ev_timer *w);	296	void ev_timer_start (EV_P_ struct ev_timer *w);
101	void evtimer_stop (struct ev_timer *w);	297	void ev_timer_stop (EV_P_ struct ev_timer *w);
		298	/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
		299	void ev_timer_again (EV_P_ struct ev_timer *w);
102		300
		301	void ev_periodic_start (EV_P_ struct ev_periodic *w);
		302	void ev_periodic_stop (EV_P_ struct ev_periodic *w);
		303
		304	void ev_idle_start (EV_P_ struct ev_idle *w);
		305	void ev_idle_stop (EV_P_ struct ev_idle *w);
		306
		307	void ev_prepare_start (EV_P_ struct ev_prepare *w);
		308	void ev_prepare_stop (EV_P_ struct ev_prepare *w);
		309
		310	void ev_check_start (EV_P_ struct ev_check *w);
		311	void ev_check_stop (EV_P_ struct ev_check *w);
		312
		313	/* only supported in the default loop */
103	void evsignal_start (struct ev_signal *w);	314	void ev_signal_start (EV_P_ struct ev_signal *w);
104	void evsignal_stop (struct ev_signal *w);	315	void ev_signal_stop (EV_P_ struct ev_signal *w);
105		316
		317	/* only supported in the default loop */
106	void evidle_start (struct ev_idle *w);	318	void ev_child_start (EV_P_ struct ev_child *w);
107	void evidle_stop (struct ev_idle *w);	319	void ev_child_stop (EV_P_ struct ev_child *w);
108
109	void evcheck_start (struct ev_check *w);
110	void evcheck_stop (struct ev_check *w);
111
112	#endif	320	#endif
113		321
		322	#ifdef __cplusplus
		323	}
		324	#endif
		325
		326	#endif
		327

Diff Legend

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

Comparing libev/ev.h (file contents): Revision 1.5 by root, Wed Oct 31 07:24:17 2007 UTC vs. Revision 1.31 by root, Sun Nov 4 19:45:09 2007 UTC

Diff Legend

Comparing libev/ev.h (file contents):
Revision 1.5 by root, Wed Oct 31 07:24:17 2007 UTC vs.
Revision 1.31 by root, Sun Nov 4 19:45:09 2007 UTC