MarketControlListener.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/Senaf/MarketData/Export.h>
#include <OnixS/Senaf/MarketData/MessageInfo.h>
#include <OnixS/Senaf/MarketData/Messages/GapFill.h>
#include <OnixS/Senaf/MarketData/Messages/GeneralError.h>
#include <OnixS/Senaf/MarketData/Messages/GenericHighPriorityMessage.h>
#include <OnixS/Senaf/MarketData/Messages/GenericLowPriorityMessage.h>
#include <OnixS/Senaf/MarketData/Messages/GenericMediumPriorityMessage.h>
#include <OnixS/Senaf/MarketData/Messages/InformationGroupEnd.h>
#include <OnixS/Senaf/MarketData/Messages/InformationGroupStart.h>
#include <OnixS/Senaf/MarketData/Messages/MarketImageRecoveryEnd.h>
#include <OnixS/Senaf/MarketData/Messages/MarketImageRecoveryStart.h>
#include <OnixS/Senaf/MarketData/Messages/MarketRequestError.h>
#include <OnixS/Senaf/MarketData/Messages/RecoveryEnd.h>
#include <OnixS/Senaf/MarketData/Messages/RecoveryStart.h>
#include <OnixS/Senaf/MarketData/Messages/ShortRecoveryEnd.h>
#include <OnixS/Senaf/MarketData/Messages/ShortRecoveryStart.h>
#include <OnixS/Senaf/MarketData/Messages/SystemProblemsNotification.h>
#include <OnixS/Senaf/MarketData/Messages/TerminalSessionStartUpResponse.h>

namespace OnixS { namespace Senaf { namespace MarketData {

/// \brief Defines the interface through which the Handler
/// notifies subscribers about Market Control Messages.
class ONIXS_BME_SENAF_EXPORT MarketControlListener
{
public:
    /// Is called once Generic Low Priority (100) Message received.
    ///
    /// \param msg Generic Low Priority (100) Message.
    /// \param msgInfo information about this particular message.
    virtual void onGenericLowPriorityMessage(
        const GenericLowPriorityMessage& msg,
        const MessageInfo& msgInfo
    ) = 0;

    /// Is called once Generic Medium Priority (101) Message received.
    ///
    /// \param msg Generic Medium Priority (101) Message.
    /// \param msgInfo information about this particular message.
    virtual void onGenericMediumPriorityMessage(
        const GenericMediumPriorityMessage& msg,
        const MessageInfo& msgInfo
    ) = 0;

    /// Is called once Generic High Priority (102) Message received.
    ///
    /// \param msg Generic High Priority (102) Message.
    /// \param msgInfo information about this particular message.
    virtual void onGenericHighPriorityMessage(
        const GenericHighPriorityMessage& msg,
        const MessageInfo& msgInfo
    ) = 0;

    /// Is called once Market Request Error (103) Message received.
    ///
    /// \param msg Market Request Error (103) Message.
    /// \param msgInfo information about this particular message.
    virtual void
    onMarketRequestError(const MarketRequestError& msg, const MessageInfo& msgInfo) = 0;

    /// Is called once Terminal Session Start-up Response (104) Message received.
    ///
    /// \param msg Terminal Session Start-up Response (104) Message.
    /// \param msgInfo information about this particular message.
    virtual void onTerminalSessionStartUpResponse(
        const TerminalSessionStartUpResponse& msg,
        const MessageInfo& msgInfo
    ) = 0;

    /// Is called once General Error (105) Message received.
    ///
    /// \param msg General Error (105) Message.
    /// \param msgInfo information about this particular message.
    virtual void onGeneralError(const GeneralError& msg, const MessageInfo& msgInfo) = 0;

    /// Is called once Recovery Start (110) Message received.
    ///
    /// \param msg Recovery Start (110) Message.
    /// \param msgInfo information about this particular message.
    virtual void onRecoveryStart(const RecoveryStart& msg, const MessageInfo& msgInfo) = 0;

    /// Is called once Recovery End (111) Message received.
    ///
    /// \param msg Recovery End (111) Message.
    /// \param msgInfo information about this particular message.
    virtual void onRecoveryEnd(const RecoveryEnd& msg, const MessageInfo& msgInfo) = 0;

    /// Is called once Market Image Recovery Start (113) Message received.
    ///
    /// \param msg Market Image Recovery Start (113) Message.
    /// \param msgInfo information about this particular message.
    virtual void
    onMarketImageRecoveryStart(const MarketImageRecoveryStart& msg, const MessageInfo& msgInfo) = 0;

    /// Is called once Market Image Recovery End (114) Message received.
    ///
    /// \param msg Market Image Recovery End (114) Message.
    /// \param msgInfo information about this particular message.
    virtual void
    onMarketImageRecoveryEnd(const MarketImageRecoveryEnd& msg, const MessageInfo& msgInfo) = 0;

    /// Is called once System Problems Notification (130) Message received.
    ///
    /// \param msg System Problems Notification (130) Message.
    /// \param msgInfo information about this particular message.
    virtual void onSystemProblemsNotification(
        const SystemProblemsNotification& msg,
        const MessageInfo& msgInfo
    ) = 0;

    /// Is called once Information Group Start (133) Message received.
    ///
    /// \param msg Information Group Start (133) Message.
    /// \param msgInfo information about this particular message.
    virtual void
    onInformationGroupStart(const InformationGroupStart& msg, const MessageInfo& msgInfo) = 0;

    /// Is called once Information Group End (134) Message received.
    ///
    /// \param msg Information Group End (134) Message.
    /// \param msgInfo information about this particular message.
    virtual void
    onInformationGroupEnd(const InformationGroupEnd& msg, const MessageInfo& msgInfo) = 0;

    /// Is called once Short Recovery Start (146) Message received.
    ///
    /// \param msg Short Recovery Start (146) Message.
    /// \param msgInfo information about this particular message.
    virtual void
    onShortRecoveryStart(const ShortRecoveryStart& msg, const MessageInfo& msgInfo) = 0;

    /// Is called once Short Recovery End (147) Message received.
    ///
    /// \param msg Short Recovery End (147) Message.
    /// \param msgInfo information about this particular message.
    virtual void onShortRecoveryEnd(const ShortRecoveryEnd& msg, const MessageInfo& msgInfo) = 0;

    /// Is called once Gap Fill (160) Message received.
    ///
    /// \param msg Gap Fill (160) Message.
    /// \param msgInfo information about this particular message.
    virtual void onGapFill(const GapFill& msg, const MessageInfo& msgInfo) = 0;

protected:
    virtual ~MarketControlListener() {}
};

}}} // namespace OnixS::Senaf::MarketData