BFifo.h

Go to the documentation of this file.

/*******************************************************************************
 *  BFifo.h     BFifo class
 *  T.Barnaby,  Beam Ltd,   2013-05-03
 *  Copyright (c) 2022 All Right Reserved, Beam Ltd, https://www.beam.ltd.uk
 *  For license see LICENSE.txt at the root of the beamlib source tree.
 *******************************************************************************
 *
 */
#ifndef BFifo_h
#define BFifo_h
 
#include <BTypes.h>
#include <BError.h>
 
template <class Type> class BFifo {
public:
            BFifo(BUInt size);
            ~BFifo();
 
    void        clear();
 
    BUInt       size();                     
    BError      resize(BUInt size);             
    BError      rebase();                   
 
    BUInt       writeAvailable();               
    BUInt       writeAvailableChunk();              
    BError      write(const Type v);                
    BError      write(const Type* data, BUInt num);     
 
    Type*       writeData();                    
    Type*       writeData(BUInt& num);              
    void        writeDone(BUInt num);               
    void        writeBackup(BUInt num);             
 
    BUInt       readAvailable();                
    BUInt       readAvailableChunk();               
    Type        read();                     
    BError      read(Type* data, BUInt num);            
 
    Type*       readData();                 
    Type*       readData(BUInt& num);               
    void        readDone(BUInt num);
 
    Type        readPos(BUInt pos);             
    void        writePos(BUInt pos, const Type& v);     
    Type&       operator[](int pos);                
 
protected:
    BUInt       osize;                      
    Type*       odata;                      
    volatile BUInt  owritePos;                  
    volatile BUInt  oreadPos;                   
};
 
#include <BFifo.inc>
#endif