git.saurik.com Git - redis.git/blame_incremental

... / ...

Commit	Line	Data
	1	/* A simple event-driven programming library. Originally I wrote this code
	2	* for the Jim's event-loop (Jim is a Tcl interpreter) but later translated
	3	* it in form of a library for easy reuse.
	4	*
	5	* Copyright (c) 2006-2009, Salvatore Sanfilippo <antirez at gmail dot com>
	6	* All rights reserved.
	7	*
	8	* Redistribution and use in source and binary forms, with or without
	9	* modification, are permitted provided that the following conditions are met:
	10	*
	11	* * Redistributions of source code must retain the above copyright notice,
	12	* this list of conditions and the following disclaimer.
	13	* * Redistributions in binary form must reproduce the above copyright
	14	* notice, this list of conditions and the following disclaimer in the
	15	* documentation and/or other materials provided with the distribution.
	16	* * Neither the name of Redis nor the names of its contributors may be used
	17	* to endorse or promote products derived from this software without
	18	* specific prior written permission.
	19	*
	20	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
	21	* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	22	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	23	* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
	24	* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
	25	* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
	26	* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
	27	* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
	28	* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
	29	* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
	30	* POSSIBILITY OF SUCH DAMAGE.
	31	*/
	32
	33	#ifndef __AE_H__
	34	#define __AE_H__
	35
	36	#define AE_SETSIZE (102410) / Max number of fd supported */
	37
	38	#define AE_OK 0
	39	#define AE_ERR -1
	40
	41	#define AE_NONE 0
	42	#define AE_READABLE 1
	43	#define AE_WRITABLE 2
	44
	45	#define AE_FILE_EVENTS 1
	46	#define AE_TIME_EVENTS 2
	47	#define AE_ALL_EVENTS (AE_FILE_EVENTS\|AE_TIME_EVENTS)
	48	#define AE_DONT_WAIT 4
	49
	50	#define AE_NOMORE -1
	51
	52	/* Macros */
	53	#define AE_NOTUSED(V) ((void) V)
	54
	55	struct aeEventLoop;
	56
	57	/* Types and data structures */
	58	typedef void aeFileProc(struct aeEventLoop eventLoop, int fd, void clientData, int mask);
	59	typedef int aeTimeProc(struct aeEventLoop eventLoop, long long id, void clientData);
	60	typedef void aeEventFinalizerProc(struct aeEventLoop eventLoop, void clientData);
	61
	62	/* File event structure */
	63	typedef struct aeFileEvent {
	64	int mask; /* one of AE_(READABLE\|WRITABLE) */
	65	aeFileProc *rfileProc;
	66	aeFileProc *wfileProc;
	67	void *clientData;
	68	} aeFileEvent;
	69
	70	/* Time event structure */
	71	typedef struct aeTimeEvent {
	72	long long id; /* time event identifier. */
	73	long when_sec; /* seconds */
	74	long when_ms; /* milliseconds */
	75	aeTimeProc *timeProc;
	76	aeEventFinalizerProc *finalizerProc;
	77	void *clientData;
	78	struct aeTimeEvent *next;
	79	} aeTimeEvent;
	80
	81	/* A fired event */
	82	typedef struct aeFiredEvent {
	83	int fd;
	84	int mask;
	85	} aeFiredEvent;
	86
	87	/* State of an event based program */
	88	typedef struct aeEventLoop {
	89	int maxfd;
	90	long long timeEventNextId;
	91	aeFileEvent events[AE_SETSIZE]; /* Registered events */
	92	aeFiredEvent fired[AE_SETSIZE]; /* Fired events */
	93	aeTimeEvent *timeEventHead;
	94	int stop;
	95	void apidata; / This is used for polling API specific data */
	96	} aeEventLoop;
	97
	98	/* Prototypes */
	99	aeEventLoop *aeCreateEventLoop(void);
	100	void aeDeleteEventLoop(aeEventLoop *eventLoop);
	101	void aeStop(aeEventLoop *eventLoop);
	102	int aeCreateFileEvent(aeEventLoop *eventLoop, int fd, int mask,
	103	aeFileProc proc, void clientData);
	104	void aeDeleteFileEvent(aeEventLoop *eventLoop, int fd, int mask);
	105	long long aeCreateTimeEvent(aeEventLoop *eventLoop, long long milliseconds,
	106	aeTimeProc proc, void clientData,
	107	aeEventFinalizerProc *finalizerProc);
	108	int aeDeleteTimeEvent(aeEventLoop *eventLoop, long long id);
	109	int aeProcessEvents(aeEventLoop *eventLoop, int flags);
	110	int aeWait(int fd, int mask, long long milliseconds);
	111	void aeMain(aeEventLoop *eventLoop);
	112	char *aeGetApiName(void);
	113
	114	#endif