Buffer.hpp

Go to the documentation of this file.

// ======================================================================
// \title  Buffer.hpp
// \author mstarch
// \brief  hpp file for Fw::Buffer definition
//
// \copyright
// Copyright 2009-2020, by the California Institute of Technology.
// ALL RIGHTS RESERVED.  United States Government Sponsorship
// acknowledged.
//
// ======================================================================
#ifndef BUFFER_HPP_
#define BUFFER_HPP_

#include <Fw/FPrimeBasicTypes.hpp>
#include <Fw/Types/Serializable.hpp>
#if FW_SERIALIZABLE_TO_STRING
#include <Fw/Types/StringType.hpp>
#ifdef BUILD_UT
#include <Fw/Types/String.hpp>
#include <iostream>
#endif
#endif

// Forward declaration for UTs
namespace Fw {
class BufferTester;
}

namespace Fw {

class Buffer : public Fw::Serializable {
    friend class Fw::BufferTester;

  public:
    enum class OwnershipState {
        NOT_OWNED,  
        OWNED,      
    };

  public:
    using SizeType = FwSizeType;

    enum {
        SERIALIZED_SIZE = 3 * sizeof(SizeType) + sizeof(U32) + sizeof(U8*),  
        NO_CONTEXT = 0xFFFFFFFF                                              
    };

    Buffer();

    Buffer(const Buffer& src);

    Buffer(U8* data, FwSizeType size, U32 context = NO_CONTEXT);

    Buffer& operator=(const Buffer& src);

    bool operator==(const Buffer& src) const;

    // ----------------------------------------------------------------------
    // Serialization functions
    // ----------------------------------------------------------------------

    DEPRECATED(LinearBufferBase& getSerializeRepr(), "Switch to .getSerializer() and .getDeserializer()");

    ExternalSerializeBufferWithMemberCopy getSerializer();

    ExternalSerializeBufferWithMemberCopy getDeserializer();

    Fw::SerializeStatus serializeTo(Fw::SerialBufferBase& serialBuffer,
                                    Fw::Endianness mode = Fw::Endianness::BIG) const;

    Fw::SerializeStatus deserializeFrom(Fw::SerialBufferBase& buffer, Fw::Endianness mode = Fw::Endianness::BIG);

    // ----------------------------------------------------------------------
    // Accessor functions
    // ----------------------------------------------------------------------

    bool isValid() const;

    U8* getData() const;

    U8* getOriginalData() const;

    FwSizeType getSize() const;

    FwSizeType getCapacity() const;

    FwSizeType getOffset() const;

    U32 getContext() const;

    void advance(FwSignedSizeType amount);

    void setData(U8* data);

    void setSize(FwSizeType size);

    void setContext(U32 context);

    void set(U8* data, FwSizeType size, U32 context = NO_CONTEXT);

#if FW_SERIALIZABLE_TO_STRING || BUILD_UT
    void toString(Fw::StringBase& text) const;
#endif

#ifdef BUILD_UT
    friend std::ostream& operator<<(std::ostream& os, const Buffer& obj);
#endif

  private:
    Fw::ExternalSerializeBuffer m_serialize_repr;  //<! Representation for serialization and deserialization functions
    U8* m_bufferData;                              //<! data - A pointer to the original allocation
    FwSizeType m_offset;                           //<! offset - Offset of the current data within the allocation
    FwSizeType m_size;                             //<! size - The data size in bytes
    FwSizeType m_capacity;                         //<! capacity - Size of the original allocation in bytes
    U32 m_context;                                 
};
}  // end namespace Fw
#endif /* BUFFER_HPP_ */