SessionSettings.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/SettingGroup.h>
 
ONIXS_CONFLATEDUDP_NAMESPACE_BEGIN

ONIXS_CONFLATEDUDP_LTWT_STRUCT 
JoinRecoveryOptions
{
    typedef UInt32 Base;

    enum Enum
    {
        Disabled,

        Instruments,

        InstrumentsAndMarketState
    };
};

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

inline
std::string
toStr(
    JoinRecoveryOptions::Enum recovery)
{
    std::string str;
    
    toStr(str, recovery);
    
    return str;
}

ONIXS_CONFLATEDUDP_LTWT_STRUCT 
GapAndErrorHandlingOptions
{
    typedef UInt32 Base;

    enum Enum
    {
        RecoverMarketState,

        RecoverInstrumentsAndMarketState,

        ContinueProcessing
    };
};

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

inline
std::string
toStr(
    GapAndErrorHandlingOptions::Enum handling)
{
    std::string str;
    
    toStr(str, handling);
    
    return str;
}

ONIXS_CONFLATEDUDP_LTWT_STRUCT 
InstrumentRecoveryOptions
{
    typedef UInt32 Base;
 
    enum Enum
    {
        Accurate,

        Fast
    };
};

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

inline 
std::string
toStr(
    InstrumentRecoveryOptions::Enum option)
{
    std::string str;
 
    toStr(str, option);
 
    return str;
}
 
ONIXS_CONFLATEDUDP_EXPORTED_CLASS_DECL
(
    TcpRecoveryService
);

ONIXS_CONFLATEDUDP_LTWT_CLASS 
TcpRecoverySessionSettings
{
    friend 
    ONIXS_CONFLATEDUDP_LTWT_CLASS_DECL
    (
        AdvancedSessionSettings
    );
 
    //
 
    const SettingGroup& group_;
 
    TcpRecoveryService* service_;
 
    UInt32 attempts_;
    UInt32 servingTimeLimit_;
 
    // Re-initializes the instance as a copy of the 
    // other one and bypassing assignment control. 
    void
    assignNoControl(
        const 
        TcpRecoverySessionSettings& other)
    {
        service_ = 
            other.service_;
 
        attempts_ = 
            other.attempts_;
 
        servingTimeLimit_ = 
            other.servingTimeLimit_;
    }
 
public:
    TcpRecoverySessionSettings(
        const SettingGroup* group = NULL)
        : group_(
            group 
            ? *group 
            : SettingGroup::null())
        , service_(NULL)
        , attempts_(1)
        , servingTimeLimit_(10)
    {
    }

    TcpRecoverySessionSettings(
        const TcpRecoverySessionSettings& other)
        : group_(SettingGroup::null())
        , service_(other.service_)
        , attempts_(other.attempts_)
        , servingTimeLimit_(
            other.servingTimeLimit_)
    {
    }

    ~TcpRecoverySessionSettings()
    {
    }

    TcpRecoveryService* 
    service() const
    {
        return service_;
    }

    void
    service(
        TcpRecoveryService* service)
    {
        group_.
            controlAssignment
            (
                "TCP Recovery Service Instance", 
                service_, 
                service
            );
    }

    UInt32
    attempts() const
    {
        return attempts_;
    }

    void
    attempts(
        UInt32 qty)
    {
        group_.
            controlAssignment
            (
                "TCP Recovery Attempt Quantity", 
                attempts_,
                qty
            );
    }

    UInt32 
    servingTimeLimit() const
    {
        return servingTimeLimit_;
    }

    void 
    servingTimeLimit(
        UInt32 servingTimeLimit)
    {
        group_.
            controlAssignment
            (
                "TCP Recovery Serving Time Limit", 
                servingTimeLimit_,
                servingTimeLimit
            );
    }

    TcpRecoverySessionSettings&
    operator =(
        const 
        TcpRecoverySessionSettings& other)
    {
        group_.
            controlAssignment
            (
                "TCP Recovery Session Settings",
                &TcpRecoverySessionSettings::assignNoControl,
                *this,
                other
            );
 
        return *this;
    }
};

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

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

ONIXS_CONFLATEDUDP_LTWT_CLASS SessionSettings : public SettingGroup
{
    JoinRecoveryOptions::Enum joinRecovery_;
    GapAndErrorHandlingOptions::Enum gapAndErrorHandling_;
    
    InstrumentRecoveryOptions::Enum instrumentRecovery_;
 
protected:
    const 
    SettingGroup& 
    group() const
    {
        return *this;
    }

    void
    assignNoControl(
        const SessionSettings& other)
    {
        joinRecovery_ = 
            other.joinRecovery_;
        
        gapAndErrorHandling_ = 
            other.gapAndErrorHandling_;
 
        instrumentRecovery_ = 
            other.instrumentRecovery_;
    }
 
public:
    SessionSettings(
        SettingAssignController* 
        controller = NULL)
        : SettingGroup(controller) 
        , joinRecovery_(
            JoinRecoveryOptions::
                InstrumentsAndMarketState)
        , gapAndErrorHandling_(
            GapAndErrorHandlingOptions::
                RecoverMarketState)
        , instrumentRecovery_(
            InstrumentRecoveryOptions::
            Accurate)
    {
    }

    SessionSettings(
        const SessionSettings& other)
        : SettingGroup()
        , joinRecovery_(
            other.joinRecovery_)
        , gapAndErrorHandling_(
            other.gapAndErrorHandling_)
        , instrumentRecovery_(
            other.instrumentRecovery_)
    {
    }

    ~SessionSettings()
    {
    }

    JoinRecoveryOptions::Enum 
    joinRecovery() const
    {
        return joinRecovery_;
    }

    void 
    joinRecovery(
        JoinRecoveryOptions::Enum recovery)
    {
        group().
            controlAssignment
            (
                "Join Recovery Strategy", 
                joinRecovery_, 
                recovery
            );
    }

    GapAndErrorHandlingOptions::Enum 
    gapAndErrorHandling() const
    {
        return gapAndErrorHandling_;
    }

    void 
    gapAndErrorHandling(
        GapAndErrorHandlingOptions::Enum handling)
    {
        group().
            controlAssignment
            (
                "Gap And Error Handling Strategy",
                gapAndErrorHandling_,
                handling
            );
    }

    InstrumentRecoveryOptions::Enum
    instrumentRecovery() const
    {
        return instrumentRecovery_;
    }

    void 
    instrumentRecovery(
        InstrumentRecoveryOptions::Enum recovery)
    {
        group().
            controlAssignment
            (
                "Instrument Recovery Strategy", 
                instrumentRecovery_,
                recovery
            );
    }

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

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

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

ONIXS_CONFLATEDUDP_LTWT_CLASS 
AdvancedSessionSettings 
    : public SessionSettings
{
    // Lets grouping and value assignment control functioning. 
    friend ONIXS_CONFLATEDUDP_LTWT_CLASS_DECL(HandlerSettings);
 
    TcpRecoverySessionSettings tcpRecovery_;
 
    // Re-initializes the instance as a copy of the 
    // other one and bypassing assignment control. 
    void
    assignNoControl(
        const AdvancedSessionSettings& other)
    {
        SessionSettings::assignNoControl(other);
 
        tcpRecovery_.assignNoControl(other.tcpRecovery_);
    }
 
public:
    AdvancedSessionSettings(
        SettingAssignController* 
        controller = NULL)
        : SessionSettings(controller) 
        , tcpRecovery_(&group())
    {
    }

    AdvancedSessionSettings(
        const AdvancedSessionSettings& other)
        : SessionSettings(
            static_cast
            <const SessionSettings&>
            (other))
        , tcpRecovery_(
            other.tcpRecovery_)
    {
    }

    ~AdvancedSessionSettings()
    {
    }

    const 
    TcpRecoverySessionSettings&
    tcpRecovery() const
    {
        return tcpRecovery_;
    }

    TcpRecoverySessionSettings&
    tcpRecovery()
    {
        return tcpRecovery_;
    }

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

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

inline
std::string
toStr(
    const 
    AdvancedSessionSettings& settings)
{
    std::string str;
    
    toStr(str, settings);
 
    return str;
}
 
// Various functions helping in configuring session in the desired way. 

inline 
void
setSessionToRecoverInstrumentsAccurately
(
    SessionSettings& settings
)
{
    settings.
        instrumentRecovery(
            InstrumentRecoveryOptions::
            Accurate);
}

inline 
void
setSessionToRecoverInstrumentsFast
(
    SessionSettings& settings
)
{
    settings.
        instrumentRecovery(
            InstrumentRecoveryOptions::
            Fast);
}

inline 
void
setSessionToJoinInPreopening
(
    SessionSettings& settings
)
{
    settings.
        joinRecovery(
            JoinRecoveryOptions::
            Disabled);
}

inline 
void
setSessionToLateJoin(
    SessionSettings& settings)
{
    settings.
        joinRecovery(
            JoinRecoveryOptions::
            InstrumentsAndMarketState);
}

inline
void
setSessionToFullRecoverUponRealtimeIssues
(
    SessionSettings& settings
)
{
    settings.
        gapAndErrorHandling(
            GapAndErrorHandlingOptions::
            RecoverInstrumentsAndMarketState);
}

inline
void
setSessionToRecoverBooksUponRealtimeIssues
(
    SessionSettings& settings
)
{
    settings.
        gapAndErrorHandling(
            GapAndErrorHandlingOptions::
            RecoverMarketState);
}

inline
void
setSessionToContinueRealtimeProcessingUponIssues
(
    SessionSettings& settings
)
{
    settings.
        gapAndErrorHandling(
            GapAndErrorHandlingOptions::
            ContinueProcessing);
}
 
// Complex (one-call) setup. 

inline 
void
setSessionToAccuratePreopening
(
    SessionSettings& settings
)
{
    setSessionToRecoverInstrumentsAccurately
    (
        settings
    );
    setSessionToJoinInPreopening
    (
        settings
    );
    setSessionToRecoverBooksUponRealtimeIssues
    (
        settings
    );
}

inline
void
setSessionToAccurateLateJoin
(
    SessionSettings& settings
)
{
    setSessionToRecoverInstrumentsAccurately
    (
        settings
    );
    setSessionToLateJoin
    (
        settings
    );
    setSessionToRecoverBooksUponRealtimeIssues
    (
        settings
    );
}

inline 
void
setSessionToNaturalRefresh(
    SessionSettings& settings)
{
    setSessionToJoinInPreopening
    (
        settings
    );
    setSessionToContinueRealtimeProcessingUponIssues
    (
        settings
    );
}
 
// Deprecated way of session setup. 
 
#if !defined (ONIXS_CONFLATEDUDP_NO_DEPRECATED)

ONIXS_CONFLATEDUDP_LTWT_STRUCT
AccuratePreopeningSession
: SessionSettings
{
    AccuratePreopeningSession()
    {
        setSessionToAccuratePreopening(*this);
    }
};

ONIXS_CONFLATEDUDP_LTWT_STRUCT 
AccurateLateJoinSession
: SessionSettings
{
    AccurateLateJoinSession()
    : SessionSettings()
    {
        setSessionToAccurateLateJoin(*this);
    }
};

ONIXS_CONFLATEDUDP_LTWT_STRUCT
NaturalRefreshSession
: SessionSettings
{
    NaturalRefreshSession()
    : SessionSettings()
    {
        setSessionToNaturalRefresh(*this);
    }
};
 
#endif // ONIXS_CONFLATEDUDP_NO_DEPRECATED
 
ONIXS_CONFLATEDUDP_NAMESPACE_END