Fields.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/Time.h>
#include <OnixS/CME/ConflatedTCP/messaging/StrRef.h>
#include <OnixS/CME/ConflatedTCP/messaging/Integral.h>

ONIXS_CONFLATEDTCP_MESSAGING_NAMESPACE_BEGIN

/// int32.
typedef Int32 Int32;


/// Unsigned Int16 with NULL.
typedef UInt16 UInt16NULL;


/// uInt32.
typedef UInt32 UInt32;


/// uInt64.
typedef UInt64 UInt64;


/// uInt8.
typedef UInt8 UInt8;


/// `ErrorCodes` type.
ONIXS_CONFLATEDTCP_LTWT_STRUCT ErrorCodes
{
    typedef UInt8 Base;

    enum Enum
    {
        /// Failed authentication.
        HMACReject = 0,

        /// Failed required field validation.
        InvalidValue = 1,

        /// Slow connection.
        SlowConnection = 2,

        /// Unexpected request, see Reason field for details.
        Other = 3
    };

    /// \return a human-readable presentation.
    ONIXS_CONFLATEDTCP_NODISCARD
    static
    std::string
    toString(
        Enum);
};

/// `MDReqRejReason` type.
ONIXS_CONFLATEDTCP_LTWT_STRUCT ReqRejReason
{
    typedef UInt8 Base;

    enum Enum
    {
        /// Unknown Security.
        UnknownSecurity = 0,

        /// Unknown or Invalid Message.
        UnknownMessage = 1,

        /// Unsupported Scope.
        UnsupportedScope = 2,

        /// Other.
        Other = 3
    };

    /// \return a human-readable presentation.
    ONIXS_CONFLATEDTCP_NODISCARD
    static
    std::string
    toString(
        Enum);
};

/// `RequestIDStatus` type.
ONIXS_CONFLATEDTCP_LTWT_STRUCT RequestIDStatus
{
    typedef UInt8 Base;

    enum Enum
    {
        /// Requested subscription scope is fully acknowledged .
        FullAck = 0,

        /// Requested subscription scope is partially acknowledged .
        PartialAck = 1
    };

    /// \return a human-readable presentation.
    ONIXS_CONFLATEDTCP_NODISCARD
    static
    std::string
    toString(
        Enum);
};

/// `SubscriptionReqType` type.
ONIXS_CONFLATEDTCP_LTWT_STRUCT SubscriptionReqType
{
    typedef UInt8 Base;

    enum Enum
    {
        /// Snapshot.
        Snapshot = 0,

        /// Snapshot and updates.
        SnapshotAndUpdates = 1,

        /// Disable previous subscription.
        Unsubscribe = 2
    };

    /// \return a human-readable presentation.
    ONIXS_CONFLATEDTCP_NODISCARD
    static
    std::string
    toString(
        Enum);
};


/// Null value for an optional UInt16NULL field.
typedef
IntegralConstant<UInt16, 65535>
NullUInt16NULL;


/// Null value for an optional UInt32 field.
typedef
IntegralConstant<UInt32, 4294967295>
NullUInt32;



ONIXS_CONFLATEDTCP_MESSAGING_NAMESPACE_END