Transport.h

 
#ifndef ACTIVE_SERIALISE_TRANSPORT
#define ACTIVE_SERIALISE_TRANSPORT
 
#include "Active/Serialise/XML/Item/XMLDateTime.h"
#include "Active/Utility/Memory.h"
 
namespace active::utility {
    
    class BufferIn;
    class BufferOut;
 
}
 
namespace active::serialise {
    
    class Cargo;
    struct Identity;
 
}
 
namespace active::serialise {
    
    class Transport {
    public:
        
        // MARK: - Types
            
        using TimeFormat = std::optional<xml::XMLDateTime::Format>;
        using size_type = utility::Memory::size_type;
        using enum xml::XMLDateTime::Format;
        
        // MARK: - Constructors
        
        Transport(bool isUnknownNameSkipped = false, TimeFormat timeFormat = iso8601) noexcept {
            m_isUnknownNameSkipped = isUnknownNameSkipped;
            m_timeFormat = timeFormat;
        }
        virtual ~Transport() noexcept {}
        
        
        // MARK: - Functions (const)
        
        virtual void send(serialise::Cargo&& cargo, const serialise::Identity& identity, utility::BufferOut&& destination,
                          bool isTabbed = false, bool isLineFeeds = false, bool isNameSpaces = true, bool isProlog = true) const = 0;
        virtual void receive(serialise::Cargo&& cargo, const serialise::Identity& identity, utility::BufferIn&& source) const = 0;
        TimeFormat getTimeFormat() const noexcept { return m_timeFormat; }
        size_type getLastRow() const noexcept { return m_lastRow; }
        size_type getLastColumn() const noexcept { return m_lastColumn; }
        bool isUnknownNameSkipped() const noexcept { return m_isUnknownNameSkipped; }
        
        // MARK: - Functions (mutating)
        
        void setTimeFormat(TimeFormat format) noexcept { m_timeFormat = format; }
        void setUnknownNameSkipped(bool state) noexcept { m_isUnknownNameSkipped = state; }
        
    protected:
        void setLastRow(size_type row) const noexcept { m_lastRow = row; }
        void setLastColumn(size_type col) const noexcept { m_lastColumn = col; }
        
    private:
            //The preferred date/time format
        TimeFormat m_timeFormat = iso8601;
            //The last row read from the data source (can be useful for error diagnostics)
        mutable size_type m_lastRow = 0;
            //The last column read from the data source (can be useful for error diagnostics)
        mutable size_type m_lastColumn = 0;
            //True if unknown tags should be skipped over
        bool m_isUnknownNameSkipped = false;
    };
    
}
 
#endif  //ACTIVE_SERIALISE_TRANSPORT