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

#include <iosfwd>
#include <string>

namespace OnixS { namespace SURF { namespace MarketData {

/// Connection retries settings.
struct ONIXS_TP_SURF_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 interval;
};

/// Configuration settings.
struct ONIXS_TP_SURF_EXPORT HandlerSettings
{
    /// Constructor.
    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.
    std::string licenseDirectory;

    /// Log files are stored in this directory.
    std::string logDirectory;

    /// Template of log file name without extension.
    std::string logFileNamePrefix;

    /// Combine LogSettings enum values to configure the logger.
    LogSettings::Enum logSettings;

    /// Log verbosity.
    ///
    /// \note The default value is LogLevel::Info
    LogLevel::Enum logLevel;

    /// Sets the local network interface from which you intend to receive data.
    std::string localNetworkInterface;

    /// Timeout value in milliseconds. If 0 then the receiving blocks until some data is received.
    ///
    /// \note The default value is 120000 milliseconds (120 seconds) because a heartbeat record will
    /// be transmitted every 2 minutes.
    int receiveTimeoutInMilliseconds;

    /// Non-blocking receive spinning timeout (in microseconds) before the receiving thread enters
    /// into the blocking wait mode.
    ///
    /// Default value is 0 (turned off).
    unsigned receiveSpinningTimeoutInMicroseconds;

    /// Sets the processor affinity mask for the TCP receiving thread.
    ///
    /// Default value is -1 (undefined).
    int cpuIndex;

    /// Connection retries configuration settings.
    ///
    /// \see ConnectionRetries.
    ConnectionRetries connectionRetries;

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

ONIXS_TP_SURF_EXPORT std::ostream& operator<<(std::ostream&, const HandlerSettings&);

}}} // namespace OnixS::SURF::MarketData