RingBuffer.h

 
#ifndef MFRAME_BA359EBF_505B_445E_8A31_2AB82A22FEB8
#define MFRAME_BA359EBF_505B_445E_8A31_2AB82A22FEB8
 
/* ***************************************************************************************
 * Include
 */
 
//----------------------------------------------------------------------------------------
 
//----------------------------------------------------------------------------------------
#include "./../io/Buffer.h"
#include "./../lang/Memory.h"
 
/* ***************************************************************************************
 * Macro
 */
 
/* ***************************************************************************************
 * Namespace
 */
namespace ufm::io {
  class RingBuffer;
}  // namespace ufm::io
 
/* ***************************************************************************************
 * Class/Interface/Struct
 */
 
class ufm::io::RingBuffer : public ufm::lang::Object,
                            public ufm::lang::Appendable,
                            public ufm::lang::Readable,
                            public ufm::io::Buffer {
  /* *************************************************************************************
   * Variable
   */
 private:
  ufm::lang::Memory vMemory;  
  volatile uint32   vCount;   
  volatile uint32   vHead;    
  volatile uint32   vTail;    
 
  /* *************************************************************************************
   * Abstract Method
   */
 
  /* *************************************************************************************
   * Construct Method
   */
 public:
  RingBuffer(ufm::lang::Memory memory) noexcept;
 
  inline RingBuffer(int length) : RingBuffer(ufm::lang::Memory(length)) {
    return;
  }
 
  inline RingBuffer(void* pointer, int length)
      : RingBuffer(ufm::lang::Memory(pointer, length)) {
    return;
  }
 
  virtual ~RingBuffer(void) override;
 
  /* *************************************************************************************
   * Operator Method
   */
 
  /* *************************************************************************************
   * Override Method - ufm::io::Buffer
   */
 public:
  virtual void clear(void) override;
 
  virtual ufm::lang::Readable& getReadable(void) override;
 
  virtual ufm::lang::Appendable& getAppendable(void) override;
 
  /* *************************************************************************************
   * Override Method - ufm::lang::Readable
   */
 public:
  virtual int avariable(void) const override;
 
  virtual int pollByte(char& result) override;
 
  virtual int poll(ufm::lang::Appendable& appendable) override;
 
  virtual int poll(void* pointer, int length) override;
 
  /* *************************************************************************************
   * Override Method - ufm::lang::Iterable<const char>
   */
 public:
  virtual void forEach(ufm::func::Consumer<const char&>& action) override;
 
  virtual const char* elementAt(int index) const override;
 
  virtual int nextIndex(int index) const override;
 
  virtual ufm::util::Iterator<const char> begin(void) override;
 
  virtual ufm::util::Iterator<const char> end(void) override;
 
  /* *************************************************************************************
   * Override Method - ufm::lang::Appendable
   */
 public:
  virtual int remaining(void) const override;
 
  virtual int putByte(const char data) override;
 
  virtual int put(ufm::lang::Readable& readable) override;
 
  virtual int put(const void* pointer, int length) override;
 
  /* *************************************************************************************
   * Public Method
   */
 public:
  inline int getSize(void) {
    return static_cast<int>(RingBuffer::vCount);
  }
 
  inline int getHeadPosi(void) const {
    return static_cast<int>((this->vHead & (this->vCount - 1)));
  }
 
  inline int getTailPosi(void) const {
    return static_cast<int>((this->vTail & (this->vCount - 1)));
  }
 
  inline ufm::lang::Memory& getMemory(void) {
    return this->vMemory;
  }
 
  /* *************************************************************************************
   * Protected Method
   */
 
  /* *************************************************************************************
   * Private Method
   */
 private:
  int putMult(ufm::lang::Readable* readable, const void* buffer, int length);
 
  int pollMult(ufm::lang::Appendable* appendable, void* buffer, int length);
  /* *************************************************************************************
   * Static Variable
   */
 
  /* *************************************************************************************
   * Static Method
   */
};
 
/* ***************************************************************************************
 * End of file
 */
#endif /* MFRAME_BA359EBF_505B_445E_8A31_2AB82A22FEB8 */