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/CboeCFE/Trading/BOE/ABI.h>
#include <OnixS/CboeCFE/Trading/BOE/LogSettings.h>
#include <OnixS/CboeCFE/Trading/BOE/Defines.h>
#include <OnixS/CboeCFE/Trading/BOE/Enumerations.h>

#include <set>
#include <vector>

namespace OnixS {
namespace CboeCFE {
namespace Trading {
namespace BOE {

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

    /// Constructor.
    ///
    ConnectionRetries (int inNumber, unsigned inIntervalSec) : number (inNumber), intervalSec (inIntervalSec) {}

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

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

/// Serializes object into string.
ONIXS_CBOE_CFE_BOE_API void toStr(std::string&, const ConnectionRetries&);

/// Serializes object into string.
inline std::string toStr(const ConnectionRetries& value)
{
    std::string str;

    toStr(str, value);

    return str;
}

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

/// Handler settings.
///
struct HandlerSettings
{
    /// Initialize default instance.
    ///
    HandlerSettings()
        : logDirectory("logs")
        , logFileNamePrefix("CboeCfeBoeHandler")
        , logSettings(LogSettings::Default)
        , logLevel(LogLevel::Info)
        , receiveTimeoutMs(1000)
        , sendTimeoutMs(1000)
        , auditTrailFileMaxSize(1024 * 1024 * 1024)
        , receiveSpinningTimeout(0)
        , sendSpinningTimeout(0)
    {}

    /// 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 "CboeCfeBoeHandlerCpp".
    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;

    /// Receive timeout in milliseconds.
    ///
    /// @note The default value is 1 seconds (1000 ms).
    int receiveTimeoutMs;

    /// Send timeout in milliseconds.
    ///
    /// @note The default value is 1 seconds (1000 ms).
    int sendTimeoutMs;

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

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

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

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

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

    /// Max size for audit trail file in megabytes, another file will be created if the size is exceeded.
    ///
    /// @note The default value is 1024 Mb.
    size_t auditTrailFileMaxSize;

    /// Sets the receive spinning timeout (microseconds).
    unsigned receiveSpinningTimeout;

    /// Sets the send spinning timeout (microseconds).
    unsigned sendSpinningTimeout;
};

/// Serializes object into string.
ONIXS_CBOE_CFE_BOE_API void toStr(std::string&, const HandlerSettings&);

/// Serializes object into string.
inline std::string toStr(const HandlerSettings& value)
{
    std::string str;

    toStr(str, value);

    return str;
}

/// Controls replay behavior for unknown units.
struct ReplayUnspecifiedUnit
{
    typedef Char Base;

    enum Enum
    {
        ///
        FailIfUnitNotSpecified = 'F',

        ///
        ReplayAnyUnspecifiedUnitFromZero = 'R',

        ///
        SkipReplayOfUnspecifiedUnits = 'S'
    };
};

/// Appends string presentation of object.
ONIXS_CBOE_CFE_BOE_API void toStr(std::string&, ReplayUnspecifiedUnit::Enum);

/// Returns string presentation of object.
inline std::string toStr(ReplayUnspecifiedUnit::Enum value)
{
    std::string str;

    toStr(str, value);

    return str;
}

///
struct LogonSettings
{
    /// Session Id as supplied by CFE
    std::string sessionId;

    /// Session Sub ID supplied by CFE.
    std::string sessionSubId;

    /// The password associated with the SessionId and SessionSubId.
    std::string password;

    /// Controls replay behavior for unknown units.
    ReplayUnspecifiedUnit::Enum replayUnspecifiedUnit;

    struct Unit
    {
        /// A unit number. This must be the unit number of the port.
        Binary1 number;

        /// Last received sequence number for the unit.
        Binary4 sequence;
    };

    /// Unit/sequence pairs to follow, one per unit from which the TPH has received messages over this port.
    std::vector<Unit> units;

    ///
    LogonSettings()
      : replayUnspecifiedUnit(ReplayUnspecifiedUnit::FailIfUnitNotSpecified)
    {}
};

/// Serializes object into string.
ONIXS_CBOE_CFE_BOE_API void toStr(std::string&, const LogonSettings&);

/// Serializes object into string.
inline std::string toStr(const LogonSettings& value)
{
    std::string str;

    toStr(str, value);

    return str;
}

}
}
}
}