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/Eurex/Trading/Export.h"
#include "OnixS/Eurex/Trading/LogSettings.h"

#include <set>

namespace OnixS { namespace Eurex { namespace Trading {

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

    /// Copy constructor.
    ConnectionRetries(const ConnectionRetries& other)
      : number(other.number)
      , interval(other.interval)
    {
    }

    /// 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_EUREX_ETI_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<size_t> CpuIndexes;

/// Audit trail mode.
struct ONIXS_EUREX_ETI_EXPORT AuditTrailMode
{
    /// \copydoc AuditTrailMode
    enum Enum
    {
        /// Human-readable text representation.
        Text,

        /// Compact form for further processing using
        /// \link OnixS::Eurex::Trading::AuditTrail::Reader Reader\endlink.
        Base64,
    };
};

/// Returns string representation.
ONIXS_EUREX_ETI_EXPORT std::string enumToString(AuditTrailMode::Enum);

/// Make it printable using C++ I/O streams.
ONIXS_EUREX_ETI_EXPORT std::ostream& operator<<(std::ostream&, AuditTrailMode::Enum);

/// Handler settings.
struct ONIXS_EUREX_ETI_EXPORT HandlerSettings
{
    /// Constructor.
    HandlerSettings();

    /// Copy constructor.
    HandlerSettings(const 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 The default value is empty string (means current directory).
    std::string licenseDirectory;

    /// Log files are stored in this directory.
    ///
    /// \note The default value is "logs".
    std::string logDirectory;

    /// Template of log file name without extension.
    ///
    /// \note The default value is "EurexEtiTradingHandlerCpp".
    std::string logFileNamePrefix;

    /// Combine LogSettings enum values to configure the logger.
    ///
    /// \note The default value is LogSettings::Default.
    LogSettings::Enum logSettings;

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

    /// Receiving timeout in milliseconds.
    ///
    /// \note The default value is 2 seconds (2000 ms).
    int receivingTimeoutMs;

    /// Sending timeout in milliseconds.
    ///
    /// \note The default value is 2 seconds (2000 ms).
    int sendingTimeoutMs;

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

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

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

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

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

    /// \deprecated Please use \link
    /// OnixS::Eurex::Trading::HandlerSettings::auditTrailFileNamePrefix
    /// auditTrailFileNamePrefix\endlink instead of this deprecated field.
    std::string auditTrailFile;

    /// 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;

    /// Audit Trail mode.
    ///
    /// \note By default it's Text.
    AuditTrailMode::Enum auditTrailMode;

    /// Throttle message margin. Transaction limit will be reduced by this value.
    ///
    /// For example, if Eurex notify that transaction limit is 20 messages and
    /// this Handler's setting isn't changed (by default value is 3), then
    /// transaction limit for Handler is 20 - 3 = 17 messages.
    ///
    /// \note By default it's 3.
    size_t throttleMessageMargin;

    /// This flag is used to control the Handler's
    /// behavior when a connection is not able to
    /// receive data from a network.
    ///
    /// Absence of data could be caused by network or
    /// exchange issues. If server stopped sending
    /// data due to internal issues but underlying
    /// TCP connection is not broken, it could make
    /// sense to switch to manual control and use
    /// this option.
    ///
    /// By default, the Handler will call error
    /// callback and restart the connection.
    /// If this flag is set to \c true, only
    /// warning callback will be called and
    /// the Handler continue to work.
    ///
    /// \note By default it's \c false.
    bool treatReceiverInactivityAsWarning;

    /// This flag is used to control the Handler's
    /// behavior whether to scramble passwords in
    /// the log and audit files.
    ///
    /// \note By default it's \c false.
    bool scramblePassword;

    /// Reasonable transmission time.
    /// This option controls the percentage from the heartbeat interval.
    ///
    /// \note By default it's 20.
    unsigned reasonableTransmissionTime;

    /// Is SSL enabled for the connection to exchange?
    ///
    /// \note By default it's \c false.
    bool sslEnabled;

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

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

}}}