ValuesEnums.h

Go to the documentation of this file.

#pragma once

/*
* 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.
*/

#include <string>

#include <OnixS/CME/iLink3/ABI.h>

namespace OnixS
{
namespace CME
{
namespace iLink3
{

template <typename ErrorCodesType>
typename ErrorCodesType::Enum valueToErrorCode(unsigned short value) ONIXS_ILINK3_NOTHROW
{
    return value < ErrorCodesType::NotSet ? static_cast<typename ErrorCodesType::Enum>(value) : ErrorCodesType::NotSet;
}

/**
* Code to identify reason for a <a href="https://www.cmegroup.com/confluence/display/EPICSANDBOX/iLink+3+Business+Reject">Business Message Reject</a> message.
*/
struct BusinessRejectReason
{
    enum Enum
    {
        /// The value is not set.
        NotSet = 255,

        /// Other
        Other = 0,

        /// Unknown ID (unknown PartyDetailsListReqID being referenced in business message)
        UnknownId = 1,

        /// Unknown Security
        UnknownSecurity = 2,

        /// Unsupported Message Type (for example using messages specific to cash markets for futures)
        UnsupportedMessageType = 3,

        /// Required Field Missing
        RequiredFieldMissing = 5,

        /// Not Authorized
        NotAuthorized = 6,

        /// Throttle Limit Exceeded (volume controls)
        ThrottleLimitExceeded = 8,

        /// Value is incorrect(out of range) for this tag (for example using a value outside defined range of integer)
        ValueIsIncorrect = 100,

        /// Incorrect data format for value (for example using ASCII character outside 32 - 126 in string field)
        IncorrectDataFormat = 101,

        /// Rejected due to Kill Switch
        RejectedDueToKillSwitch = 102,

        /// Rejected due to Risk Management API
        RejectedDueToRiskManagementAPI = 103,

        /// Rejected due to Globex Credit Controls
        RejectedDueToGlobexCreditControls = 104,

        /// Not Authorized to trade Deliverable Swap Futures
        NotAuthorizedToTradeDeliverableSwapFutures = 105,

        /// Not Authorized to trade Interest Rate Swap Futures
        NotAuthorizedToTradeInterestRateSwapFutures = 106,

        /// Rejected due to Inline Credit Controls
        RejectedDueToInlineCreditControls = 107,

        /// Invalid PartyDetailsListReqID(reusing already existing PartyDetailsListReqID while creating Party Details Definition Request)
        InvalidPartyDetailsListReqID = 108,

        /// Incoming message could not be decoded
        DecodingError = 109,

        /// Same repeating group entry appears more than once
        RepeatingGroupEntryAppearsMoreThanOnce = 110,

        /// Exceeded maximum number of allowable Party Details Definition Requests
        ExceededMaximumNumberOfPartyDetailsDefinitionRequests = 111,

        /// Technical Error in Registering Party Details
        TechnicalErrorInRegisteringPartyDetails = 112,

        /// Rejected due to Cross Venue Risk
        RejectedDueToCrossVenueRisk = 113,

        /// Order Status Not Available
        OrderStatusNotAvailable = 114,

        /// Enum Not Supported
        EnumNotSupported = 115,

        /// Order Status Not Found
        OrderStatusNotFound = 116,

        /// Mass Order Status Cannot be Completed
        MassOrderStatusCannotBeCompleted = 117,

        /// Exceeded Maximum Number of Allowable RequestingPartyID's in Party Details List Request
        ExceededMaximumNumberOfAllowableRequestingPartyIDsInPartyDetailsListRequest = 118,

        /// Duplicate Order Threshold Exceeded
        DuplicateOrderThresholdExceeded = 119,

        /// On - Demand Message Rejected Due to Preceding Party Details Definition Request Being Rejected
        OnDemandMessageRejectedDueToPrecedingPartyDetailsDefinitionRequestBeingRejected = 120,

        /// Message Rejected Since PartyDetailsListReqID Does Not Match with Immediately Preceding Party Details Definition Request sent to MSGW when using On - demand administrative information
        PartyDetailsListReqIdDoesNotMatch = 121,

        /// Party Details Definition Request sent to MSGW Being Rejected Due to Corresponding Business Message Being Rejected
        CorrespondingBusinessMessageBeingRejected = 122,

        /// Another Message Sent in Between Party Details Definition Request and Business Message when using On - demand administrative information
        AnotherMessageSent = 123,

        /// Cannot Have More Than One In - Flight Mass Order Status Request in Progress
        CannotHaveMoreThanOneInFlightMassOrderStatusRequestInProgress = 124,

        /// Exceeded Maximum Number of In - Flight Order Status Requests
        ExceededMaximumNumberOfInFlightOrderStatusRequests = 125,

        /// Cannot Have More Than One In - Flight Party Details List Request in Progress
        CannotHaveMoreThanOneInFlightPartyDetailsListRequestInProgress = 126,

        /// Party Details List Request is Missing Requesting Party ID and Party ID
        MissingRequestingPartyIdAndPartyId = 127,

        /// Party Details List Request cannot contain both RequestingPartyID and PartyID
        PartyDetailsListRequestCannotContainBothRequestingPartyIdAndPartyId = 128,

        /// Party Details Definition Request Being Rejected Since Another Message was sent in Between On - Demand Message
        AnotherMessageWasSentInBetweenOnDemandMessage = 129,

        /// Buy Side Firm ID Does Not Match Sell Side Firm ID in New Order Cross
        BuySideFirmIdDoesNotMatchSellSideFirmId = 130,

        /// Message Type Not Supported on Backup Instance
        MessageTypeNotSupportedOnBackupInstance = 131,

        /// New Order Cross Does Not Contain Buy Side Followed by Sell Side
        NewOrderCrossDoesNotContainBuySideFollowedBySellSide = 132
    };

    ONIXS_ILINK3_EXPORTED static const char* toString(Enum type) ONIXS_ILINK3_NOTHROW;

    ONIXS_ILINK3_EXPORTED static const char* toString(unsigned short value) ONIXS_ILINK3_NOTHROW;

    static BusinessRejectReason::Enum toRejectReason(unsigned short value) ONIXS_ILINK3_NOTHROW
    {
        return valueToErrorCode<BusinessRejectReason>(value);
    }
};

/**
 * The <a href="https://www.cmegroup.com/confluence/display/EPICSANDBOX/Terminate">Terminate</a> message error codes.
 */
struct TerminateErrorCode
{
    enum Enum
    {
        NotSet = 255, ///< The value is not set
        Finished = 0, ///< session is being terminated without finalization
        Unnegotiated = 2, ///< Sending any message when session has not been Negotiated
        NotEstablished = 3, ///< Sending any message (except Negotiate) when session has not been established
        AlreadyNegotiated = 4, ///< NegotiationResponse was already sent; Negotiate was redundant
        NegotiationInProgress = 5, ///< Previous Negotiate still being processed; Wait for NegotiationResponse or timeout
        AlreadyEstablished = 6, ///< EstablishmentAck was already sent; Establish was redundant
        EstablishInProgress = 7, ///< Previous Establish still being processed; Wait for EstablishmentAck or timeout
        CMEAdministeredPortClosure = 8, ///< due to invalid number of Negotiate: Establish attempts being exceeded
        VolumeControls = 9, ///< exceeding TPS limit as defined for volume controls (logout action)
        InvalidNextSeqNo = 10, ///< value is not greater than the one last used for same UUID or value sent by the client is out of acceptable range (MIN, MAX)
        InvalidMsgSeqNo = 11, ///< value is lower than the last one used for the same UUID or value is not initialized to 1 at the beginning of the week or value sent by the client is out of acceptable range (MIN, MAX)
        InvalidLastSeqNo = 12, ///< value is lower than the last one used for the same UUID or value sent by the client is out of acceptable range (MIN, MAX)
        InvalidUUID = 13, ///< UUID value does not match current UUID or value sent by the client is out of acceptable range (MIN, MAX)
        InvalidTimestamp = 14, ///< Timestamp value does not match with RequestTimestamp sent by CME or value sent by the client is out of acceptable range (MIN, MAX)
        RequiredUUIDMisssing = 15, ///< null value in UUID field
        RequiredRequestTimestampMissing = 16, ///< null value in RequestTimestamp field
        RequiredCodeMisssing = 17, ///< null value in Code field
        InvalidSOFH = 18, ///< Invalid message length or invalid encoding type specified
        DecodingError = 19, ///< Incoming message could not be decoded
        KeepAliveIntervalLapsed = 20, ///< KeepAliveInterval has lapsed without any response so terminating session
        RequiredNextSeqNoMissing = 21, ///< null value in NextSeqNo field
        RequiredKeepAliveIntervalLapsedMissing = 22, ///< null value in KeepAliveIntervalLapsed field
        NonNegotiate = 23, ///< Establish message received when not Negotiated: Established
        TerminateInProgress = 24, ///< Previous Terminate still being processed; Wait for Terminate or timeout
        Other = 25, ///< any other error condition not mentioned above
        DisconnectFromPrimary = 26, ///< Backup session will be terminated as well
    };

    /// \return a string that represents the given value.
    ONIXS_ILINK3_EXPORTED static const char* toString(Enum value) ONIXS_ILINK3_NOTHROW;

    /// \return The TerminateErrorCode::Enum value that corresponds to the given integer value.
    static TerminateErrorCode::Enum toErrorCode(unsigned short value) ONIXS_ILINK3_NOTHROW
    {
        return valueToErrorCode<TerminateErrorCode>(value);
    }
};

/**
* The <a href="https://www.cmegroup.com/confluence/display/EPICSANDBOX/Negotiation+Reject">Negotiation Reject</a> message error codes.
*/
struct NegotiationRejectErrorCode
{
    enum Enum
    {
        NotSet = 255, ///< The value is not set
        HMACNotAuthenticated = 0, ///< failed authentication because identity is not recognized
        HMACNotAvailable = 1, ///< HMAC component is not responding (5 sec)
        InvalidUUID = 2, ///< UUID is not greater than the one last used or value sent by the client is out of acceptable range (MIN, MAX)
        InvalidTimestamp = 3, ///< Timestamp is not greater than the one last used or value sent by the client is out of acceptable range (MIN, MAX)
        RequiredHMACSignatureMissing = 4, ///< empty bytes in HMACSignature field
        RequiredAccessKeyIDMissing = 5, ///< empty bytes in AccessKeyID field
        RequiredSessionMissing = 6, ///< empty bytes in Session field
        RequiredFirmMissing = 7, ///< empty bytes in Firm field
        RequiredUUIDMisssing = 8, ///< null value in UUID field
        RequiredRequestTimestampMissing = 9, ///< null value in RequestTimestamp field
        SessionBlocked = 10, ///< session and firm are not authorized for this port
        InvalidAccessKeyID = 12, ///< contains non-printable ASCII character
        InvalidSession = 13, ///< contains non-printable ASCII character
        InvalidFirm = 14, ///< contains non-printable ASCII character
        VolumeControls = 15, ///< exceeding TPS limit as defined for volume controls (reject action)
        SplitMessageRejected = 16, ///< Messages queued due to split message penalty being rejected because of logout or disconnect
        SplitMessageQueue = 17, ///< Reached threshold of messages queued due to split message penalty
        DesignatedBackup = 27, ///< Using Designated backup before designated primary not allowed
        NegotiateNotAllowed = 28, ///< Not allowed to negotiate on backup when established on primary
    };

    /// \return a string that represents the given value.
    ONIXS_ILINK3_EXPORTED static const char* toString(Enum value) ONIXS_ILINK3_NOTHROW;

    /// \return The NegotiationRejectErrorCode::Enum value that corresponds to the given integer value.
    static NegotiationRejectErrorCode::Enum toErrorCode(unsigned short value) ONIXS_ILINK3_NOTHROW
    {
        return valueToErrorCode<NegotiationRejectErrorCode>(value);
    }
};

/**
* The <a href="https://www.cmegroup.com/confluence/display/EPICSANDBOX/Establishment+Reject">Establishment Reject</a> message error codes.
*/
struct EstablishmentRejectErrorCode
{
    enum Enum
    {
        NotSet = 255, ///< The value is not set
        HMACNotAuthenticated = 0, ///< failed authentication because identity is not recognized
        HMACNotAvailable = 1, ///< HMAC component is not responding (5sec)
        InvalidUUID = 2, ///< UUID is not greater than the one last used or value sent by the client is out of acceptable range (MIN, MAX)
        InvalidTimestamp = 3, ///< Timestamp is not greater than the one last used or value sent by the client is out of acceptable range (MIN, MAX)
        RequiredHMACSignatureMissing = 4, ///< empty bytes in HMACSignature field
        RequiredAccessKeyIDMissing = 5, ///< empty bytes in AccessKeyID field
        RequiredSessionMissing = 6, ///< empty bytes in Session field
        RequiredFirmMissing = 7, ///< empty bytes in Firm field
        RequiredUUIDMisssing = 8, ///< null value in UUID field
        RequiredRequestTimestampMissing = 9, ///< null value in RequestTimestamp field
        SessionBlocked = 10, ///< session and firm are not authorized for this port
        InvalidKeepAliveInterval = 11, ///< value is out of acceptable range (MIN, MAX)
        InvalidAccessKeyID = 12, ///< contains non-printable ASCII character
        InvalidSession = 13, ///< contains non-printable ASCII character
        InvalidFirm = 14, ///< contains non-printable ASCII character
        VolumeControls = 15, ///< exceeding TPS limit as defined for volume controls (reject action)
        SplitMessageRejected = 16, ///< Messages queued due to split message penalty being rejected because of logout or disconnect
        SplitMessageQueue = 17, ///< Reached threshold of messages queued due to split message penalty
        RequiredTradingSystemNameMissing = 18, ///< empty bytes in TradingSystemName
        RequiredTradingSystemVersionMissing = 19, ///< empty bytes in TradingSystemVersion
        RequiredTradingSystemVendorMissing = 20, ///< empty bytes in TradingSystemVendor
        RequiredKeepAliveIntervalMissing = 21, ///< null value in KeepAliveInterval field
        RequiredNextSeqNoMissing = 22, ///< empty bytes in NextSeqNo field
        InvalidTradingSystemName = 23, ///< contains non-prinatable ASCII character
        InvalidTradingSystemVersion = 24, ///< contains non-prinatable ASCII character
        InvalidTradingSystemVendor = 25, ///< contains non-prinatable ASCII character
        DesignatedBackup = 27, ///< Using Designated backup before designated primary not allowed
    };

     /// \return a string that represents the given value.
    ONIXS_ILINK3_EXPORTED static const char* toString(Enum value) ONIXS_ILINK3_NOTHROW;

    /// \return The NegotiationRejectErrorCode::Enum value that corresponds to the given integer value.
    static EstablishmentRejectErrorCode::Enum toErrorCode(unsigned short value) ONIXS_ILINK3_NOTHROW
    {
        return valueToErrorCode<EstablishmentRejectErrorCode>(value);
    }
};

namespace FuturesAndOptions
{

/**
* The <a href="https://www.cmegroup.com/confluence/display/EPICSANDBOX/Futures+and+Options+Reject+Codes">Establishment Reject</a> message error codes.
*/
struct RejectCodes
{
    /// \return a string that represents the given value.
    ONIXS_ILINK3_EXPORTED static const char* toString(unsigned short value) ONIXS_ILINK3_NOTHROW;
};

}


namespace BrokerTec
{

/**
* The <a href="https://www.cmegroup.com/confluence/display/EPICSANDBOX/BrokerTec+Reject+Codes">Establishment Reject</a> message error codes.
*/
struct RejectCodes
{
    /// \return a string that represents the given value.
    ONIXS_ILINK3_EXPORTED static const char* toString(unsigned short value) ONIXS_ILINK3_NOTHROW;
};

}

namespace Ebs
{

/**
* The <a href="https://www.cmegroup.com/confluence/display/EPICSANDBOX/EBS+Reject+Codes">Establishment Reject</a> message error codes.
*/
struct RejectCodes
{
    /// \return a string that represents the given value.
    ONIXS_ILINK3_EXPORTED static const char* toString(unsigned short value) ONIXS_ILINK3_NOTHROW;
};

}





}
}
}