EngineSettings.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 <vector>
#include <string>
 
#include <OnixS/FIXEngine/FIX/Session.h>
 
namespace OnixS {
namespace System {
class ISettings;
}
}
 
namespace OnixS {
namespace FIX {
class Engine;

typedef std::vector<int> ListenPorts;

typedef std::string LocalNetworkInterface;
typedef std::vector<LocalNetworkInterface> LocalNetworkInterfaces;

class ONIXS_FIXENGINE_API EngineSettings
{
public:
    EngineSettings();

    explicit EngineSettings(const std::string & configuration);

    EngineSettings(const EngineSettings &);

    void loadFromConfigFile(const std::string & configFile);

    ~EngineSettings();

    EngineSettings & operator = (const EngineSettings &);

    EngineSettings & createEngineLogFile(bool value);

    bool createEngineLogFile() const;

    EngineSettings & dictionaryFile(const std::string & value);

    const std::string & dictionaryFile() const;

    EngineSettings & dialectString(const std::string & value);

    const std::string & dialectString() const;

    EngineSettings & listenPort(int value);

    int listenPort() const;

    EngineSettings & listenPorts(const ListenPorts & value);

    const ListenPorts & listenPorts() const;

    const LocalNetworkInterfaces & localNetworkInterface() const;

    EngineSettings & localNetworkInterface(const LocalNetworkInterfaces &);

    EngineSettings & localNetworkInterface(const LocalNetworkInterface &);

    ThreadingModel::Enum threadingModel() const;

    EngineSettings & threadingModel(ThreadingModel::Enum value);

    bool useSpinLock() const;

    EngineSettings & useSpinLock(bool value);

    EngineSettings & threadPoolSize(int size);

    int threadPoolSize() const;

    EngineSettings & licenseFile(const std::string & value);

    const std::string & licenseFile() const;

    EngineSettings & licenseStore(const std::string & value);

    const std::string & licenseStore() const;

    EngineSettings & licenseString(const std::string & value);

    const std::string & licenseString() const;

    unsigned licenseAlertingDaysBeforeExpiration();

    EngineSettings & licenseAlertingDaysBeforeExpiration(unsigned value);

    EngineSettings & logDirectory(const std::string & value);

    const std::string & logDirectory() const;

    const std::string & logFileName() const;

    EngineSettings & logFileName(const std::string & value);

    bool logInboundMessages() const;

    EngineSettings & logInboundMessages(bool value);

    bool logOutboundMessages() const;

    EngineSettings & logOutboundMessages(bool value);

    bool logBeforeSending() const;

    EngineSettings & logBeforeSending(bool value);

    bool localTimeUsage() const;

    EngineSettings & localTimeUsage(bool value);

    EngineSettings & processDeliverToCompId(bool value);

    bool processDeliverToCompId() const;

    EngineSettings & reasonableTransmissionTime(int value);

    int reasonableTransmissionTime() const;

    EngineSettings & reconnectAttempts(int value);

    int reconnectAttempts() const;

    EngineSettings & reconnectInterval(int value);

    int reconnectInterval() const;

    EngineSettings & resendingQueueSize(size_t value);

    size_t resendingQueueSize() const;

    EngineSettings & resendingBatchSize(size_t value);

    size_t resendingBatchSize() const;

    EngineSettings & resendRequestMaximumRange(int value);

    int resendRequestMaximumRange() const;

    static const int UseDefaultReceiveBufferSize;

    int receiveBufferSize() const;

    EngineSettings & receiveBufferSize(int value);

    static const int UseDefaultSendBufferSize;

    int sendBufferSize() const;

    EngineSettings & sendBufferSize(int value);

    EngineSettings & sendLogoutOnException(bool value);

    bool sendLogoutOnException() const;

    EngineSettings & sendLogoutOnInvalidLogon(bool value);

    bool sendLogoutOnInvalidLogon() const;

    EngineSettings & sslCertificateFile(const std::string & value);

    const std::string & sslCertificateFile() const;

    EngineSettings & sslPrivateKeyFile(const std::string & value);

    const std::string & sslPrivateKeyFile() const;

    EngineSettings & sslPrivateKeyPassword(const Cryptography::SecureString & value);

    Cryptography::SecureString sslPrivateKeyPassword() const;

    EngineSettings & sslListenPort(int value);

    int sslListenPort() const;

    EngineSettings & sslListenPorts(const ListenPorts & value);

    const ListenPorts & sslListenPorts() const;

    const LocalNetworkInterfaces & sslLocalInterface() const;

    EngineSettings & sslLocalInterface(const LocalNetworkInterfaces &);

    EngineSettings & sslVerifyPeer(bool verify);

    bool sslVerifyPeer() const;

    EngineSettings & sslClientSni(const std::string & hostName);

    const std::string & sslClientSni() const;

    EngineSettings & sslCaFile(const std::string & value);

    const std::string & sslCaFile() const;

    EngineSettings & sslMinProtocolVersion(SslProtocolMinMaxVersion::Enum version);

    SslProtocolMinMaxVersion::Enum sslMinProtocolVersion() const;

    EngineSettings & sslMaxProtocolVersion(SslProtocolMinMaxVersion::Enum version);

    SslProtocolMinMaxVersion::Enum sslMaxProtocolVersion() const;

    EngineSettings & serviceThreadAffinity(const OnixS::Threading::CpuIndexes & cpuIndexes);

    EngineSettings & serviceThreadAffinity(const OnixS::Threading::CpuIndex cpuIndex);

    const OnixS::Threading::CpuIndexes & serviceThreadAffinity();

    int serviceThreadPriority() const;

    EngineSettings & serviceThreadPriority(int priority);

    int serviceThreadPolicy() const;

    EngineSettings & serviceThreadPolicy(int policy);

    EngineSettings & tcpNoDelayOption(bool value);

    bool tcpNoDelayOption() const;

    EngineSettings & receiveSpinningTimeout(int value);

    int receiveSpinningTimeout() const;

    EngineSettings & sendSpinningTimeout(int value);

    int sendSpinningTimeout() const;

    EngineSettings & messageGrouping(unsigned value);

    unsigned messageGrouping() const;

    unsigned long long fileBasedStorageSegmentSize() const;

    EngineSettings & fileBasedStorageSegmentSize(unsigned long long value);

    unsigned asyncFileBasedStorageQueueMaxSize() const;

    EngineSettings & asyncFileBasedStorageQueueMaxSize(unsigned value);

    EngineSettings & asyncFileBasedStorageThreadAffinity(const OnixS::Threading::CpuIndexes & cpuIndexes);

    EngineSettings & asyncFileBasedStorageThreadAffinity(const OnixS::Threading::CpuIndex cpuIndex);

    const OnixS::Threading::CpuIndexes & asyncFileBasedStorageThreadAffinity();

    bool ignoreFileBasedStorageIntegrityErrors() const;

    EngineSettings & ignoreFileBasedStorageIntegrityErrors(bool value);

    bool specifyApplVerIdField() const;

    EngineSettings & specifyApplVerIdField(bool value);

    bool specifyLastMsgSeqNumProcessed() const;

    EngineSettings & specifyLastMsgSeqNumProcessed(bool value);

    bool reportNewMessagesWhileWaitingForMissedMessages() const;

    EngineSettings & reportNewMessagesWhileWaitingForMissedMessages(bool value);

    int expectedIncomingMessageSize() const;

    EngineSettings & expectedIncomingMessageSize(int value);

    EngineSettings & scrambleLogonFields(const Session::ScrambledFields & fields);

    Session::ScrambledFields scrambleLogonFields() const;

    EngineSettings & sendQueueMaxSize(size_t size);

    size_t sendQueueMaxSize() const;

    EngineSettings & firstLogonTimeout(unsigned timeout);

    unsigned firstLogonTimeout() const;

    bool enableRxTimestamp() const;

    EngineSettings & enableRxTimestamp(bool value);

    bool validateUnknownMessages() const;

    EngineSettings & validateUnknownMessages(bool);

    bool validateUnknownFields() const;

    EngineSettings & validateUnknownFields(bool);

    bool validateRequiredFields() const;

    EngineSettings & validateRequiredFields(bool);

    bool validateFieldValues() const;

    EngineSettings & validateFieldValues(bool);

    bool validateEmptyFieldValues() const;

    EngineSettings & validateEmptyFieldValues(bool);

    bool validateRepeatingGroupEntryCount() const;

    EngineSettings & validateRepeatingGroupEntryCount(bool);

    bool validateRepeatingGroupLeadingTag() const;

    EngineSettings & validateRepeatingGroupLeadingTag(bool);

    bool validateDuplicatedField() const;

    EngineSettings & validateDuplicatedField(bool);

    bool validateChecksum() const;

    EngineSettings & validateChecksum(bool);

    enum HeartbeatResolution
    {
        // The heartbeat is measured in deciseconds.
        DecisecondsHeartbeatResolution = 100,
 
        // The heartbeat is measured in seconds.
        SecondsHeartbeatResolution = 1000
    };

    EngineSettings & heartbeatResolution(HeartbeatResolution resolution);

    HeartbeatResolution heartbeatResolution() const;
 
private:
    friend class Engine;
 
    const OnixS::System::ISettings & settings() const;
 
    struct Implementation;
    Implementation * impl;
};
}
}