cRingBuffer Class Reference

#include <ringbuffer.h>

Public Member Functions
	cRingBuffer (int Size, bool Statistics=false)
virtual	~cRingBuffer ()
void	SetTimeouts (int PutTimeout, int GetTimeout)
void	SetIoThrottle (void)
void	ReportOverflow (int Bytes)

Protected Member Functions
void	UpdatePercentage (int Fill)
void	WaitForPut (void)
void	WaitForGet (void)
void	EnablePut (void)
void	EnableGet (void)
virtual void	Clear (void)=0
virtual int	Available (void)=0
virtual int	Free (void)
int	Size (void)

Protected Attributes
tThreadId	getThreadTid
int	maxFill
int	lastPercent
bool	statistics

Private Attributes
cCondWait	readyForPut
cCondWait	readyForGet
int	putTimeout
int	getTimeout
int	size
time_t	lastOverflowReport
int	overflowCount
int	overflowBytes
cIoThrottle *	ioThrottle

Detailed Description

Definition at line 16 of file ringbuffer.h.

Constructor & Destructor Documentation

cRingBuffer()

cRingBuffer::cRingBuffer	(	int	Size,
		bool	Statistics = false )

Definition at line 26 of file ringbuffer.c.

References getThreadTid, getTimeout, ioThrottle, lastOverflowReport, lastPercent, maxFill, overflowBytes, overflowCount, putTimeout, Size(), size, and statistics.

Referenced by cRingBufferFrame::cRingBufferFrame(), and cRingBufferLinear::cRingBufferLinear().

~cRingBuffer()

cRingBuffer::~cRingBuffer ( )

virtual

Definition at line 39 of file ringbuffer.c.

References dsyslog, ioThrottle, maxFill, size, and statistics.

Member Function Documentation

Available()

virtual int cRingBuffer::Available ( void )

protectedpure virtual

Implemented in cRingBufferFrame, and cRingBufferLinear.

Referenced by EnableGet(), and Free().

Clear()

virtual void cRingBuffer::Clear ( void )

protectedpure virtual

Implemented in cRingBufferFrame, and cRingBufferLinear.

EnableGet()

void cRingBuffer::EnableGet ( void )

protected

Definition at line 83 of file ringbuffer.c.

References Available(), getTimeout, readyForGet, and Size().

Referenced by cRingBufferFrame::Clear(), cRingBufferFrame::Put(), cRingBufferLinear::Put(), cRingBufferLinear::Read(), and cRingBufferLinear::Read().

EnablePut()

void cRingBuffer::EnablePut ( void )

protected

Definition at line 77 of file ringbuffer.c.

References Free(), putTimeout, readyForPut, and Size().

Referenced by cRingBufferFrame::Clear(), cRingBufferLinear::Clear(), cRingBufferLinear::Del(), and cRingBufferFrame::Drop().

Free()

virtual int cRingBuffer::Free ( void )

inlineprotectedvirtual

Reimplemented in cRingBufferLinear.

Definition at line 38 of file ringbuffer.h.

References Available(), and Size().

Referenced by EnablePut(), and cRingBufferFrame::Put().

ReportOverflow()

void cRingBuffer::ReportOverflow

(

int

Bytes

)

Definition at line 101 of file ringbuffer.c.

References esyslog, lastOverflowReport, overflowBytes, overflowCount, and OVERFLOWREPORTDELTA.

SetIoThrottle()

void cRingBuffer::SetIoThrottle

(

void

)

Definition at line 95 of file ringbuffer.c.

References ioThrottle.

SetTimeouts()

void cRingBuffer::SetTimeouts	(	int	PutTimeout,
		int	GetTimeout )

Definition at line 89 of file ringbuffer.c.

References getTimeout, and putTimeout.

Size()

int cRingBuffer::Size ( void )

inlineprotected

Definition at line 39 of file ringbuffer.h.

References size.

Referenced by cRingBufferLinear::Available(), cRingBuffer(), cRingBufferFrame::cRingBufferFrame(), cRingBufferLinear::cRingBufferLinear(), cRingBufferLinear::Del(), EnableGet(), EnablePut(), Free(), cRingBufferLinear::Free(), cRingBufferLinear::Get(), cRingBufferLinear::Put(), cRingBufferLinear::Read(), cRingBufferLinear::Read(), and UpdatePercentage().

UpdatePercentage()

void cRingBuffer::UpdatePercentage ( int Fill )

protected

Definition at line 46 of file ringbuffer.c.

References dsyslog, getThreadTid, ioThrottle, IOTHROTTLEHIGH, IOTHROTTLELOW, lastPercent, maxFill, PERCENTAGEDELTA, PERCENTAGETHRESHOLD, and Size().

Referenced by cRingBufferLinear::Put(), cRingBufferLinear::Read(), and cRingBufferLinear::Read().

WaitForGet()

void cRingBuffer::WaitForGet ( void )

protected

Definition at line 71 of file ringbuffer.c.

References getTimeout, and readyForGet.

Referenced by cRingBufferLinear::Get().

WaitForPut()

void cRingBuffer::WaitForPut ( void )

protected

Definition at line 65 of file ringbuffer.c.

References putTimeout, and readyForPut.

Referenced by cRingBufferLinear::Put(), cRingBufferLinear::Read(), and cRingBufferLinear::Read().

Member Data Documentation

getThreadTid

tThreadId cRingBuffer::getThreadTid

protected

Definition at line 27 of file ringbuffer.h.

Referenced by cRingBuffer(), cRingBufferLinear::Get(), and UpdatePercentage().

getTimeout

int cRingBuffer::getTimeout

private

Definition at line 20 of file ringbuffer.h.

Referenced by cRingBuffer(), EnableGet(), SetTimeouts(), and WaitForGet().

ioThrottle

cIoThrottle* cRingBuffer::ioThrottle

private

Definition at line 25 of file ringbuffer.h.

Referenced by cRingBuffer(), SetIoThrottle(), UpdatePercentage(), and ~cRingBuffer().

lastOverflowReport

time_t cRingBuffer::lastOverflowReport

private

Definition at line 22 of file ringbuffer.h.

Referenced by cRingBuffer(), and ReportOverflow().

lastPercent

int cRingBuffer::lastPercent

protected

Definition at line 29 of file ringbuffer.h.

Referenced by cRingBuffer(), and UpdatePercentage().

maxFill

int cRingBuffer::maxFill

protected

Definition at line 28 of file ringbuffer.h.

Referenced by cRingBufferLinear::Clear(), cRingBuffer(), UpdatePercentage(), and ~cRingBuffer().

overflowBytes

int cRingBuffer::overflowBytes

private

Definition at line 24 of file ringbuffer.h.

Referenced by cRingBuffer(), and ReportOverflow().

overflowCount

int cRingBuffer::overflowCount

private

Definition at line 23 of file ringbuffer.h.

Referenced by cRingBuffer(), and ReportOverflow().

putTimeout

int cRingBuffer::putTimeout

private

Definition at line 19 of file ringbuffer.h.

Referenced by cRingBuffer(), EnablePut(), SetTimeouts(), and WaitForPut().

readyForGet

cCondWait cRingBuffer::readyForGet

private

Definition at line 18 of file ringbuffer.h.

Referenced by EnableGet(), and WaitForGet().

readyForPut

cCondWait cRingBuffer::readyForPut

private

Definition at line 18 of file ringbuffer.h.

Referenced by EnablePut(), and WaitForPut().

size

int cRingBuffer::size

private

Definition at line 21 of file ringbuffer.h.

Referenced by cRingBuffer(), Size(), and ~cRingBuffer().

statistics

bool cRingBuffer::statistics

protected

Definition at line 30 of file ringbuffer.h.

Referenced by cRingBuffer(), cRingBufferLinear::Put(), cRingBufferLinear::Read(), cRingBufferLinear::Read(), and ~cRingBuffer().

---

The documentation for this class was generated from the following files:

• ringbuffer.h
• ringbuffer.c