Gray C++ Libraries  0.0.2
A set of C++ libraries for MSVC, GNU on Windows, WinCE, Linux
Classes | Public Member Functions | List of all members
Gray::cQueueChunked< TYPE > Class Template Reference

#include <cQueue.h>

Classes

class  cQueueChunk
 

Public Member Functions

 cQueueChunked (ITERATE_t nGrowSizeChunk)
 
 ~cQueueChunked ()
 
bool isEmptyQ () const
 
void EmptyQ ()
 
ITERATE_t get_ReadQtyT () const
 
ITERATE_t get_ReadQtyC () const
 
const TYPE * get_ReadPtrC () const
 
void AdvanceRead (ITERATE_t iCount=1)
 
ITERATE_t get_WriteQty (void) const
 
TYPE * GetWritePrepared (ITERATE_t iDesiredCount=1)
 
void AdvanceWrite (ITERATE_t iCount=1)
 
TYPE Read1 (void)
 
ITERATE_t ReadQty (TYPE *pBuf, ITERATE_t nCountMax)
 
void WriteQ (TYPE val)
 
HRESULT WriteQty (const TYPE *pBuf, ITERATE_t nCount)
 

Detailed Description

template<class TYPE = BYTE>
class Gray::cQueueChunked< TYPE >

a list of Q chunks to use as a large queue. Delete chunks when fully read. allocate new chunks when we need to write. No attempt to pool allocated chunks.

Constructor & Destructor Documentation

◆ cQueueChunked()

template<class TYPE = BYTE>
Gray::cQueueChunked< TYPE >::cQueueChunked ( ITERATE_t  nGrowSizeChunk)
inline

◆ ~cQueueChunked()

template<class TYPE = BYTE>
Gray::cQueueChunked< TYPE >::~cQueueChunked ( )
inline

Member Function Documentation

◆ AdvanceRead()

template<class TYPE = BYTE>
void Gray::cQueueChunked< TYPE >::AdvanceRead ( ITERATE_t  iCount = 1)
inline

Destructive read.

◆ AdvanceWrite()

template<class TYPE = BYTE>
void Gray::cQueueChunked< TYPE >::AdvanceWrite ( ITERATE_t  iCount = 1)
inline

◆ EmptyQ()

template<class TYPE = BYTE>
void Gray::cQueueChunked< TYPE >::EmptyQ ( )
inline

◆ get_ReadPtrC()

template<class TYPE = BYTE>
const TYPE* Gray::cQueueChunked< TYPE >::get_ReadPtrC ( ) const
inline

C = contiguous entries in the first block.

Returns
a pointer to new data.

◆ get_ReadQtyC()

template<class TYPE = BYTE>
ITERATE_t Gray::cQueueChunked< TYPE >::get_ReadQtyC ( ) const
inline

C = get contiguous entries in the first block.

◆ get_ReadQtyT()

template<class TYPE = BYTE>
ITERATE_t Gray::cQueueChunked< TYPE >::get_ReadQtyT ( ) const
inline

get total number of entries

◆ get_WriteQty()

template<class TYPE = BYTE>
ITERATE_t Gray::cQueueChunked< TYPE >::get_WriteQty ( void  ) const
inline

Qty Avail to be written to.

◆ GetWritePrepared()

template<class TYPE = BYTE>
TYPE* Gray::cQueueChunked< TYPE >::GetWritePrepared ( ITERATE_t  iDesiredCount = 1)
inline

Use get_WriteQty() to check size. iDesiredCount of TYPE

◆ isEmptyQ()

template<class TYPE = BYTE>
bool Gray::cQueueChunked< TYPE >::isEmptyQ ( ) const
inline

◆ Read1()

template<class TYPE = BYTE>
TYPE Gray::cQueueChunked< TYPE >::Read1 ( void  )
inline

◆ ReadQty()

template<class TYPE = BYTE>
ITERATE_t Gray::cQueueChunked< TYPE >::ReadQty ( TYPE *  pBuf,
ITERATE_t  nCountMax 
)
inline

copy data out.

◆ WriteQ()

template<class TYPE = BYTE>
void Gray::cQueueChunked< TYPE >::WriteQ ( TYPE  val)
inline

◆ WriteQty()

template<class TYPE = BYTE>
HRESULT Gray::cQueueChunked< TYPE >::WriteQty ( const TYPE *  pBuf,
ITERATE_t  nCount 
)
inline

copy data in.

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