SimpleOpenFramingHeader.h

Go to the documentation of this file.

// Copyright Onix Solutions Limited [OnixS]. All rights reserved.
//
// This software owned by Onix Solutions Limited [OnixS] and is
// protected by copyright law and international copyright treaties.
//
// Access to and use of the software is governed by the terms of the applicable
// OnixS Software Services Agreement (the Agreement) and Customer end user license
// agreements granting a non-assignable, non-transferable and non-exclusive license
// to use the software for it's own data processing purposes under the terms defined
// in the Agreement.
//
// Except as otherwise granted within the terms of the Agreement, copying or
// reproduction of any part of this source code or associated reference material
// to any other location for further reproduction or redistribution, and any
// amendments to this copyright notice, are expressly prohibited.
//
// Any reproduction or redistribution for sale or hiring of the Software not in
// accordance with the terms of the Agreement is a violation of copyright law.
//

#pragma once

#include <OnixS/CME/ConflatedTCP/messaging/Fields.h>

ONIXS_CONFLATEDTCP_MESSAGING_NAMESPACE_BEGIN

// CME SBE Version 1.0 Little-endian
ONIXS_CONFLATEDTCP_CONST_OR_CONSTEXPR UInt16 CmeSbeEncodingType = 0xCAFE;

ONIXS_CONFLATEDTCP_DATA_PACKING_BEGIN(1)

/// Simple Open Framing Header.
ONIXS_CONFLATEDTCP_LTWT_CLASS SimpleOpenFramingHeader
{
public:
    /// Initializes the header.
    void setup(UInt16 sz) ONIXS_CONFLATEDTCP_NOTHROW
    {
        encodingType = CmeSbeEncodingType;
        msgSequence = 1;
        msgSendingTime = 0;
        size(sz);
    }

    /// \return the encoding type.
    UInt16 encoding() const ONIXS_CONFLATEDTCP_NOTHROW
    {
        return encodingType;
    }

    /// Sets the sequence.
    void sequence(UInt32 val) ONIXS_CONFLATEDTCP_NOTHROW
    {
        msgSequence = val;
    }

    /// \return the sequence
    UInt32 sequence() const ONIXS_CONFLATEDTCP_NOTHROW
    {
        return msgSequence;
    }

    /// Sets the sendingTime.
    void sendingTime(UInt64 val) ONIXS_CONFLATEDTCP_NOTHROW
    {
        msgSendingTime = val;
    }

    /// \return the sendingTime
    UInt64 sendingTime() const ONIXS_CONFLATEDTCP_NOTHROW
    {
        return msgSendingTime;
    }

    /// Sets the size.
    void size(UInt16 val) ONIXS_CONFLATEDTCP_NOTHROW
    {
        msgSize = val;
    }

    /// \return the size
    UInt16 size() const ONIXS_CONFLATEDTCP_NOTHROW
    {
        return msgSize;
    }

    private:
    UInt16 encodingType;
    UInt32 msgSequence;
    UInt64 msgSendingTime;
    UInt16 msgSize;

};

ONIXS_CONFLATEDTCP_DATA_PACKING_END

/// Serializes SimpleOpenFramingHeader into a string.
ONIXS_CONFLATEDTCP_EXPORTED
void toStr(std::string&, const SimpleOpenFramingHeader&);

inline
std::string toStr(const SimpleOpenFramingHeader& header)
{
    std::string res;
    toStr(res, header);
    return res;
}

ONIXS_CONFLATEDTCP_MESSAGING_NAMESPACE_END