RingBufferVoid Class Reference

Thread-safe ring buffer for storing void pointers. More...

#include <RingBuffer.h>

Inheritance diagram for RingBufferVoid:

Collaboration diagram for RingBufferVoid:

Public Member Functions
	RingBufferVoid (const bool freeOnCleanup=true)
virtual	~RingBufferVoid ()
bool	isEmpty ()
void	freeAll ()
void	push (void *item)
void *	pop ()
void *	peek ()

Protected Attributes
ListEntry< void * > *	start_
ListEntry< void * > *	end_
const bool	freeOnCleanup_
Mutex	mutex_

Private Member Functions
	RingBufferVoid (const RingBufferVoid &old)

Detailed Description

Thread-safe ring buffer for storing void pointers.

• On Construction: start_ = end_ = NULL
• On push(T1), start_ = end_ = ListEntry1(T1–>ListEntry1);
• On push(T2), start_ = ListEntry1(T1–>ListEntry2), end_ = ListEntry2(T2–>ListEntry1);
• On push(T3), start_ = ListEntry1(T1–>ListEntry2), end_ = ListEntry3(T3–>ListEntry1);
• On pop()–>T1, start_ = ListEntry2(T2–>ListEntry3), end_ = ListEntry3(T3–>ListEntry1);
• On pop()–>T2, start_ = ListEntry3(T3–>ListEntry1), end_ = ListEntry3(T3–>ListEntry1);
• On pop()–>T3, start_ = NULL, end_ = ListEntry3(T3–>ListEntry1);
• On push(T4), start_ = end_ = ListEntry3(T3–>ListEntry1);
• On push(T5), start_ = ListEntry3(T3–>ListEntry2), end_ = ListEntry1(T5–>ListEntry2);
• On pop()–>T4, start_ = end_ = ListEntry1(T5–>ListEntry2);
• On pop()–>T5, start_ = NULL, end_ = ListEntry1(T5–>ListEntry1);
• isEmpty true when start_ == NULL

Constructor & Destructor Documentation

RingBufferVoid::RingBufferVoid

(

const bool

freeOnCleanup = true

)

RingBufferVoid::~RingBufferVoid ( )

virtual

References end_, freeAll(), ListEntry< T >::getNext(), and start_.

RingBufferVoid::RingBufferVoid ( const RingBufferVoid &  old )

private

Member Function Documentation

void RingBufferVoid::freeAll

(

)

References freeOnCleanup_, isEmpty(), and pop().

Referenced by ~RingBufferVoid().

bool RingBufferVoid::isEmpty

(

void

)

References start_.

Referenced by LogQueue::clear(), RingBuffer< LogEntry * >::deleteAll(), freeAll(), LogQueue::isEmpty(), peek(), and pop().

void * RingBufferVoid::peek

(

void

)

References ListEntry< T >::getItem(), isEmpty(), mutex_, and start_.

Referenced by RingBuffer< LogEntry * >::peek().

void * RingBufferVoid::pop

(

void

)

References end_, ListEntry< T >::getItem(), ListEntry< T >::getNext(), isEmpty(), mutex_, and start_.

Referenced by freeAll(), and RingBuffer< LogEntry * >::pop().

void RingBufferVoid::push

(

void *

item

)

References end_, ListEntry< T >::getNext(), mutex_, ListEntry< T >::setItem(), and start_.

Referenced by RingBuffer< LogEntry * >::push().

Member Data Documentation

ListEntry<void*>* RingBufferVoid::end_

protected

Referenced by pop(), push(), and ~RingBufferVoid().

const bool RingBufferVoid::freeOnCleanup_

protected

Referenced by RingBuffer< LogEntry * >::deleteAll(), and freeAll().

Mutex RingBufferVoid::mutex_

protected

Referenced by peek(), pop(), and push().

ListEntry<void*>* RingBufferVoid::start_

protected

Referenced by isEmpty(), peek(), pop(), push(), and ~RingBufferVoid().

---

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

• /Volumes/ubuntu_share/lrauv-application/Source/utils/RingBuffer.h
• /Volumes/ubuntu_share/lrauv-application/Source/utils/RingBuffer.cpp