RingBuffer< T, S > Class Template Reference

#include <RingBuffer.hpp>

Public Member Functions
	RingBuffer ()
int	Enqueue (T val)
int	Dequeue (T *buf)
T	Dequeue ()
int	Peek (T *buf)
bool	IsEmpty ()
bool	IsFull ()
int	Length ()
int	Capacity ()
int	Error ()

Private Attributes
T	data [S]
size_t	head
size_t	tail
size_t	length
int	error

Detailed Description

template<typename T, size_t S>
class RingBuffer< T, S >

Definition at line 19 of file RingBuffer.hpp.

Constructor & Destructor Documentation

RingBuffer()

template<typename T , size_t S>

RingBuffer< T, S >::RingBuffer ( )

inlineexplicit

Initializes the circular buffer and allocates the data memory.

Definition at line 25 of file RingBuffer.hpp.

        : head(0)
        , tail(0)
        , length(0)
        , error(0)
    {
        // Default constructor
    }

Member Function Documentation

Capacity()

template<typename T , size_t S>

int RingBuffer< T, S >::Capacity ( )

inline

Returns the buffer capacity (in number of bytes).

Returns

int Buffer capacity in bytes

Definition at line 162 of file RingBuffer.hpp.

    {
        return S;
    }

Dequeue() [1/2]

template<typename T , size_t S>

T RingBuffer< T, S >::Dequeue ( )

inline

Dequeues from the circular buffer and returns the data.

Returns

T Returns dequeued data.

Definition at line 86 of file RingBuffer.hpp.

    {
        T val = 0;
        // Check if the buffer is empty. If so, we can't dequeue
        if (IsEmpty()) {
            error = InvalidValue;
        } else {
            // Read out the data and decrement the position
            val = this->data[this->tail];
            this->tail = ((this->tail + 1) % S);
            --this->length;
        }
        // Return the status code
        return val;
    }

Here is the call graph for this function:

Dequeue() [2/2]

template<typename T , size_t S>

int RingBuffer< T, S >::Dequeue ( T *  buf )

inline

Dequeues from the circular buffer and writes the value to the data pointer.

Parameters

buf	Buffer to contain the data

Returns

int Returns 0 on success and -1 on error.

Definition at line 63 of file RingBuffer.hpp.

    {
        int status = 0;
        // Check if the buffer is empty. If so, we can't dequeue
        if (IsEmpty()) {
            status = -1;
            error = InvalidValue;
        } else {
            // Read out the data and decrement the position
            *buf = this->data[this->tail];
            this->tail = ((this->tail + 1) % S);
            --this->length;
        }
        // Return the status code
        return status;
    }

Here is the call graph for this function:

Enqueue()

template<typename T , size_t S>

int RingBuffer< T, S >::Enqueue ( T  val )

inline

Writes a byte into the circular buffer.

Parameters

val	Data to write to the buffer

Definition at line 39 of file RingBuffer.hpp.

    {
        int status = 0;
        // Check if the buffer is full. If so, we can't enqueue.
        if (IsFull()) {
            status = -1;
            error = BufferFull;
        } else {
            // Write the data at the write index
            this->data[this->head] = val;
            this->head = ((this->head + 1) % S);
            ++this->length;
        }
        // Return the status code
        return status;
    }

Here is the call graph for this function:

Error()

template<typename T , size_t S>

int RingBuffer< T, S >::Error ( )

inline

Returns the ring buffer error code.

Returns

int Error code

Definition at line 172 of file RingBuffer.hpp.

    {
        return error;
    }

IsEmpty()

template<typename T , size_t S>

bool RingBuffer< T, S >::IsEmpty ( )

inline

Query whether the circular buffer is empty.

Returns

true The buffer is empty

false The buffer is not empty

Definition at line 131 of file RingBuffer.hpp.

    {
        return this->length == 0;
    }

Here is the caller graph for this function:

IsFull()

template<typename T , size_t S>

bool RingBuffer< T, S >::IsFull ( )

inline

Query whether the circular buffer is full.

Returns

true The buffer is full

false The buffer is not full

Definition at line 142 of file RingBuffer.hpp.

    {
        return this->length == S;
    }

Here is the caller graph for this function:

Length()

template<typename T , size_t S>

int RingBuffer< T, S >::Length ( )

inline

Returns the number of items (bytes) in the buffer.

Returns

int Number of bytes available for reading.

Definition at line 152 of file RingBuffer.hpp.

    {
        return this->length;
    }

Peek()

template<typename T , size_t S>

int RingBuffer< T, S >::Peek ( T *  buf )

inline

Grab the latest bytes of data from the buffer without removing it.

Parameters

buf	Buffer to contain the data

Returns

int Returns 0 on success and -1 on error.

Definition at line 109 of file RingBuffer.hpp.

    {
        int status = 0;
        // Check if the buffer is empty. If so, we can't dequeue
        if (IsEmpty()) {
            status = -1;
            error = InvalidValue;
        } else {
            // Read out the data and don't decrement the position
            *buf = this->data[this->tail];
        }
        // Return the status code
        return status;
    }

Here is the call graph for this function:

Field Documentation

data

template<typename T , size_t S>

T RingBuffer< T, S >::data[S]

private

Definition at line 178 of file RingBuffer.hpp.

error

template<typename T , size_t S>

int RingBuffer< T, S >::error

private

Definition at line 182 of file RingBuffer.hpp.

head

template<typename T , size_t S>

size_t RingBuffer< T, S >::head

private

Definition at line 179 of file RingBuffer.hpp.

length

template<typename T , size_t S>

size_t RingBuffer< T, S >::length

private

Definition at line 181 of file RingBuffer.hpp.

tail

template<typename T , size_t S>

size_t RingBuffer< T, S >::tail

private

Definition at line 180 of file RingBuffer.hpp.

---

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

• RingBuffer.hpp