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 <string>
 
#include <OnixS/CME/MDH/messaging/Integral.h>
 
ONIXS_CMEMDH_NAMESPACE_BEGIN
 
ONIXS_CMEMDH_LTWT_CLASS_DECL(NetFeed);
ONIXS_CMEMDH_EXPORTED_CLASS_DECL(NetFeedLink);
ONIXS_CMEMDH_EXPORTED_CLASS_DECL(Logger);
ONIXS_CMEMDH_EXPORTED_STRUCT_DECL(WatchService);

class ONIXS_CMEMDH_EXPORTED NetFeedEngineSettings
{
public:
    NetFeedEngineSettings();

    Logger* logger() const;

    Logger& loggerOrDefault() const;

    NetFeedEngineSettings& logger(Logger* logger);
 
private:
    Logger* logger_;
};

class ONIXS_CMEMDH_LTWT NetFeedEngineProcessResult
{
public:
    typedef Messaging::UInt32 Flags;

    NetFeedEngineProcessResult()
        : eventsDispatched_(0)
        , ioWaited_(0)
        , reserved_(0)
    {
    }

    bool eventsDispatched() const
    {
        return 0 != eventsDispatched_;
    }

    void eventsDispatched(bool state)
    {
        eventsDispatched_ = state ? 1 : 0;
    }

    bool ioWaited() const
    {
        return 0 != ioWaited_;
    }

    void ioWaited(bool state)
    {
        ioWaited_ = state ? 1 : 0;
    }

    Flags reserved() const
    {
        return reserved_;
    }

    void reserved(Flags flags)
    {
        reserved_ = flags;
    }
 
private:
    Flags eventsDispatched_ : 1;
    Flags ioWaited_         : 1;
    Flags reserved_         : 30;
};

class ONIXS_CMEMDH_EXPORTED NetFeedEngine
{
public:
    virtual ~NetFeedEngine() = default;

    const std::string& engineId() const noexcept;

    std::string about();

    virtual void info(std::string&) = 0;

    virtual NetFeedLink& allocate(const NetFeed&) = 0;

    virtual WatchService& watch() = 0;

    virtual NetFeedEngineProcessResult process() = 0;
 
protected:
    explicit NetFeedEngine(const NetFeedEngineSettings& settings = NetFeedEngineSettings{});

    Logger& logger() const noexcept;
 
private:
    NetFeedEngine(const NetFeedEngine&) = delete;
    NetFeedEngine& operator=(const NetFeedEngine&) = delete;
 
    const std::string id_;
    Logger* const logger_;
};
 
inline Logger& NetFeedEngine::logger() const noexcept
{
    return *logger_;
}
 
inline const std::string& NetFeedEngine::engineId() const noexcept
{
    return id_;
}

inline bool process(NetFeedEngine& engine)
{
    return engine.process().eventsDispatched();
}
 
ONIXS_CMEMDH_NAMESPACE_END