PcapDataAnalyser.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 "MarketSubscription.h"
#include "PcapDataProviderId.h"

#include <string>

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

/// PCAP data analyser interface.
class PcapDataAnalyser
{
public:
    /// Returns available market subscriptions.
    virtual const MarketSubscriptions& marketSubscriptions() const = 0;

    /// For a give market type returns a set of market IDs which
    /// is present in TCP data but missing in UDP snapshot data.
    ///
    /// \param marketType Requested market type.
    /// \param securityType Requested security type.
    virtual const MarketIds& missingMarketSnapshotIds(
        MarketType marketType
      , SecurityType::Enum securityType
    ) const = 0;

    virtual ~PcapDataAnalyser() {}
};

/// PCAP data analyser factory.
class ONIXS_ICEMDH_EXPORT PcapDataAnalyserFactory
{
public:
    /// Create an instance of PCAP data analyser.
    ///
    /// \param id Data provider unique ID.
    /// \param path Path to a location where data is stored.
    /// \param c10y Path to a connectivity configuration file.
    static PcapDataAnalyser* create(
        PcapDataProviderId id
      , const std::string& path
      , const std::string& c10y
    );
};

}}}}                                                        // namespace MarketData, iMpact, ICE, OnixS