FeedSettings.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 <string>
 
#include <OnixS/CME/ConflatedUDP/Integral.h>
#include <OnixS/CME/ConflatedUDP/PacketTraits.h>
#include <OnixS/CME/ConflatedUDP/SettingGroup.h>
 
ONIXS_CONFLATEDUDP_NAMESPACE_BEGIN
 
// A bit of forward declarations.
 
ONIXS_CONFLATEDUDP_EXPORTED_CLASS_DECL
(
    NetFeedEngine
);

template
<
    typename Layout
>
class 
FeedSettingsBase
{
    const SettingGroup& group_;
 
    Layout layout_;
    UInt32 heartbeatInterval_;
 
    std::string feedANetworkInterfaces_;
    std::string feedBNetworkInterfaces_;
 
    FeedSettingsBase&
    operator =(
        const 
        FeedSettingsBase& other);
 
protected:
    // Makes assignment more flexible. 
    friend
    ONIXS_CONFLATEDUDP_LTWT_CLASS_DECL
    (
        FeedSettings
    );

    FeedSettingsBase(
        const SettingGroup* group, 
        Layout layout, UInt32 heartbeat)
        : group_(
            group
            ? *group
            : SettingGroup::null())
        , layout_(layout)
        , heartbeatInterval_(heartbeat)
    {
    }

    FeedSettingsBase(
        const 
        FeedSettingsBase& other)
        : group_(
            SettingGroup::null())
        , layout_(
            other.layout_)
        , heartbeatInterval_(
            other.heartbeatInterval_)
        , feedANetworkInterfaces_(
            other.feedANetworkInterfaces_)
        , feedBNetworkInterfaces_(
            other.feedBNetworkInterfaces_)
    {
    }
 
    // Finalizes the instance. 
    ~FeedSettingsBase()
    {
    }

    const 
    SettingGroup& 
    group() const
    {
        return group_;
    }

    void
    assignNoControl(
        const FeedSettingsBase& other)
    {
        layout_ = 
            other.layout_;
 
        heartbeatInterval_ = 
            other.heartbeatInterval_;
 
        feedANetworkInterfaces_ =
            other.feedANetworkInterfaces_;
 
        feedBNetworkInterfaces_ = 
            other.feedBNetworkInterfaces_;
    }
 
public:
    Layout layout() const
    {
        return layout_;
    }

    void 
    layout(
        Layout value)
    {
        group_.
            controlAssignment
            (
                "Layout",
                layout_, 
                value
            );
    }

    UInt32 
    heartbeatInterval() const
    {
        return heartbeatInterval_;
    }

    void 
    heartbeatInterval(
        UInt32 interval)
    {
        group_.
            controlAssignment
            (
                "Heartbeat Interval",
                heartbeatInterval_, 
                interval
            );
    }

    const 
    std::string& 
    feedANetworkInterfaces() const
    {
        return feedANetworkInterfaces_;
    }

    void 
    feedANetworkInterfaces(
        const std::string& interfaces)
    {
        group_.
            controlAssignment
            (
                "Feed A Network Interfaces",
                feedANetworkInterfaces_, 
                interfaces
            );
    }

    const 
    std::string& 
    feedBNetworkInterfaces() const
    {
        return feedBNetworkInterfaces_;
    }

    void 
    feedBNetworkInterfaces(
        const std::string& interfaces)
    {
        group_.
            controlAssignment
            (
                "Feed B Network Interfaces",
                feedBNetworkInterfaces_, 
                interfaces
            );
    }
};

ONIXS_CONFLATEDUDP_LTWT_STRUCT RecoveryFeedLayout
{
    typedef UInt32 Base;
 
    enum Enum
    {
        FeedAOnly,

        FeedBOnly,

        FeedAWithFailoverToFeedB,

        FeedBWithFailoverToFeedA
    };
};

ONIXS_CONFLATEDUDP_EXPORTED
void
toStr(
    std::string&, 
    RecoveryFeedLayout::Enum);

inline 
std::string
toStr(
    RecoveryFeedLayout::Enum layout)
{
    std::string str;
    
    toStr(str, layout);
    
    return str;
}

ONIXS_CONFLATEDUDP_LTWT_CLASS
MulticastRecoveryFeedSettings
: public FeedSettingsBase
  <
    RecoveryFeedLayout::Enum
  >
{
    friend
    ONIXS_CONFLATEDUDP_LTWT_CLASS_DECL
    (
        FeedSettings
    );
 
    typedef 
    FeedSettingsBase
    <
        RecoveryFeedLayout::Enum
    >
    Base;
 
    void
    assignNoControl(
        const 
        MulticastRecoveryFeedSettings& other)
    {
        Base::assignNoControl(other);
    }
 
public:
    MulticastRecoveryFeedSettings(
        const SettingGroup* group = NULL)
    : Base(
        group, 
        RecoveryFeedLayout::
        FeedAWithFailoverToFeedB,
        30)
    {
    }

    MulticastRecoveryFeedSettings(
        const MulticastRecoveryFeedSettings& other)
        : Base(static_cast<const Base&>(other))
    {
    }

    ~MulticastRecoveryFeedSettings()
    {
    }

    MulticastRecoveryFeedSettings&
    operator =(
        const 
        MulticastRecoveryFeedSettings& other)
    {
        group().
            controlAssignment
            (
                "Multicast Recovery Feed Settings",
                &MulticastRecoveryFeedSettings::assignNoControl,
                *this,
                other
            );
 
        return *this;
    }
};

ONIXS_CONFLATEDUDP_EXPORTED
void
toStr(
    std::string&, 
    const MulticastRecoveryFeedSettings&);

inline
std::string
toStr(
    const 
    MulticastRecoveryFeedSettings& settings)
{
    std::string str;
 
    toStr(str, settings);
 
    return str;
}

ONIXS_CONFLATEDUDP_LTWT_CLASS
TcpRecoveryFeedSettings
: public FeedSettingsBase
  <
    RecoveryFeedLayout::Enum
  >
{
    // Makes assignment more flexible. 
    friend
    ONIXS_CONFLATEDUDP_LTWT_CLASS_DECL
    (
        FeedSettings
    );
 
    typedef 
    FeedSettingsBase
    <
        RecoveryFeedLayout::Enum
    >
    Base;
 
    UInt32 connectionAttempts_;
    UInt32 connectionTimeout_;
    UInt32 sendTimeout_;
 
    void
    assignNoControl(
        const TcpRecoveryFeedSettings& other)
    {
        Base::assignNoControl(other);
 
        connectionAttempts_ = 
            other.connectionAttempts_;
 
        connectionTimeout_ = 
            other.connectionTimeout_;
 
        sendTimeout_ = 
            other.sendTimeout_;
    }
 
public:
    TcpRecoveryFeedSettings(
        const SettingGroup* group = NULL)
        : Base(
            group, 
            RecoveryFeedLayout::
            FeedAOnly,
            2)
        , connectionAttempts_(3)
        , connectionTimeout_(500)
        , sendTimeout_(5000)
    {
    }

    TcpRecoveryFeedSettings(
        const 
        TcpRecoveryFeedSettings& other)
        : Base(
            static_cast
            <const Base&>
            (other))
        , connectionAttempts_(
            other.connectionAttempts_)
        , connectionTimeout_(
            other.connectionTimeout_)
        , sendTimeout_(
            other.sendTimeout_)
    {
    }

    ~TcpRecoveryFeedSettings()
    {
    }

    UInt32 
    connectionAttempts() const
    {
        return connectionAttempts_;
    }

    void 
    connectionAttempts(
        UInt32 attemptQty)
    {
        group().
            controlAssignment
            (
                "Connection Attempts", 
                connectionAttempts_,
                attemptQty
            );
    }

    UInt32 
    connectionTimeout() const
    {
        return connectionTimeout_;
    }

    void 
    connectionTimeout(
        UInt32 connectionTimeout)
    {
        group().
            controlAssignment
            (
                "Connection Timeout",
                connectionTimeout_, 
                connectionTimeout
            );
    }

    UInt32 
    sendTimeout() const
    {
        return sendTimeout_;
    }

    void 
    sendTimeout(
        UInt32 sendTimeout)
    {
        group().
            controlAssignment
            (
                "Send Timeout",
                sendTimeout_, 
                sendTimeout
            );
    }

    TcpRecoveryFeedSettings& 
    operator =(
        const 
        TcpRecoveryFeedSettings& other)
    {
        group().
            controlAssignment
            (
                "TCP Recovery Feed Settings",
                &TcpRecoveryFeedSettings::assignNoControl,
                *this,
                other
            );
 
        return *this;
    }
};

ONIXS_CONFLATEDUDP_EXPORTED
void
toStr(
    std::string&, 
    const TcpRecoveryFeedSettings&);

inline
std::string
toStr(
    const TcpRecoveryFeedSettings& settings)
{
    std::string str;
 
    toStr(str, settings);
 
    return str;
}

ONIXS_CONFLATEDUDP_LTWT_STRUCT RealtimeFeedLayout
{
    typedef UInt32 Base;
 
    enum Enum
    {
        FeedAOnly,

        FeedBOnly,

        FeedAWithFailoverToFeedB,

        FeedBWithFailoverToFeedA,

        BothFeedsWithArbitrage
    };
};

ONIXS_CONFLATEDUDP_EXPORTED
void
toStr(
    std::string&, 
    RealtimeFeedLayout::Enum);

inline 
std::string
toStr(
    RealtimeFeedLayout::Enum layout)
{
    std::string str;
    
    toStr(str, layout);
    
    return str;
}

ONIXS_CONFLATEDUDP_LTWT_CLASS 
RealtimeFeedSettings
: public FeedSettingsBase
  <
    RealtimeFeedLayout::Enum
  >
{
    friend
    ONIXS_CONFLATEDUDP_LTWT_CLASS_DECL
    (
        FeedSettings
    );
 
    typedef 
    FeedSettingsBase
    <
        RealtimeFeedLayout::Enum
    >
    Base;
 
    UInt32 outOfOrderPacketMaxInterval_;
    UInt32 lostPacketWaitTime_;
 
    void
    assignNoControl(
        const RealtimeFeedSettings& other)
    {
        Base::assignNoControl(other);
 
        outOfOrderPacketMaxInterval_ = 
            other.outOfOrderPacketMaxInterval_;
 
        lostPacketWaitTime_ = 
            other.lostPacketWaitTime_;
    }
 
public:
    RealtimeFeedSettings(
        const SettingGroup* group = NULL)
      : Base(
          group, 
          RealtimeFeedLayout::
          BothFeedsWithArbitrage,
          30)
      , outOfOrderPacketMaxInterval_(3)
      , lostPacketWaitTime_(100000)
    {
    }

    RealtimeFeedSettings(
        const 
        RealtimeFeedSettings& other)
        : Base(
            static_cast
            <const Base&>
            (other))
        , outOfOrderPacketMaxInterval_(
            other.outOfOrderPacketMaxInterval_)
        , lostPacketWaitTime_(
            other.lostPacketWaitTime_)
    {
    }

    ~RealtimeFeedSettings()
    {
    }

    UInt32 
    outOfOrderPacketMaxInterval() const
    {
        return outOfOrderPacketMaxInterval_;
    }

    void 
    outOfOrderPacketMaxInterval(
        UInt32 intervalLength)
    {
        group().
            controlAssignment
            (
                "Out Of Order Packet Max Interval",
                outOfOrderPacketMaxInterval_, 
                intervalLength
            );
    }

    UInt32 
    lostPacketWaitTime() const
    {
        return lostPacketWaitTime_;
    }

    void 
    lostPacketWaitTime(
        UInt32 waitTime)
    {
        group().
            controlAssignment
            (
                "Lost Packet Wait Time",
                lostPacketWaitTime_, 
                waitTime
            );
    }

    RealtimeFeedSettings&
    operator =(
        const 
        RealtimeFeedSettings& other)
    {
        group().
            controlAssignment
            (
                "Realtime Feed Settings",
                &RealtimeFeedSettings::assignNoControl,
                *this,
                other
            );
 
        return *this;
    }
};

ONIXS_CONFLATEDUDP_EXPORTED
void
toStr(
    std::string&, 
    const RealtimeFeedSettings&);

inline
std::string
toStr(
    const RealtimeFeedSettings& settings)
{
    std::string str;
 
    toStr(str, settings);
 
    return str;
}

ONIXS_CONFLATEDUDP_LTWT_CLASS 
FeedSettings : public SettingGroup
{
    // To let assignment be controlled 
    // by the master container. 
    friend 
    ONIXS_CONFLATEDUDP_LTWT_CLASS_DECL
    (
        HandlerSettings
    );
 
    std::string connectivityConfigurationFile_;
 
    PacketSize packetMaxSize_;
 
    RealtimeFeedSettings incrementalFeeds_;
 
    MulticastRecoveryFeedSettings instrumentFeeds_;
    MulticastRecoveryFeedSettings snapshotFeeds_;
    MulticastRecoveryFeedSettings mboSnapshotFeeds_;
 
    TcpRecoveryFeedSettings historicalFeeds_;
 
    NetFeedEngine* engine_;
 
    // Casts the given instance to an 
    // instance of SettingGroup class. 
    const 
    SettingGroup& 
    group() const
    {
        return *this;
    }
 
    // Re-initializes the given instance
    // as a copy of the other one without
    // involving assignment control service. 
    void
    assignNoControl(
        const FeedSettings& other)
    {
        connectivityConfigurationFile_ = 
            other.connectivityConfigurationFile_;
 
        packetMaxSize_ = 
            other.packetMaxSize_;
 
        incrementalFeeds_.
            assignNoControl(
                other.incrementalFeeds_);
 
        instrumentFeeds_.
            assignNoControl(
                other.instrumentFeeds_);
 
        snapshotFeeds_.
            assignNoControl(
                other.snapshotFeeds_);
 
        mboSnapshotFeeds_.
            assignNoControl(
                other.mboSnapshotFeeds_);
 
        historicalFeeds_.
            assignNoControl(
                other.historicalFeeds_);
 
        engine_ = other.engine_;
    }
 
    // Updates interfaces for all primary feeds 
    // without involving assignment control services. 
    void 
    assignFeedAInterfaces(
        const std::string& interfaces)
    {
        incrementalFeeds_.
            feedANetworkInterfaces_ = 
 
        instrumentFeeds_.
            feedANetworkInterfaces_ = 
 
        snapshotFeeds_.
            feedANetworkInterfaces_ = 
 
        mboSnapshotFeeds_.
            feedANetworkInterfaces_ = 
 
        historicalFeeds_.
            feedANetworkInterfaces_ = 
 
            interfaces;
    }
 
    // Updates interfaces for all primary feeds 
    // without involving assignment control services. 
    void 
    assignFeedBInterfaces(
        const std::string& interfaces)
    {
        incrementalFeeds_.
            feedBNetworkInterfaces_ = 
 
        instrumentFeeds_.
            feedBNetworkInterfaces_ = 
 
        snapshotFeeds_.
            feedBNetworkInterfaces_ = 
 
        mboSnapshotFeeds_.
            feedBNetworkInterfaces_ = 
 
        historicalFeeds_.
            feedBNetworkInterfaces_ = 
 
            interfaces;
    }
 
public:
    FeedSettings(
        SettingAssignController* 
        controller = NULL)
        : SettingGroup(controller)
        , packetMaxSize_(1420)
        , incrementalFeeds_(&group())
        , instrumentFeeds_(&group())
        , snapshotFeeds_(&group())
        , mboSnapshotFeeds_(&group())
        , historicalFeeds_(&group())
        , engine_(NULL)
    {
    }

    FeedSettings(
        const FeedSettings& other)
        : SettingGroup()
        , connectivityConfigurationFile_(
            other.connectivityConfigurationFile_)
        , packetMaxSize_(
            other.packetMaxSize_)
        , incrementalFeeds_(
            other.incrementalFeeds_)
        , instrumentFeeds_(
            other.instrumentFeeds_)
        , snapshotFeeds_(
            other.snapshotFeeds_)
        , mboSnapshotFeeds_(
            other.mboSnapshotFeeds_)
        , historicalFeeds_(
            other.historicalFeeds_)
        , engine_(
            other.engine_)
    {
    }

    const 
    std::string& 
    connectivityConfigurationFile() const
    {
        return connectivityConfigurationFile_;
    }

    void 
    connectivityConfigurationFile(
        const std::string& configurationFile)
    {
        group().
            controlAssignment
            (
                "Connectivity Configuration File", 
                connectivityConfigurationFile_,
                configurationFile
            );
    }

    void 
    feedANetworkInterfaces(
        const std::string& interfaces)
    {
        group().
            controlAssignment
            (
                "Feed A Network Interfaces for All Feeds",
                &FeedSettings::assignFeedAInterfaces,
                *this,
                interfaces
            );
    }

    void 
    feedBNetworkInterfaces(
        const std::string& interfaces)
    {
        group().
            controlAssignment
            (
                "Feed B Network Interfaces for All Feeds",
                &FeedSettings::assignFeedBInterfaces,
                *this,
                interfaces
            );
    }

    PacketSize packetMaxSize() const
    {
        return packetMaxSize_;
    }

    void 
    packetMaxSize(
        PacketSize value)
    {
        group().
            controlAssignment
            (
                "Packet Max Size", 
                packetMaxSize_,
                value
            );
    }

    const 
    RealtimeFeedSettings& 
    incrementalFeeds() const
    {
        return incrementalFeeds_;
    }

    RealtimeFeedSettings& 
    incrementalFeeds()
    {
        return incrementalFeeds_;
    }

    const 
    MulticastRecoveryFeedSettings& 
    instrumentFeeds() const
    {
        return instrumentFeeds_;
    }

    MulticastRecoveryFeedSettings& 
    instrumentFeeds()
    {
        return instrumentFeeds_;
    }

    const 
    MulticastRecoveryFeedSettings& 
    snapshotFeeds() const
    {
        return snapshotFeeds_;
    }

    MulticastRecoveryFeedSettings& 
    snapshotFeeds()
    {
        return snapshotFeeds_;
    }

    const 
    MulticastRecoveryFeedSettings& 
    mboSnapshotFeeds() const
    {
        return mboSnapshotFeeds_;
    }

    MulticastRecoveryFeedSettings& 
    mboSnapshotFeeds()
    {
        return mboSnapshotFeeds_;
    }

    const 
    TcpRecoveryFeedSettings& 
    historicalFeeds() const
    {
        return historicalFeeds_;
    }

    TcpRecoveryFeedSettings& 
    historicalFeeds()
    {
        return historicalFeeds_;
    }

    NetFeedEngine* engine() const
    {
        return engine_;
    }

    void
    engine(
        NetFeedEngine* engine)
    {
        group().
            controlAssignment
            (
                "Feed Engine", 
                engine_, 
                engine
            );
    }

    FeedSettings&
    operator =(
        const FeedSettings& other)
    {
        group().
            controlAssignment
            (
                "Feed Settings",
                &FeedSettings::assignNoControl,
                *this, 
                other
            );
 
        return *this;
    }
};

ONIXS_CONFLATEDUDP_EXPORTED
void
toStr(
    std::string&, 
    const FeedSettings&);

inline
std::string
toStr(
    const FeedSettings& settings)
{
    std::string str;
 
    toStr(str, settings);
 
    return str;
}
 
ONIXS_CONFLATEDUDP_NAMESPACE_END