SolarflareFeedEngine.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/ConflatedUDP/Watch.h>
#include <OnixS/CME/ConflatedUDP/PacketTraits.h>
#include <OnixS/CME/ConflatedUDP/FeedEngine.h>

ONIXS_CONFLATEDUDP_NAMESPACE_BEGIN

/// Represents a collection of settings affecting 
/// the behavior of the feed engine while working 
/// with virtual interfaces. 
ONIXS_CONFLATEDUDP_LTWT_CLASS 
SolarflareFeedEngineSettings
{
    UInt32 receiveRingSize_;
    UInt32 cacheSize_;

    WatchService* watch_;

public:
    /// Initializes the given instance of the 
    /// network settings with the default values. 
    SolarflareFeedEngineSettings()
      : receiveRingSize_(
          static_cast<UInt32>(-1))
      , cacheSize_(1024)
      , watch_(
          &UtcWatch::service())
    {
    }

    /// Cleans everything up.
    ~SolarflareFeedEngineSettings()
    {
    }

    /// Number of buffers in a virtual interface receive ring. 
    /// 
    /// Single buffer is used for a single network packet. 
    /// Thus the receive ring must be capacious enough to 
    /// place incoming packets during market data bursts. 
    ///
    /// By default, the parameter is set to '-1' which means 
    /// receive ring will be constructed of the default capacity. 
    UInt32 
    receiveRingSize() const
    {
        return receiveRingSize_;
    }

    /// Number of buffers in a virtual interface receive ring. 
    /// 
    /// Single buffer is used for a single network packet. 
    /// Thus the receive ring must be capacious enough to 
    /// place incoming packets during market data bursts. 
    ///
    /// By default, the parameter is set to '-1' which means 
    /// receive ring will be constructed of the default capacity. 
    void 
    receiveRingSize(
        UInt32 ringSize)
    {
        receiveRingSize_ = ringSize;
    }

    /// Size of a pool of buffers used to 
    /// receive and manipulate incoming data. 
    /// 
    /// The feed engine puts incoming packets into buffers 
    /// and keeps buffers busy until received data is processed 
    /// by handlers. In case of rapid transmission, buffers may 
    /// be allocated quicker than they are processed and released 
    /// back to pool. Therefore, the pool must be capacious enough 
    /// to avoid data losses. 
    UInt32 
    cacheSize() const
    {
        return cacheSize_;
    }

    /// Size of pool of buffers used to 
    /// receive and manipulate incoming data. 
    void 
    cacheSize(
        UInt32 cacheSize)
    {
        cacheSize_ = cacheSize;
    }

    /// Watch service to be used by Feed Engine.
    /// 
    /// Watch is used by Feed Engine to assign time 
    /// points to packets received from the feeds.
    /// 
    /// @note By default, UTC watch service is used.
    WatchService& watch() const
    {
        return *watch_;
    }

    /// Watch service to be used by Feed Engine.
    /// 
    /// If no instance associated, UTC watch is used. 
    void 
    watch(
        WatchService& watch)
    {
        watch_ = &watch;
    }
};

/// Serializes feed engine settings into a string. 
ONIXS_CONFLATEDUDP_EXPORTED
void
toStr(
    std::string&,
    const 
    SolarflareFeedEngineSettings&);

/// Serializes feed engine settings into a string. 
inline 
std::string
toStr(
    const 
    SolarflareFeedEngineSettings& settings)
{
    std::string str;

    toStr(str, settings);

    return str;
}

/// The given class implements feed engine concept 
/// using pool of working threads and standard socket 
/// API. 
ONIXS_CONFLATEDUDP_EXPORTED_CLASS 
SolarflareFeedEngine 
    : public NetFeedEngine
{
    // The workhorse for the feed engine. 
    class Workhorse;

    Workhorse* workhorse_;

public:
    /// Initializes the engine according to the given configuration.
    SolarflareFeedEngine(
        const SolarflareFeedEngineSettings&);

    /// Destructs the given instance. 
    ~SolarflareFeedEngine();

    /// Appends information on the given 
    /// implementation to the given string. 
    void 
    info(
        std::string&);

    /// Allocates a link for the given feed. 
    NetFeedLink& 
    allocate(
        const NetFeed&);

    /// Exposes a watch service used 
    /// while manipulating the feed links. 
    WatchService& 
    watch();

    /// Carries out pending actions like 
    /// data retrival and event dispatching. 
    virtual 
    NetFeedEngineProcessResult
    process();
};

ONIXS_CONFLATEDUDP_NAMESPACE_END