CriticalBuf Class Reference

a buffer class where all access (read or write) to the buffer is protected by critical sections More...

#include <CriticalBuf.h>

Inheritance diagram for CriticalBuf:

Public Member Functions
	CriticalBuf (void)
	~CriticalBuf (void)
void	Get (void *buf)
void	Set (void *buf)
bool	Init (unsigned int bufLen)
	CriticalBuf (void)
	~CriticalBuf (void)
void	Get (void *buf)
void	Set (void *buf)
bool	Init (unsigned int bufLen)

Private Attributes
byte *	m_buf
	pointer to the buffer More...
unsigned int	m_bufLen
	length of m_buf in bytes More...

Detailed Description

a buffer class where all access (read or write) to the buffer is protected by critical sections

Constructor & Destructor Documentation

CriticalBuf::CriticalBuf

(

void

)

References m_buf, and m_bufLen.

{
   m_buf    = NULL;
   m_bufLen = 0;
}

CriticalBuf::~CriticalBuf

(

void

)

References m_buf.

{
   if (m_buf != NULL)
   {
      delete [] m_buf;
   }
}

CriticalBuf::CriticalBuf

(

void

)

CriticalBuf::~CriticalBuf

(

void

)

Member Function Documentation

void CriticalBuf::Get

(

void *

buf

)

References m_buf, and m_bufLen.

Referenced by ImageAcquisition::GetFrame().

{
   if (buf != NULL)
   {
      Lock();

      if (m_buf != NULL)
      {
         memcpy(buf, m_buf, m_bufLen); // copy m_buf into buf (buf must be at least m_bufLen bytes)
      }

      Unlock();
   }
}

Here is the caller graph for this function:

void CriticalBuf::Get

(

void *

buf

)

bool CriticalBuf::Init

(

unsigned int

bufLen

)

bool CriticalBuf::Init

(

unsigned int

bufLen

)

References m_buf, and m_bufLen.

Referenced by ImageAcquisition::Init().

{
   bool  success;

   Lock();
   
   if (m_buf != NULL)
   {
      delete [] m_buf;
   }

   m_bufLen = bufLen;
   m_buf    = new byte[m_bufLen];
   success  = m_buf != NULL;

   Unlock();

   return success;
}

Here is the caller graph for this function:

void CriticalBuf::Set

(

void *

buf

)

References m_buf, and m_bufLen.

Referenced by ImageAcquisition::ThreadProc().

{
   if (buf != NULL)
   {
      Lock();

      if (m_buf != NULL)
      {
         memcpy(m_buf, buf, m_bufLen); // copy buf into m_buf
      }

      Unlock();
   }
}

Here is the caller graph for this function:

void CriticalBuf::Set

(

void *

buf

)

Member Data Documentation

byte * CriticalBuf::m_buf

private

pointer to the buffer

Referenced by CriticalBuf(), Get(), Init(), Set(), and ~CriticalBuf().

unsigned int CriticalBuf::m_bufLen

private

length of m_buf in bytes

Referenced by CriticalBuf(), Get(), Init(), and Set().

---

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

• CriticalBuf.h
• CriticalBuf.cpp