HandlerSettings.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/B3/MarketData/UMDF/ABI.h>
#include <OnixS/B3/MarketData/UMDF/Defines.h>
#include <OnixS/B3/MarketData/UMDF/LogSettings.h>

#include <sstream>
#include <string>
#include <set>
#include <vector>

namespace OnixS
{
    namespace B3
    {
        namespace MarketData
        {
            namespace UMDF
            {
                class FeedEngine;

                /// Multicast feed description
                struct FeedDescriptor
                {
                    ///
                    FeedDescriptor()
                        : port (0)
                    {}

                    ///
                    FeedDescriptor(const std::string& a, unsigned int port, const std::string& nif = "")
                        : address (a)
                        , port (port)
                        , networkInterface(nif)
                    {}

                    /// Ip address
                    std::string address;

                    /// Port number
                    unsigned port;

                    /// Specifies one or more network interfaces to use while joining the multicast group;
                    /// use semi-colon delimited list if more than one.
                    /// This value overrides the default one.
                    std::string networkInterface;

                    /// Returns true if the descriptor points to valid ip address
                    bool valid() const
                    {
                        return !address.empty() && port > 0;
                    }
                };

                ONIXS_B3_UMDF_MD_API std::ostream& operator<<(std::ostream& stream, const FeedDescriptor& descriptor);

                // A feed-related settings.
                struct Feed
                {
                    /// Feed descriptor.
                    FeedDescriptor a;

                    /// Feed descriptor.
                    FeedDescriptor b;

                    /// Feed engine to use on feed.
                    /// This value overrides the default one.
                    FeedEngine* feedEngine;

                    ///
                    Feed()
                        : feedEngine(ONIXS_B3_UMDF_MD_NULLPTR)
                    {}

                    ///
                    Feed(const FeedDescriptor& aFeed, const FeedDescriptor& bFeed, FeedEngine* engine = ONIXS_B3_UMDF_MD_NULLPTR)
                        : a(aFeed)
                        , b(bFeed)
                        , feedEngine(engine)
                    {}
                };

                ONIXS_B3_UMDF_MD_API std::ostream& operator<<(std::ostream& stream, const Feed& descriptor);

                struct HandlerSettings;

                ONIXS_B3_UMDF_MD_API std::ostream& operator<<(std::ostream& stream, const HandlerSettings& settings);

                /// Handler configuration settings.
                struct HandlerSettings
                {
                    /// Constructor.
                    HandlerSettings()
                        : licenseString("")
                        , licenseDirectory("")
                        , feedEngine()
                        , heartbeatInterval(3)
                        , outOfOrderPacketMaxInterval(3)
                        , lostPacketWaitTime(100000)
                        , maxPacketSize(1400)
                        , maxBooksObjectAmount(1000)
                        , buildInternalOrderBooks(false)
                    {}

                    /// Logger settings.
                    LoggerSettings loggerSettings;

                    /// License string.
                    std::string licenseString;

                    /// Path to the license directory.
                    std::string licenseDirectory;

                    /// Feed engine.
                    FeedEngine* feedEngine;

                    /**
                    * Specifies one or more network interfaces to use while joining the multicast group; use semi-colon delimited list if more than one.
                    *
                    * On Linux the network interfaces is specified by its name, on Windows - by IP address.
                    *
                    * @note If the value is empty or absent then the default networking interface is used.
                    */
                    std::string networkInterface;

                    /**
                    * Specifies one or more network interfaces to use while joining the multicast group A; use semi-colon delimited list if more than one.
                    *
                    * On Linux the network interfaces is specified by its name, on Windows - by IP address.
                    *
                    * @note If the value is empty or absent then the networkInterface_ filled value is used.
                    */
                    std::string networkInterfaceA;

                    /**
                    * Specifies one or more network interfaces to use while joining the multicast group B; use semi-colon delimited list if more than one.
                    *
                    * On Linux the network interfaces is specified by its name, on Windows - by IP address.
                    *
                    * @note If the value is empty or absent then the networkInterface_ filled value is used.
                    */
                    std::string networkInterfaceB;

                    /// Specifies maximal time interval between two
                    /// network packets. If no data is received during
                    /// specified time frame, corresponding warning is raised.
                    ///
                    /// Interval is measured in seconds.
                    ///
                    /// @note The default value is '3'.
                    UInt32 heartbeatInterval;

                    /// Defines value of threshold used by Handler to differ
                    /// out-of-order packets from gaps.
                    ///
                    /// Due to unreliable nature of multicast, packets transmitted by exchange
                    /// may be received in the order different to original. To differ the
                    /// case when Handler received out-of-order packets from the case when
                    /// some of packets were completely lost, Handler uses given parameter.
                    /// It defines size of interval for incoming packets starting from the
                    /// last received. Packet is considered as out-of-order if its sequence
                    /// number fits into interval [seqNumberOfLastReceivedPacket,
                    /// seqNumberOfLastReceivedPacket + outOfOrderPacketsMaxInterval].
                    /// In that case Handler waits for other packets to fulfill the incoming
                    /// sequence. If received packet has greater sequence number than
                    /// 'seqNumberOfLastReceivedPacket + outOfOrderPacketsMaxInterval',
                    /// then Handler makes a decision on packets lost and gap is reported.
                    ///
                    /// @note When out-of-order packet is received, Handler makes a decision
                    /// on data loss if either waiting time is over or if newly received packet
                    /// has sequence number greater than 'seqNumberOfLastReceivedPacket +
                    /// outOfOrderPacketMaxInterval'.
                    ///
                    /// @see 'lostPacketWaitTime' parameter for more information.
                    ///
                    /// @note The default value is '3'.
                    UInt32 outOfOrderPacketMaxInterval;

                    /// Indicates for how long Handler should wait for
                    /// the packet before it's considered as totally lost.
                    ///
                    /// Due to unreliable nature of multicast, data transmitted by MDP
                    /// may come in order other than original or be completely lost. When
                    /// Handler receives packet with sequence number greater than expected,
                    /// it considers received data as out-of-order. If for a certain time
                    /// interval Handler receives missing data, Handler resumes normal data
                    /// processing. However, if no data is received for predefined time frame,
                    /// Handler considers missing data as lost and raises packet gap event.
                    /// Given parameter defines size of time interval Handler waits for missing
                    /// data.
                    ///
                    /// @note When out-of-order packet is received, Handler makes a decision
                    /// on data loss if either waiting time is over or if newly received packet
                    /// has sequence number greater than 'seqNumberOfLastReceivedPacket +
                    /// outOfOrderPacketMaxInterval'.
                    ///
                    /// @see 'outOfOrderPacketMaxInterval' parameter for more information.
                    ///
                    /// Time interval is measured in microseconds (uSec).
                    ///
                    /// @note The default value is '100000' (100 milliseconds).
                    UInt32 lostPacketWaitTime;

                    /// Instrument definition multicast feed
                    Feed instrumentMulticastFeed;

                    /// Incremental multicast feed B
                    Feed incrementalMulticastFeed;

                    /// Snapshot recovery multicast feed
                    Feed snapshotMulticastFeed;

                    /// Max size for network packet transmitted by B3 UMDF.
                    ///
                    /// @note The default value is 1400 bytes.
                    unsigned short maxPacketSize;

                    /// Defines size of pre-allocated memory for Order Book. Default value is 100
                    unsigned int maxBooksObjectAmount;

                    /// Build internal books
                    bool buildInternalOrderBooks;

                    /// Returns the string representation.
                    std::string toString() const
                    {
                        std::ostringstream out;
                        out << *this;
                        return out.str();
                    }
                };
            }
        }
    }
}