FeedEngine.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/Streamlined/String.h>
#include <OnixS/CME/Streamlined/Integral.h>
#include <OnixS/CME/Streamlined/TinySet.h>
#include <OnixS/CME/Streamlined/Time.h>
 
ONIXS_CMESTREAMLINEDMDH_NAMESPACE_BEGIN

typedef Int32 CpuIndex;

ONIXS_CMESTREAMLINEDMDH_LTWT_CLASS ThreadAffinity
{
public:
    typedef 
    TinySet<CpuIndex> 
    CpuIndices;

    ThreadAffinity()
    {
    }

    ThreadAffinity(
        const ThreadAffinity& other)
        : indices_(other.indices_)
    {
    }

    ~ThreadAffinity()
    {
    }

    const CpuIndices& cpus() const
    {
        return indices_;
    }

    CpuIndices& cpus()
    {
        return indices_;
    }
 
private:
    CpuIndices indices_;
};

ONIXS_CMESTREAMLINEDMDH_EXPORTED 
void 
toStr(
    std::string&, 
    const ThreadAffinity&);

inline 
std::string 
toStr(
    const ThreadAffinity& affinity)
{
    std::string str;
 
    toStr(str, affinity);
 
    return str;
}

ONIXS_CMESTREAMLINEDMDH_LTWT_CLASS FeedEngineSettings
{
    ThreadAffinity threadAffinity_;
    UInt32 threadCount_;
 
    WatchService* watch_;
 
    UInt32 dataWaitTime_;
    UInt32 spinBeforeIdleTime_;
 
    UInt32 socketBufferSize_;
 
public:
    FeedEngineSettings()
        : threadAffinity_()
        , threadCount_(1)
        , watch_(
            &UtcWatch::service())
        , dataWaitTime_(10)
        , spinBeforeIdleTime_(1)
        , socketBufferSize_(
            8 * 1024 * 1024)
    {
    }

    ~FeedEngineSettings()
    {
    }

    const 
    ThreadAffinity& 
    threadAffinity() const
    {
        return threadAffinity_;
    }

    ThreadAffinity& threadAffinity()
    {
        return threadAffinity_;
    }

    UInt32 
    threadCount() const
    {
        return threadCount_;
    }

    void 
    threadCount(
        UInt32 value)
    {
        threadCount_ = value;
    }

    WatchService& watch() const
    {
        return *watch_;
    }

    void 
    watch(
        WatchService& watch)
    {
        watch_ = &watch;
    }

    UInt32 
    dataWaitTime() const
    {
        return dataWaitTime_;
    }

    void 
    dataWaitTime(
        UInt32 value)
    {
        dataWaitTime_ = value;
    }

    UInt32 
    spinBeforeIdleTime() const
    {
        return spinBeforeIdleTime_;
    }

    void 
    spinBeforeIdleTime(
        UInt32 value)
    {
        spinBeforeIdleTime_ = value;
    }

    UInt32 
    socketBufferSize() const
    {
        return socketBufferSize_;
    }

    void 
    socketBufferSize(
        UInt32 value)
    {
        socketBufferSize_ = value;
    }
};

ONIXS_CMESTREAMLINEDMDH_EXPORTED
void
toStr(
    std::string&,
    const FeedEngineSettings&);

inline 
std::string
toStr(
    const FeedEngineSettings& settings)
{
    std::string str;
 
    toStr(str, settings);
 
    return str;
}

ONIXS_CMESTREAMLINEDMDH_LTWT_STRUCT FeedEngineThreadIdle
{
    enum Reason
    {
        DataWaitTimeout,

        Redundant
    };
};
 
//
 
ONIXS_CMESTREAMLINEDMDH_EXPORTED_CLASS_DECL(FeedEngine);

ONIXS_CMESTREAMLINEDMDH_EXPORTED_STRUCT FeedEngineListener
{
    virtual 
    void 
    onFeedEngineThreadBegin(
        const FeedEngine&)
    {
    }

    virtual
    void
    onFeedEngineThreadEnd(
        const FeedEngine&)
    {
    }

    virtual 
    void
    onFeedEngineThreadIdle(
        const FeedEngine&,
        FeedEngineThreadIdle::Reason,
        UInt32&)
    {
    }

    virtual
    void
    onFeedEngineThreadIssue(
        const FeedEngine&,
        const Char*)
    {
    }
};
 
// Workhorse for the public Feed Engine. 
ONIXS_CMESTREAMLINEDMDH_INTERNAL_CLASS_DECL
(
    MultithreadedFeedEngine
);

ONIXS_CMESTREAMLINEDMDH_EXPORTED_CLASS FeedEngine
{
    // Current workhorse is multi-threaded 
    // feed engine using on socket API. 
    friend 
    ONIXS_CMESTREAMLINEDMDH_INTERNAL_CLASS_DECL
    (
        MultithreadedFeedEngine
    );
 
    MultithreadedFeedEngine* engine_;
 
    // Copying is not supposed for given class. 
 
    FeedEngine(const FeedEngine&);
    FeedEngine& operator =(const FeedEngine&);
 
public:
    FeedEngine(
        const FeedEngineSettings&,
        FeedEngineListener* = ONIXS_CMESTREAMLINEDMDH_NULLPTR);

    ~FeedEngine();

    const 
    FeedEngineSettings& 
    settings() const;
};
 
ONIXS_CMESTREAMLINEDMDH_NAMESPACE_END