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/CME/DropCopy/Export.h"
#include "OnixS/CME/DropCopy/Types.h"
#include "OnixS/CME/DropCopy/Initialization.h"

namespace OnixS { namespace CME { namespace DropCopy {

/// Defines log alternates.
struct ONIXS_CME_DROP_COPY_EXPORT LogModes
{
    /// Log alternates.
    enum Enum
    {
        /// No data will be logged.
        Disabled,

        /// Only important information like
        /// warnings and errors will be logged.
        Important,

        /// Handler will log miscellaneous aspects
        /// related with its execution like changes
        /// in state, network data obtained, etc. All
        /// critical important information like warnings
        /// and errors will be logged as well.
        Regular,

        /// In addition to the data logged in 'Regular'
        /// mode, Handler will output additional information
        /// like step-by-step changes into books, step-by-step
        /// processing of received network packets.
        Debug
    };

    /// Returns string presentation of given mode.
    static std::string toString (Enum mode);
};

/// Log mode.
typedef LogModes::Enum LogMode;

/// Additional options to control log information.
typedef unsigned AdvancedLogOptionSet;

/// Additional options to control log information.
struct ONIXS_CME_DROP_COPY_EXPORT AdvancedLogOptions
{
    enum Enum
    {
        /// Nothing except standard
        /// information must be logged.
        LogNothing = 0x0,

        /// Log FIX messages in addition to the
        /// packets received from the network.
        LogFixMessages = 0x1,

        /// Logs all additional data/events.
        LogEverything = LogFixMessages
    };

    /// Returns string representation of an option.
    static std::string toString (AdvancedLogOptionSet options);
};

/// Handler's configuration settings.
struct ONIXS_CME_DROP_COPY_EXPORT HandlerSettings : InitializationSettings
{
    ///
    /// Specifies whether the Handler should log its events
    /// and which of events should be put into the log.
    ///
    /// \note The default value is LogModes::Regular.
    LogMode logMode;

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

    ///
    /// Log files will use this value as filename prefix.
    ///
    /// Ignored if logging is disabled.
    ///
    /// \note The default value is "CmeDropCopyHandlerCpp".
    std::string logFileNamePrefix;

    ///
    /// Log files will use this value as file extension.
    ///
    /// Ignored if logging is disabled.
    ///
    /// \note The default value is "log".
    std::string logExt;

    ///
    /// Additional options to control which data is to be logged.
    /// Ignored if logging is disabled.
    ///
    /// \note The default value is AdvancedLogOptions::LogEverything.
    AdvancedLogOptionSet advancedLogOptions;

    /// Heartbeat interval in seconds.
    ///
    /// Default value is 30 seconds.
    int heartbeatInterval;

    ///
    /// FIX session SenderCompID.
    ///
    /// This tag consists of 2 subcomponents and a constant: Session ID, Firm ID, and Fault Tolerance Indicator (FTI).
    /// Session ID is the left-most 3 characters. The next 3 characters represent Firm ID. The last character is always set to FTI.
    ///
    std::string senderCompId;

    ///
    /// FIX session TargetCompID.
    ///
    /// Identifies entity receiving the message (CME).
    ///
    /// The default value is "CME".
    ///
    std::string targetCompId;

    ///
    /// FIX session custom key.
    ///
    /// Custom key that can be used to distinguish sessions
    /// with the same values of the SenderCompID, TargetCompID
    /// and the FIX Protocol version.
    ///
    /// THe default value is empty string.
    ///
    std::string customKey;

    ///
    /// Fix session SenderSubID.
    ///
    /// Operator ID. Must be unique per Firm ID.
    ///
    std::string senderSubId;

    ///
    /// Fix session TargetSubID.
    ///
    /// Identifies platform receiving the message (Globex)
    ///
    /// The default value is "G".
    ///
    std::string targetSubId;

    ///
    /// Fix session SenderLocationId.
    ///
    /// ISO identifier of message originator's location (i.e. geographic location and/or desk).
    ///
    /// The default value is "EN,GB".
    std::string senderLocationId;

    /// Option to keep sequence numbers after the exchange of Logout (MsgType=5) messages.
    ///
    /// The default value is true.
    bool keepSequenceNumbersAfterLogout;

    /// Local network interface for CME Session.
    std::string networkInterface;

    /// If true will set the session outgoing sequence number to the
    /// NextExpectedMsgSeqNum (tag 789) field value from the CME Logout message.
    /// The session incoming sequence number will not be changed.
    ///
    /// The default value is false.
    bool processNextExpectedSeqNumFromCmeLogout;

    /// Initializes parameters with default values.
    HandlerSettings();

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

}}}