FeedEngineThreadPool.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 <vector>
 
#include <OnixS/CME/MDH/messaging/String.h>
#include <OnixS/CME/MDH/messaging/Integral.h>
#include <OnixS/CME/MDH/TinySet.h>
 
#include <OnixS/CME/MDH/Auxiliary/DeprecatedHeaderWarnings.Disable.h>
#include <OnixS/CME/MDH/String.h>
#include <OnixS/CME/MDH/Auxiliary/DeprecatedHeaderWarnings.Restore.h>
 
ONIXS_CMEMDH_NAMESPACE_BEGIN
 
ONIXS_CMEMDH_EXPORTED_CLASS_DECL(FeedEngineThreadPool);

struct ONIXS_CMEMDH_EXPORTED FeedEngineThreadPoolListener
{
    virtual void onFeedEngineThreadBegin(const FeedEngineThreadPool&) {}

    virtual void onFeedEngineThreadEnd(const FeedEngineThreadPool&) {}

    virtual bool onFeedEngineThreadIdle(const FeedEngineThreadPool&)
    {
        return false;
    }

    virtual void onFeedEngineThreadIssue(const FeedEngineThreadPool&, const Messaging::Char*){}
};

typedef Messaging::Int32 CpuIndex;

typedef TinySet<CpuIndex> CpuIndices;

class ONIXS_CMEMDH_LTWT ThreadAffinity
{
public:
    ThreadAffinity() {}

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

    ~ThreadAffinity() {}

    operator bool() const
    {
        return indices_.empty();
    }

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

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

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

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

class ONIXS_CMEMDH_LTWT ThreadPoolSettings
{
public:
    ThreadPoolSettings()
        : affinity_()
        , size_(1)
    {
    }

    ~ThreadPoolSettings() {}

    const ThreadAffinity& affinity() const
    {
        return affinity_;
    }

    ThreadAffinity& affinity()
    {
        return affinity_;
    }

    Messaging::UInt32 size() const
    {
        return size_;
    }

    ThreadPoolSettings& size(Messaging::UInt32 value)
    {
        size_ = value;
        return *this;
    }
 
private:
    ThreadAffinity affinity_;
    Messaging::UInt32 size_;
};

ONIXS_CMEMDH_EXPORTED
void toStr(std::string&, const ThreadPoolSettings&);

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

class ONIXS_CMEMDH_LTWT FeedEngineThreadSettings
{
public:
    FeedEngineThreadSettings()
        : loopBeforeIdle_(1)
    {
    }

    ThreadPoolSettings& pool()
    {
        return pool_;
    }

    const ThreadPoolSettings& pool() const
    {
        return pool_;
    }

    Messaging::UInt32 loopBeforeIdle() const
    {
        return loopBeforeIdle_;
    }

    void loopBeforeIdle(Messaging::UInt32 value)
    {
        loopBeforeIdle_ = value;
    }
 
private:
    ThreadPoolSettings pool_;
    Messaging::UInt32 loopBeforeIdle_;
};

ONIXS_CMEMDH_EXPORTED
void toStr(std::string&, const FeedEngineThreadSettings&);

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

class ONIXS_CMEMDH_EXPORTED FeedEngineThreadPool
{
public:
    FeedEngineThreadPool(NetFeedEngine&, const FeedEngineThreadSettings&, FeedEngineThreadPoolListener* = nullptr);

    ~FeedEngineThreadPool();
 
private:
    class Workhorse;
    Workhorse* workhorse_;
};
 

class ONIXS_CMEMDH_EXPORTED ThisThread
{
public:
    static void affinity(const ThreadAffinity&);
    static void affinity(CpuIndex);
};
 
ONIXS_CMEMDH_NAMESPACE_END