RingBuffer.h

Go to the documentation of this file.

//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Project: uLib - User mode library.
// Module: RingBuffer -- A simple circular FIFO data buffer.
// Author: Copyright (c) Love Nystrom
// License: NNOSL (BSD descendant, see NNOSL.txt in the base directory).
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

#ifndef __RingBuffer_h_incl__
#define __RingBuffer_h_incl__

#include <uLib/Common.h>

//==---------------------------------------------------------------------------
//==---------------------------------------------------------------------------


class RingBuffer {
public:
    PVOID   UserData; 

    RingBuffer( PBYTE Array, UINT Size ); 
    RingBuffer( UINT Size );        
    ~RingBuffer();                  


    void    Attach( PBYTE Array, UINT Size );

    void    Clear();                
    void    Discard( UINT nBytes ); 

    UINT    Used();                 
    UINT    Unused();               
    bool    Empty();                
    bool    Full() { return _full; } 
    UINT    Size() { return _size; } 

    //PBYTE   HeadPtr() { return _buffer + _head; } //!< @dt Current insert point.
    //PBYTE   TailPtr() { return _buffer + _tail; } //!< @dt Current fetch point.

    bool    Get( BYTE* Data );      
    bool    Put( BYTE Data );       
    bool    GetBlock( BYTE* Data, UINT nBytes ); 
    bool    PutBlock( BYTE* Data, UINT nBytes ); 

    bool    GetWord( WORD* Data )    { return GetBlock( (PBYTE)Data, sizeof(WORD) ); }
    bool    GetDWord( DWORD* Data )  { return GetBlock( (PBYTE)Data, sizeof(DWORD) ); }
    bool    GetQWord( UINT64* Data ) { return GetBlock( (PBYTE)Data, sizeof(UINT64) ); }

    bool    PutWord( WORD Data )     { return PutBlock( (PBYTE)&Data, sizeof(WORD) ); }
    bool    PutDWord( DWORD Data )   { return PutBlock( (PBYTE)&Data, sizeof(DWORD) ); }
    bool    PutQWord( UINT64 Data )  { return PutBlock( (PBYTE)&Data, sizeof(UINT64) ); }


    bool    GetStr( ASTR Buf, UINT BufLen );


    bool    PutStr( ACSTR Str, UINT Len=0 );


    BYTE& operator[]( UINT Index );

protected:
    PBYTE   _buffer; // Data buffer.
    UINT    _head;   // Write index.
    UINT    _tail;   // Read index.
    UINT    _size;   // For bounds check.
    bool    _full;   // Without a flag the buffer can only use N-1 bytes.
    bool    _dyna;   // Buffer was allocated from heap.
};
typedef RingBuffer* PRingBuffer;
// #ifdef __DOXYGEN__
// typedef class RingBuffer RingBuffer;
// #endif

#define EXCEPTION_RINGBUFFER_INVALID_INDEX \
    MAKE_SOFTEXCEPTION( ERROR_SEVERITY_ERROR, FACILITY_ULIB, ERROR_INVALID_INDEX )

#endif //ndef __RingBuffer_h_incl__
// EOF