FeedEngineThreads.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/String.h>
#include <OnixS/CME/ConflatedUDP/ThreadPool.h>
 
ONIXS_CONFLATEDUDP_NAMESPACE_BEGIN
 
// A bit of forward declarations. 
 
ONIXS_CONFLATEDUDP_EXPORTED_CLASS_DECL
(
    FeedEngineThreads
);

ONIXS_CONFLATEDUDP_EXPORTED_STRUCT 
FeedEngineThreadListener
{
    virtual 
    void 
    onFeedEngineThreadBegin
    (
        const FeedEngineThreads&
    )
    {
    }

    virtual
    void
    onFeedEngineThreadEnd
    (
        const FeedEngineThreads&
    )
    {
    }

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

    virtual
    void
    onFeedEngineThreadIssue
    (
        const FeedEngineThreads&,
        const Char*
    )
    {
    }
};
 
//

ONIXS_CONFLATEDUDP_LTWT_CLASS 
FeedEngineThreadSettings
{
    ThreadPoolSettings pool_;
    UInt32 loopBeforeIdle_;
 
public:
    FeedEngineThreadSettings()
      : loopBeforeIdle_(1)
    {
    }

    ThreadPoolSettings& 
    pool()
    {
        return pool_;
    }

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

    UInt32 
    loopBeforeIdle() const
    {
        return loopBeforeIdle_;
    }

    void 
    loopBeforeIdle(UInt32 value)
    {
        loopBeforeIdle_ = value;
    }
};

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

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

ONIXS_CONFLATEDUDP_EXPORTED_CLASS 
FeedEngineThreads
{
    // The workhorse for the class. 
    class Workhorse;
 
    Workhorse* workhorse_;
 
public:
    FeedEngineThreads(
        NetFeedEngine&, 
        const FeedEngineThreadSettings&, 
        FeedEngineThreadListener* = NULL);

    ~FeedEngineThreads();
};
 
ONIXS_CONFLATEDUDP_NAMESPACE_END