MdiHandler.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/Eurex/MarketData/ABI.h>
#include <OnixS/Eurex/MarketData/HandlerStateListener.h>
#include <OnixS/Eurex/MarketData/InterfaceDescriptorProvider.h>
#include <OnixS/Eurex/MarketData/Replay.h>

namespace OnixS
{
    namespace Eurex
    {
        namespace MarketData
        {
            ONIXS_EUREX_EMDI_API_DECL(class, FeedEngine);

            struct ReplayOptions;
            struct MdiHandlerSettings;

            class CrossRequestListener;
            class FlexibleInstrumentUpdateListener;
            class HandlerStateListener;
            class InstrumentStateChangeListener;
            class InterfaceDescriptorProvider;
            class MassInstrumentStateChangeListener;
            class OrderBookListener;
            class TopOfBookImpliedListener;
            class ProductStateChangeListener;
            class QuoteRequestListener;
            class TradeListener;
            class WarningListener;
            class DepthListener;
            class ComplexInstrumentUpdateListener;
            class ErrorListener;
            class CachedDepthIncrementalListener;
            class ScaledSimpleInstrumentUpdateListener;


            /// Eurex Market Data Interface Handler.
            class ONIXS_EUREX_EMDI_API MdiHandler
            {
                public:
                    /// Performs instance initialization.
                    /// @param settings defines values for various options
                    /// which affect handler behavior like enabling logging
                    /// during execution of the handler.
                    explicit
                    MdiHandler (const MdiHandlerSettings& settings,
                        const std::string& = ONIXS_EUREX_EMDI_COMPILER_INFO);

                    /// Finalizes the Handler.
                    virtual ~MdiHandler();

                    /// Assigns listener for errors occurred while executing handler.
                    /// It's permissible to change the listener multiple times during
                    /// handler's life-time, but only when handler is in disconnected state.
                    /// @throw OperationException if handler not disconnected
                    MdiHandler& registerErrorListener (ErrorListener* listener);

                    /// Assigns listener for warnings occurred while executing handler.
                    /// It's permissible to change the listener multiple times during
                    /// handler's life-time, but only when handler is in disconnected state.
                    /// @throw OperationException if handler not disconnected
                    MdiHandler& registerWarningListener (WarningListener* listener);

                    /// Assigns listener for state change events occurred while executing handler.
                    /// It's permissible to change the listener multiple times during
                    /// handler's life-time, but only when handler is in disconnected state.
                    /// @throw OperationException if handler not disconnected.
                    MdiHandler& registerHandlerStateListener (HandlerStateListener* listener);

                    /// Assigns listener for depth messages received while executing handler.
                    /// It's permissible to change the listener multiple times during
                    /// handler's life-time, but only when handler is in disconnected state.
                    /// @throw OperationException if handler not disconnected.
                    MdiHandler& registerDepthListener (DepthListener* listener);

                    /// Assigns listener for depth incremental messages received during recovery process.
                    /// It's permissible to change the listener multiple times during
                    /// handler's life-time, but only when handler is in disconnected state.
                    /// @throw OperationException if handler not disconnected.
                    MdiHandler& registerCachedDepthIncrementalListener (CachedDepthIncrementalListener* listener);

                    /// Assigns listener for Top Of Book Implied message received while executing handler.
                    /// It's permissible to change the listener multiple times during
                    /// handler's life-time, but only when handler is in disconnected state.
                    /// @throw OperationException if handler not disconnected.
                    MdiHandler& registerTopOfBookImpliedListener (TopOfBookImpliedListener* listener);

                    /// Assigns listener for Product State Change message received while executing handler.
                    /// It's permissible to change the listener multiple times during
                    /// handler's life-time, but only when handler is in disconnected state.
                    /// @throw OperationException if handler not disconnected.
                    MdiHandler& registerProductStateChangeListener (ProductStateChangeListener* listener);

                    /// Assigns listener for Mass Instrument State Change message received while executing handler.
                    /// It's permissible to change the listener multiple times during
                    /// handler's life-time, but only when handler is in disconnected state.
                    /// @throw OperationException if handler not disconnected.
                    MdiHandler& registerMassInstrumentStateChangeListener (MassInstrumentStateChangeListener* listener);

                    /// Assigns listener for Instrument State Change message received while executing handler.
                    /// It's permissible to change the listener multiple times during
                    /// handler's life-time, but only when handler is in disconnected state.
                    /// @throw OperationException if handler not disconnected.
                    MdiHandler& registerInstrumentStateChangeListener (InstrumentStateChangeListener* listener);

                    /// Assigns listener for Quote Request message received while executing handler.
                    /// It's permissible to change the listener multiple times during
                    /// handler's life-time, but only when handler is in disconnected state.
                    /// @throw OperationException if handler not disconnected.
                    MdiHandler& registerQuoteRequestListener (QuoteRequestListener* listener);

                    /// Assigns listener for Cross Request message received while executing handler.
                    /// It's permissible to change the listener multiple times during
                    /// handler's life-time, but only when handler is in disconnected state.
                    /// @throw OperationException if handler not disconnected.
                    MdiHandler& registerCrossRequestListener (CrossRequestListener* listener);

                    /// Assigns listener for Complex Instrument Update message received while executing handler.
                    /// It's permissible to change the listener multiple times during
                    /// handler's life-time, but only when handler is in disconnected state.
                    /// @throw OperationException if handler not disconnected.
                    MdiHandler& registerComplexInstrumentUpdateListener (ComplexInstrumentUpdateListener* listener);

                    /// Assigns listener for Flexible Instrument Update message received while executing handler.
                    /// It's permissible to change the listener multiple times during
                    /// handler's life-time, but only when handler is in disconnected state.
                    /// @throw OperationException if handler not disconnected.
                    MdiHandler& registerFlexibleInstrumentUpdateListener (FlexibleInstrumentUpdateListener* listener);

                    /// Assigns listener for Scaled Simple Instrument Update message received while executing handler.
                    /// It's permissible to change the listener multiple times during
                    /// handler's life-time, but only when handler is in disconnected state.
                    /// @throw OperationException if handler not disconnected.
                    MdiHandler& registerScaledSimpleInstrumentUpdateListener (ScaledSimpleInstrumentUpdateListener* listener);


                    /// Assigns listener for Order Book updates received while executing handler.
                    /// It's permissible to change the listener multiple times during
                    /// handler's life-time, but only when handler is in disconnected state.
                    /// @throw OperationException if handler not disconnected.
                    MdiHandler& registerOrderBookListener (OrderBookListener* listener);

                    /// Assigns listener for trades received while executing handler.
                    /// It's permissible to change the listener multiple times during
                    /// handler's life-time, but only when handler is in disconnected state.
                    /// @throw OperationException if handler not disconnected.
                    MdiHandler& registerTradeListener (TradeListener* listener);

                    /// Set market segment to maximum number of price levels for the product map
                    ///
                    /// @note Should be provided if EmdiHandlerSettings::buildInternalOrderBooks is true.
                    MdiHandler& setMarketSegmentId2Depth(const MarketSegmentId2Depth& map);

                    /// Set the Market Segment Id filtering values.
                    ///
                    /// @note The filter is inclusive.
                    MdiHandler& setMarketSegmentIdFilters (const MarketSegmentIdFilters& filters);

                    /// Remove all filters.
                    MdiHandler& removeAllMarketSegmentIdFilters();

                    /// Set the Security Id filtering values.
                    ///
                    /// @note The filter is inclusive.
                    MdiHandler& setSecurityIdFilters (const SecurityIdFilters& filters);

                    /// Remove all filters.
                    MdiHandler& removeAllSecurityIdFilters();

                    /// Binds Feed Engine to the Handler.
                    ///
                    /// Handler must be in stopped state.
                    ///
                    /// @throw OperationException in case when handler is not in configurable state.
                    MdiHandler& bindFeedEngine(FeedEngine& feedEngine);

                    /// Start handler.
                    ///
                    /// @note This action is asynchronous.
                    /// @throw std::exception in case of unable to start.
                    void start ();

                    /// Starts replaying previously logged data.
                    void start (const ReplayOptions& options, bool* stopRequest = ONIXS_EUREX_EMDI_NULLPTR);

                    /// Stop handler.
                    void stop ();

                    /// Replay pcap files.
                    void replayPcap (const ReplayOptions& options);

                    /// Returns handler state.
                    HandlerState::Enum state () const;

                    /// Logs the given user-level message to the handler log.
                    MdiHandler& log (LogLevel::Enum logLevel, const char* logMessage, size_t length);

                    /// Logs the given user-level message to the handler log
                    MdiHandler& log (LogLevel::Enum logLevel, const char* logMessage);

                    /// Logs the given user-level message to the handler log.
                    MdiHandler& log (LogLevel::Enum logLevel, const std::string& str);

                    /// Returns the license expiration date.
                    std::string licenseExpirationDate () const;

                    /// Returns Handler's version.
                    static const char* version ();

                private:
                    MdiHandler (const MdiHandler&); //no implementation
                    MdiHandler& operator = (const MdiHandler&); //no implementation

                private:
                    friend struct OnixS::Eurex::MarketData::Implementation::PcapReplayHelper;
                    struct Impl;
                    Impl* impl_;
            };

            /// Replay pcap files.
            /// The replay is stopped when all the provided handlers are stopped or if `stopRequest` is `true`.
            ONIXS_EUREX_EMDI_API
            void replayPcap (const std::vector<MdiHandler*>& handlers, const ReplayOptions& options, bool* stopRequest = ONIXS_EUREX_EMDI_NULLPTR);
        }
    }
}