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/ConflatedUDP/Integral.h>
 
ONIXS_CONFLATEDUDP_NAMESPACE_BEGIN
 
ONIXS_CONFLATEDUDP_LTWT_CLASS_DECL(NetFeed);
ONIXS_CONFLATEDUDP_EXPORTED_CLASS_DECL(NetFeedLink);
ONIXS_CONFLATEDUDP_EXPORTED_STRUCT_DECL(WatchService);

ONIXS_CONFLATEDUDP_LTWT_CLASS 
NetFeedEngineProcessResult
{
public:
    typedef 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;
};

ONIXS_CONFLATEDUDP_EXPORTED_CLASS NetFeedEngine
{
    NetFeedEngine(
        const NetFeedEngine&);
 
    NetFeedEngine& 
    operator =(
        const NetFeedEngine&);
 
protected:
    NetFeedEngine()
    {
    }
 
public:
    virtual ~NetFeedEngine()
    {
    }

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

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

    virtual
    WatchService& 
    watch() = 0;

    virtual 
    NetFeedEngineProcessResult
    process() = 0;
};

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