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 mframe::io {
  class RingBuffer;
}  // namespace mframe::io
 
/* ***************************************************************************************
 * Class/Interface/Struct
 */
class mframe::io::RingBuffer : public mframe::lang::Memory,
                               public mframe::lang::Appendable,
                               public mframe::lang::Readable,
                               public mframe::io::Buffer {
  /* *************************************************************************************
   * Variable
   */
 private:
  volatile uint32 vCount;
  volatile uint32 vHead;
  volatile uint32 vTail;
  volatile bool     vUnlock;
 
  /* *************************************************************************************
   * Abstract Method
   */
 
  /* *************************************************************************************
   * Construct Method
   */
 public:
  RingBuffer(const mframe::lang::Memory& memory);
 
  RingBuffer(int length);
 
  virtual ~RingBuffer(void) override;
 
  /* *************************************************************************************
   * Operator Method
   */
 
  /* *************************************************************************************
   * Public Method <Override> - mframe::lang::Flushable
   */
 public:
  virtual void flush(void) override;
 
  /* *************************************************************************************
   * Public Method <Override> - mframe::io::Buffer
   */
 public:
  virtual mframe::lang::Readable& getReadable(void) override;
 
  virtual mframe::lang::Appendable& getAppendable(void) override;
 
  /* *************************************************************************************
   * Public Method <Override> - mframe::lang::Readable
   */
 public:
  virtual int avariable(void) const override;
 
  virtual int pollByte(char& result) override;
 
  virtual int poll(mframe::lang::Appendable& appendable) override;
 
  virtual int poll(void* pointer, int length) override;
 
  virtual int skip(int length) override;
 
  virtual void lock(bool lock) override;
 
  /* *************************************************************************************
   * Public Method <Override> - mframe::lang::Appendable
   */
 public:
  virtual int remaining(void) const override;
 
  virtual int putByte(const char data) override;
 
  virtual int put(mframe::lang::Readable& readable) override;
 
  virtual int put(const void* pointer, int length) override;
 
  /* *************************************************************************************
   * Public Method <Inline>
   */
 public:
  inline int getSize(void) {
    return static_cast<int>(RingBuffer::vCount);
  }
 
  inline int getHeadPosition(void) {
    return static_cast<int>((this->vHead & (this->vCount - 1)));
  }
 
  inline int getTailPosition(void) {
    return static_cast<int>((this->vTail & (this->vCount - 1)));
  }
 
  /* *************************************************************************************
   * Public Method
   */
 
  /* *************************************************************************************
   * Protected Method
   */
 
  /* *************************************************************************************
   * Private Method
   */
 private:
  void init(void);
 
  int putMult(mframe::lang::Readable* readable, const void* buffer, int length);
 
  int pollMult(mframe::lang::Appendable* appendable, void* buffer, int length);
  /* *************************************************************************************
   * Static Variable
   */
 
  /* *************************************************************************************
   * Static Method
   */
};
 
/* ***************************************************************************************
 * End of file
 */
#endif /* MFRAME_BA359EBF_505B_445E_8A31_2AB82A22FEB8 */