CRingBuffer Class Reference

#include <RingBuffer.h>

Public Member Functions
	CRingBuffer (void)
	CRingBuffer (int rsz, int dsz)
virtual	~CRingBuffer (void)
BOOL	init (int ring_size, int data_size)
void	free (void)
void	clear (void)
void *	get (void)
void *	get (int pos)
void	put (void *ptr)
void	put (void *ptr, int pos)

Public Attributes
int	state
BOOL	enable

Protected Member Functions
void	init_data (void)

Protected Attributes
void **	buf
int	bufsz
int	datasz
int	spoint
int	epoint
int	datano

Detailed Description

Definition at line 16 of file RingBuffer.h.

Constructor & Destructor Documentation

CRingBuffer() [1/2]

CRingBuffer ( void )

inline

Definition at line 19 of file RingBuffer.h.

{ init_data();}

References CRingBuffer::init_data().

Here is the call graph for this function:

CRingBuffer() [2/2]

CRingBuffer ( int rsz, int dsz )

inline

Definition at line 20 of file RingBuffer.h.

{ init(rsz, dsz);}

References CRingBuffer::init().

Here is the call graph for this function:

~CRingBuffer()

virtual ~CRingBuffer ( void )

inlinevirtual

Definition at line 21 of file RingBuffer.h.

{ free();}

References CRingBuffer::free().

Here is the call graph for this function:

Member Function Documentation

clear()

void clear

(

void

)

Definition at line 69 of file RingBuffer.cpp.

{
    for (int i=0; i<bufsz; i++) {
        memset(buf[i], 0, datasz);
    }
    spoint  = 0;
    epoint  = 0;
    datano  = 0;
    state   = 0;
 
    return;
}

References CRingBuffer::buf, CRingBuffer::bufsz, CRingBuffer::datano, CRingBuffer::datasz, CRingBuffer::epoint, CRingBuffer::spoint, and CRingBuffer::state.

free()

void free

(

void

)

Definition at line 53 of file RingBuffer.cpp.

{
    if (!isNull(buf)) {
        for (int i=0; i<bufsz; i++) {
            if (!isNull(buf[i])) {
                ::free(buf[i]);
            }
        }
        ::free(buf);
    }    
    init_data();
 
    return;
}

References CRingBuffer::buf, CRingBuffer::bufsz, CRingBuffer::free(), CRingBuffer::init_data(), and jbxl::isNull().

Referenced by CRingBuffer::free(), CRingBuffer::init(), and CRingBuffer::~CRingBuffer().

Here is the call graph for this function:

Here is the caller graph for this function:

get() [1/2]

void * get

(

int

pos

)

Definition at line 98 of file RingBuffer.cpp.

{
    pos = epoint + pos;
    if (pos<0) pos = bufsz + pos % bufsz;
    else       pos = pos % bufsz;
 
    return buf[pos];
}

References CRingBuffer::buf, CRingBuffer::bufsz, and CRingBuffer::epoint.

get() [2/2]

void * get

(

void

)

Definition at line 83 of file RingBuffer.cpp.

{
    void* ptr = NULL;
 
    if (datano>0) {
        ptr = buf[spoint];
        spoint++;
        if (spoint==bufsz) spoint = 0;
        datano--;
    }
 
    return ptr;
}

References CRingBuffer::buf, CRingBuffer::bufsz, CRingBuffer::datano, and CRingBuffer::spoint.

init()

BOOL init	(	int	ring_size,
		int	data_size )

Definition at line 26 of file RingBuffer.cpp.

{
    init_data();
 
    buf = (void**)malloc(ring_size*sizeof(void*));
    if (buf==NULL) return FALSE;
    memset(buf, 0, ring_size*sizeof(void*));
    bufsz  = ring_size;
    datasz = data_size;
 
    BOOL ret = TRUE;
    for (int i=0; i<bufsz; i++) {
        buf[i] = (void*)malloc(datasz);
        if (buf[i]==NULL) {
            this->free();
            ret = FALSE;
            state = -1;
            break;
        }
        memset(buf[i], 0, datasz);
    }
 
    if (ret) enable = TRUE;
    return ret;
}

References CRingBuffer::buf, CRingBuffer::bufsz, CRingBuffer::datasz, CRingBuffer::enable, FALSE, CRingBuffer::free(), CRingBuffer::init_data(), CRingBuffer::state, and TRUE.

Referenced by CRingBuffer::CRingBuffer().

Here is the call graph for this function:

Here is the caller graph for this function:

init_data()

void init_data ( void )

protected

Definition at line 13 of file RingBuffer.cpp.

{
    buf     = NULL;
    bufsz   = 0;
    datasz  = 0;
    spoint  = 0;
    epoint  = 0;
    datano  = 0;
    state   = 0;
    enable  = FALSE;
}

References CRingBuffer::buf, CRingBuffer::bufsz, CRingBuffer::datano, CRingBuffer::datasz, CRingBuffer::enable, CRingBuffer::epoint, FALSE, CRingBuffer::spoint, and CRingBuffer::state.

Referenced by CRingBuffer::CRingBuffer(), CRingBuffer::free(), and CRingBuffer::init().

Here is the caller graph for this function:

put() [1/2]

void put

(

void *

ptr

)

Definition at line 108 of file RingBuffer.cpp.

{
    memcpy(buf[epoint], ptr, datasz);
    epoint++;
    if (epoint==bufsz) epoint = 0;
    if (datano<bufsz)  datano++;
 
    return;
}

References CRingBuffer::buf, CRingBuffer::bufsz, CRingBuffer::datano, CRingBuffer::datasz, and CRingBuffer::epoint.

put() [2/2]

void put	(	void *	ptr,
		int	pos )

Definition at line 119 of file RingBuffer.cpp.

{
    pos = epoint + pos;
    if (pos<0) pos = bufsz + pos % bufsz;
    else       pos = pos % bufsz;
 
    memcpy(buf[pos], ptr, datasz);
 
    return;
}

References CRingBuffer::buf, CRingBuffer::bufsz, CRingBuffer::datasz, and CRingBuffer::epoint.

Member Data Documentation

buf

void** buf

protected

Definition at line 24 of file RingBuffer.h.

Referenced by CRingBuffer::clear(), CRingBuffer::free(), CRingBuffer::get(), CRingBuffer::get(), CRingBuffer::init(), CRingBuffer::init_data(), CRingBuffer::put(), and CRingBuffer::put().

bufsz

int bufsz

protected

Definition at line 26 of file RingBuffer.h.

Referenced by CRingBuffer::clear(), CRingBuffer::free(), CRingBuffer::get(), CRingBuffer::get(), CRingBuffer::init(), CRingBuffer::init_data(), CRingBuffer::put(), and CRingBuffer::put().

datano

int datano

protected

Definition at line 30 of file RingBuffer.h.

Referenced by CRingBuffer::clear(), CRingBuffer::get(), CRingBuffer::init_data(), and CRingBuffer::put().

datasz

int datasz

protected

Definition at line 27 of file RingBuffer.h.

Referenced by CRingBuffer::clear(), CRingBuffer::init(), CRingBuffer::init_data(), CRingBuffer::put(), and CRingBuffer::put().

enable

BOOL enable

Definition at line 34 of file RingBuffer.h.

Referenced by CRingBuffer::init(), and CRingBuffer::init_data().

epoint

int epoint

protected

Definition at line 29 of file RingBuffer.h.

Referenced by CRingBuffer::clear(), CRingBuffer::get(), CRingBuffer::init_data(), CRingBuffer::put(), and CRingBuffer::put().

spoint

int spoint

protected

Definition at line 28 of file RingBuffer.h.

Referenced by CRingBuffer::clear(), CRingBuffer::get(), and CRingBuffer::init_data().

state

int state

Definition at line 33 of file RingBuffer.h.

Referenced by CRingBuffer::clear(), CRingBuffer::init(), and CRingBuffer::init_data().

---

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

• BasicLib/RingBuffer.h
• BasicLib/RingBuffer.cpp