HandlerSettings.h

Go to the documentation of this file.

/*
 * Copyright (c) Onix Solutions Limited. All rights reserved.
 *
 * This software owned by Onix Solutions Limited 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 "Export.h"
#include "Enumerations.h"
#include "LogSettings.h"
#include "LogReplayInputStream.h"

#include <iosfwd>
#include <set>
#include <string>
#include <vector>

namespace OnixS { namespace ICE { namespace iMpact { namespace MarketData {

/// Defines snapshot recovery options.
struct ONIXS_ICEMDH_EXPORT SnapshotRecoveryOptions
{
    /**
     * Snapshot Recovery Timeout In Milliseconds
     * \li -1 - to wait indefinitely for snapshots (default)
     * \li 0 - not to use snapshots at all
     * \li >0 - the number of milliseconds to wait
     */
    int snapshotRecoveryTimeoutInMilliseconds;

    /**
     * Maximum Number Of Snapshot Recovery Attempts
     * \li -1 - unlimited (default)
     * \li 0 - not to use snapshots at all
     * \li >0 - the number of attempts
     */
    int maximumNumberOfSnapshotRecoveryAttempts;

    /**
     * Maximum size of the snapshot message queue
     *
     * \note Default value is 300.
     */
    size_t maximumSizeOfSnapshotMessageQueue;

    /**
     * Maximum size of the live message queue
     *
     * \note Default value is 300.
     */
    size_t maximumSizeOfLiveMessageQueue;

    /// Initializes instance with default values.
    SnapshotRecoveryOptions();

    /// Returns string representation.
    std::string toString() const;
};

/// Standard output operator.
ONIXS_ICEMDH_EXPORT std::ostream& operator<<(std::ostream&, const SnapshotRecoveryOptions&);

/// Ordered list of logs to be replayed.
typedef std::vector<std::string> LogList;

/// Read-write iterator over ordered list of logs to be replayed.
typedef std::vector<std::string>::iterator LogListEntry;

/// Set of regular expressions.
typedef std::set<std::string> RegexSet;

/// Defines set of settings which affect behavior of the Handler.
struct ONIXS_ICEMDH_EXPORT HandlerSettings
{
    /**
     * Content of the license file as a string.
     *
     * \note Default value is empty string.
     * \note The Handler checks this license first.
     */
    std::string licenseString;

    /**
     * Path to the license directory.
     *
     * \note Default value is \e "./" (the current directory).
     * \note A home directory also used to search a license.
     */
    std::string licenseDirectory;

    /**
     * Log files are stored in this directory.
     *
     * \note Default value is \e "./" (the current directory).
     */
    std::string logDirectory;

    /**
     * Template of log file name without extension.
     *
     * \note Default value is \e "IceImpactMulticastPriceFeedHandlerCpp".
     */
    std::string logFileNamePrefix;

    /**
     * Log verbosity.
     *
     * \note Default value is LogLevels::Info.
     */
    LogLevel logLevel;

    /**
     * Additional options to control which data is to be logged.
     * Ignored if logging is disabled.
     *
     * \note The default value is \c AdvancedLogOptions::Default.
     */
    AdvancedLogOptionSet advancedLogOptions;

    /**
     * Defines path to connectivity configuration which defines multicast
     * groups, types of markets which belong to the groups and
     * connection info for multicast feeds for the groups.
     */
    std::string connectivityConfiguration;

    /**
     * Specifies one or more network interfaces to use while
     * joining the multicast group; use semi-colon delimited
     * list if more than one.
     *
     * \note On Linux the network interface 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 maximal time interval in seconds between two
     * network packets. If no data is received during specified
     * time frame, warning is reported.
     *
     * \note The default value is \c 36000.
     */
    time_t heartbeatInterval;

    /**
     * Specifies maximal sequence gap margin between first
     * and last received network packets in internal queue.
     *
     * \note Default value is \c 10000.
     */
    size_t sequenceGapMargin;

    /**
     * Specifies maximal time interval in milliseconds to
     * wait network packet with next expected sequence number.
     *
     * \note Default value is \c 10000.
     */
    size_t gapTimeoutInMilliseconds;

    /// Specifies snapshot recovery options.
    SnapshotRecoveryOptions snapshotRecoveryOptions;

    /**
     * List of logs to be replated.
     *
     * \attention Must be stored in 'oldest to recent' order.
     */
    LogList logs;

    /// User defined input stream for log replay logs will be ignored
    LogReplayInputStream* inputStream;

    /**
     * Log player speed multiplier.
     *
     * This is an \f$ m \f$ in the formula \f$ mT+k \f$ to calculate delays between packets,
     * where \f$ T \f$ is original delay. Values less than \c 1 means reduced speed, greater
     * than \c 1 means increased speed. Default value is \c 0.0 which means a normal speed.
     */
    float logPlayerSpeedMultiplier;

    /**
     * Log player speed auxiliary delay.
     *
     * This is an \f$ k \f$ in the formula \f$ mT+k \f$ to calculate delays between packets,
     * where \f$ T \f$ is original delay. Default value is \c 0.
     */
    unsigned logPlayerSpeedAuxDelay;

    /**
     * Track top of the book only.
     *
     * This flag should be set to true when only top of the book updates are needed.
     *
     * Default value is \c false.
     */
    bool trackTopOfTheBookOnly;

    /**
     * Receive product definitions only.
     *
     * This flag should be set to true when only product definitions are needed.
     *
     * Default value is \c false.
     */
    bool receiveProductDefinitionsOnly;

    /**
     * Max multicast message block size.
     *
     * This option determines the size in bytes of a buffer that is used
     * as a storage for the incoming mulsticast message block.
     *
     * By default, the size set at 1400 bytes.
     */
    size_t maxMulticastMessageBlockSize;

    /**
     * Path to the product definition cache directory.
     *
     * If a value is set and it is a valid path to a directory,
     * the product definition cache will be created and used on the
     * daily basis. If the value is not set, the cache will not be
     * created an product definitions will be downloaded by establishing
     * a TCP connection to ICE server.
     *
     * \note Default value is empty string (cache is disabled).
     */
    std::string productDefinitionCacheDirectory;

    /**
     * A set of regular expressions which will be used to check
     * if Error Response should be treated as error or warning.
     *
     * By default, includes the following regular expressions:
     *
     * "No .*markets for market type .*"
     */
    RegexSet errorResponseWarningPatterns;

    /**
     * Use Historical Replay recovery.
     *
     * In case of message gap, the Handler will try to fill it with
     * Historical Replay Request over TCP connection to get missing
     * messages with corresponding sequence numbers.
     *
     * Default value is `false`.
     */
     bool useHistoricalReplay;

    /// Initializes instance with default values for control parameters.
    HandlerSettings();

    /// Returns string representation.
    std::string toString() const;
};

/// Make it printable to formatted C++ I/O streams.
ONIXS_ICEMDH_EXPORT std::ostream& operator<<(std::ostream&, const HandlerSettings&);

}}}}                                                        // namespace MarketData, iMpact, ICE, OnixS