Buffer.h

Go to the documentation of this file.

 
#ifndef __ROGUE_INTERFACES_STREAM_BUFFER_H__
#define __ROGUE_INTERFACES_STREAM_BUFFER_H__
#include "rogue/Directives.h"
 
#include <stdint.h>
 
#include <memory>
 
#include "rogue/interfaces/stream/Frame.h"
 
namespace rogue {
namespace interfaces {
namespace stream {
 
class Pool;
class Frame;
 
class Buffer {
    // Pointer to entity which allocated this buffer
    std::shared_ptr<rogue::interfaces::stream::Pool> source_;
 
    // Pointer to frame containing this buffer
    std::weak_ptr<rogue::interfaces::stream::Frame> frame_;
 
    // Pointer to raw data buffer. Raw pointer is used here!
    uint8_t* data_;
 
    // Meta data used to track this buffer by source
    uint32_t meta_;
 
    // Alloc size of buffer, alloc may be greater than raw size due to buffer allocator
    uint32_t allocSize_;
 
    // Raw size of buffer, size as requested, alloc may be greater
    uint32_t rawSize_;
 
    // Header room of buffer
    uint32_t headRoom_;
 
    // Tail room of buffer, used to keep payload from using up tail space
    uint32_t tailRoom_;
 
    // Data count including header
    uint32_t payload_;
 
    // Interface specific flags
    uint32_t flags_;
 
    // Error state
    uint32_t error_;
 
  public:
    typedef uint8_t* iterator;
 
    static std::shared_ptr<rogue::interfaces::stream::Buffer> create(
        std::shared_ptr<rogue::interfaces::stream::Pool> source,
        void* data,
        uint32_t meta,
        uint32_t size,
        uint32_t alloc);
 
    Buffer(std::shared_ptr<rogue::interfaces::stream::Pool> source,
           void* data,
           uint32_t meta,
           uint32_t size,
           uint32_t alloc);
 
    ~Buffer();
 
    void setFrame(std::shared_ptr<rogue::interfaces::stream::Frame> frame);
 
    uint32_t getMeta();
 
    void setMeta(uint32_t meta);
 
    void adjustHeader(int32_t value);
 
    void zeroHeader();
 
    void adjustTail(int32_t value);
 
    void zeroTail();
 
    uint8_t* begin();
 
    uint8_t* end();
 
    uint8_t* endPayload();
 
    uint32_t getSize();
 
    uint32_t getAvailable();
 
    uint32_t getPayload();
 
    void setPayload(uint32_t size);
 
    void minPayload(uint32_t size);
 
    void adjustPayload(int32_t value);
 
    void setPayloadFull();
 
    void setPayloadEmpty();
 
    void debug(uint32_t idx);
};
 
typedef std::shared_ptr<rogue::interfaces::stream::Buffer> BufferPtr;
}  // namespace stream
}  // namespace interfaces
}  // namespace rogue
 
#endif