RollingBuffer.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	RollingBuffer

Macros
#define	ROLLING_BUFFER_MAP_INDEX(pRollingBuffer, index)   ((index) % (pRollingBuffer)->capacity)

Typedefs
typedef STATUS(*	FreeDataFunc) (PUINT64)
typedef struct RollingBuffer *	PRollingBuffer

Functions
STATUS	createRollingBuffer (UINT32, FreeDataFunc, PRollingBuffer *)
STATUS	freeRollingBuffer (PRollingBuffer *)
STATUS	rollingBufferAppendData (PRollingBuffer, UINT64, PUINT64)
STATUS	rollingBufferInsertData (PRollingBuffer, UINT64, UINT64)
STATUS	rollingBufferExtractData (PRollingBuffer, UINT64, PUINT64)
STATUS	rollingBufferGetSize (PRollingBuffer, PUINT32)
STATUS	rollingBufferIsEmpty (PRollingBuffer, PBOOL)

Macro Definition Documentation

ROLLING_BUFFER_MAP_INDEX

#define ROLLING_BUFFER_MAP_INDEX	(		pRollingBuffer,
			index
	)		((index) % (pRollingBuffer)->capacity)

Typedef Documentation

FreeDataFunc

typedef STATUS(* FreeDataFunc) (PUINT64)

PRollingBuffer

typedef struct RollingBuffer * PRollingBuffer

Function Documentation

createRollingBuffer()

STATUS createRollingBuffer	(	UINT32	capacity,
		FreeDataFunc	freeDataFunc,
		PRollingBuffer *	ppRollingBuffer
	)

Here is the call graph for this function:

Here is the caller graph for this function:

freeRollingBuffer()

STATUS freeRollingBuffer

(

PRollingBuffer *

ppRollingBuffer

)

Here is the caller graph for this function:

rollingBufferAppendData()

STATUS rollingBufferAppendData	(	PRollingBuffer	pRollingBuffer,
		UINT64	data,
		PUINT64	pIndex
	)

Here is the caller graph for this function:

rollingBufferExtractData()

STATUS rollingBufferExtractData	(	PRollingBuffer	pRollingBuffer,
		UINT64	index,
		PUINT64	pData
	)

Here is the caller graph for this function:

rollingBufferGetSize()

STATUS rollingBufferGetSize	(	PRollingBuffer	pRollingBuffer,
		PUINT32	pSize
	)

Here is the caller graph for this function:

rollingBufferInsertData()

STATUS rollingBufferInsertData	(	PRollingBuffer	pRollingBuffer,
		UINT64	index,
		UINT64	data
	)

Here is the caller graph for this function:

rollingBufferIsEmpty()

STATUS rollingBufferIsEmpty	(	PRollingBuffer	pRollingBuffer,
		PBOOL	pIsEmpty
	)