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/Senaf/MarketData/Export.h>
#include <OnixS/Senaf/MarketData/LogSettings.h>
#include <OnixS/Senaf/MarketData/ThreadAffinity.h>

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

namespace OnixS { namespace Senaf { namespace MarketData {

/// Connection retries settings.
struct ONIXS_BME_SENAF_EXPORT ConnectionRetries
{
    /// Default constructor.
    ConnectionRetries()
      : number(0)
      , interval(0)
    {
    }

    /// Constructor.
    ConnectionRetries(int inNumber, unsigned inInterval)
      : number(inNumber)
      , interval(inInterval)
    {
    }

    /// Number of attempts to restore the telecommunication link.
    /// -1 - unlimited
    /// 0 - never (default)
    /// >0 - the number of attempts
    int number;

    /// The time interval between the attempts to restore the telecommunication
    /// link (in seconds).
    ///
    /// \note The default value is 0 (zero).
    unsigned int interval;

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

ONIXS_BME_SENAF_EXPORT std::ostream& operator<<(std::ostream&, const ConnectionRetries&);

/// Logical processors that a thread is allowed to run on (first logical CPU has
/// index 0).
typedef std::set<int> CpuIndexes;

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

/// Log replay input stream.
class LogReplayInputStream
{
public:
    /**
     * Called when log player wants to read data from stream.
     *
     * \param data buffer to read data into
     * \param size max size to read
     *
     * \returns \c 0 in case of EOF, actually read bytes count otherwise
     *
     * \note Implementation is free to throw any exceptions.
     * Player would react differently depending on exception type.
     *
     * Particularly:
     * - \c std::ios_base::failure -- serious problem on getting data means
     *   do not try any further reading from stream and terminate playing;
     *
     * Absolutely all exceptions are reported via error handler.
     * Description string will be available for children of \c std::exception.
     */
    virtual size_t read(char* const data, size_t size) = 0;

protected:
    /// Deletion is not supposed through interface of this class.
    virtual ~LogReplayInputStream() {}
};

/// Defines set of settings which affect behavior of the Handler.
struct ONIXS_BME_SENAF_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 "SenafMarketDataHandlerCpp".
     */
    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;

    /**
     * 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 3.
     */
    time_t heartbeatInterval;

    /**
     * Defines set of CPUs by their indices (starting from zero)
     * allowed for thread used by the Handler while
     * processing market data to be executed on.
     *
     * \note By default set is empty thus allowing threads
     * to be executed on any CPU available in the system.
     */
    ThreadAffinity processingThreadAffinity;

    /**
     * Application Name.
     */
    std::string applicationName;

    /**
     * Application Password.
     */
    std::string applicationPassword;

    /**
     * Application Version.
     */
    unsigned short applicationVersion;

    /**
     * Connection retries configuration settings.
     */
    ConnectionRetries connectionRetries;

    /**
     * CPU affinity of the receiving thread.
     */
    CpuIndexes receivingThreadAffinity;

    /**
     * CPU affinity of the receiving thread.
     */
    CpuIndexes sendingThreadAffinity;

    /**
     * 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 1.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;

    /// Audit Trail files are stored in this directory.
    ///
    /// \note The default value is empty string.
    std::string auditTrailDirectory;

    /// Template of Audit Trail file name without extension.
    ///
    /// Creates Audit Trail file that contains all messages that Handler sent or
    /// received (in the chronological order).
    ///
    /// \note The default value is empty string (means no audit trail files
    /// required).
    std::string auditTrailFileNamePrefix;

    /// CPU affinity of the audit-trail thread.
    CpuIndexes auditTrailThreadAffinity;

    /// Market Image (Debug) files will be stored in this directory.
    ///
    /// \note The default value is "dump".
    std::string marketImageDirectory;

    /// Template of Market Image (Debug) file name without extension.
    ///
    /// Creates Market Image file. See 5.6. Debugging and Testing Support for more
    /// details.
    ///
    /// \note The default value is "File".
    std::string marketImageFileNamePrefix;

    /// 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_BME_SENAF_EXPORT std::ostream& operator<<(std::ostream&, const HandlerSettings&);

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