HandlerSettings.h

Go to the documentation of this file.

#pragma once
/*
* 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.
*/

#include "OnixS/MTS/Cash/SDP/ABI.h"

#include <set>

namespace OnixS {
namespace Mts {
namespace Cash {
namespace SDP {

/// Connection retries settings.
///
struct ONIXS_MTS_CASH_SDP_API 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;

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

ONIXS_MTS_CASH_SDP_API std::ostream& operator << (std::ostream& stream, const ConnectionRetries& connectionRetries);

/// 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 ONIXS_MTS_CASH_SDP_API HandlerSettings
{
    /// Initialize default instance.
    ///
    HandlerSettings();

    /// 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 "MtsCashSdpHandlerCpp".
    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 2 seconds (2000 ms).
    int receiveTimeoutMs;

    /// Send timeout in milliseconds.
    ///
    /// @note The default value is 2 seconds (2000 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.
    int auditTrailFileMaxSize;

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

///
struct ONIXS_MTS_CASH_SDP_API ConnectionSettings
{
    /// Initialize default instance.
    ///
    ConnectionSettings();

    /// Specifies the value of the timeout at which the handle must close the SSP session.
    /// The handler must reset this timeout whenever it receives a valid data from the server.
    UInt16 clientSendAliveIntervalReq;

    /// Specifies the value of the timeout at which the handler must send heartbeat to prevent the server from closing the session
    UInt16 clientReceiveAliveIntervalReq;

    /// Size of the communication window.
    SInt16 comunicWindowSize;

    /// Indicates whether compression of the block data is enabled or not
    bool compressionEnabled;

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

///
struct ONIXS_MTS_CASH_SDP_API LogonSettings
{
    /// Initialize default instance.
    ///
    LogonSettings();

    ///TradeImpact service
    TradeImpactService::Enum service;

    /// Fully qualified trader name (format: �tradername@membername�).
    std::string userName;

    /// Password associated with the trader
    std::string password;

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

ONIXS_MTS_CASH_SDP_API std::ostream& operator << (std::ostream&, const HandlerSettings&);
ONIXS_MTS_CASH_SDP_API std::ostream& operator << (std::ostream&, const ConnectionSettings&);
ONIXS_MTS_CASH_SDP_API std::ostream& operator << (std::ostream&, const LogonSettings&);

}
}
}
}