PcapDataProviderSettings.h

Go to the documentation of this file.

/*
 * Copyright (c) Onix Solutions Limited. All rights reserved.
 *
 * This software owned by Onix Solutions Limited 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 "Export.h"
#include "LogSettings.h"
#include "PcapDataProviderId.h"
#include "Types.h"

#include <string>

namespace OnixS { namespace ICE { namespace iMpact { namespace MarketData {

/// PCAP data provider settings.
struct ONIXS_ICEMDH_EXPORT PcapDataProviderSettings
{
    /// Path to a directory where PCAP-data is stored.
    std::string pcapDirectory;

    /// Path to a connectivity configuration file.
    std::string connectivityConfiguration;

    /// Max snapshot duration in seconds.
    ///
    /// There are two time intervals for snapshots:
    /// - 15 seconds for active markets;
    /// - 2 minutes for idle markets.
    ///
    /// By default, the value is 120 seconds.
    DateTime maxSnapshotDurationInSeconds;

    /// Log files are stored in this directory.
    ///
    /// \note Default value is \e "./" (the current directory).
    std::string logDirectory;

    /// Template of log file name without extension.
    ///
    /// \note Default value is \e "PcapDataProvider".
    std::string logFileNamePrefix;

    /// Log verbosity.
    ///
    /// \note Default value is LogLevels::Info.
    LogLevel logLevel;

    /// Initializes instance with default values for control parameters.
    PcapDataProviderSettings();

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

}}}} // namespace OnixS::ICE::iMpact::MarketData