runnable_intf.h

Go to the documentation of this file.

#pragma once
#include "chrono.h"
#include <adtfucom3/adtf_ucom3.h>
#include <adtf_base_deprecated.h>
 
#include <functional>
 
namespace adtf
{
namespace base
{
namespace ant
{

class IRunnable
{
public:
    ADTF_IID(IRunnable, "runnable.ant.base.adtf.iid");
 
protected:
    ~IRunnable() = default;
 
public:
    typedef std::function<tResult(tTimeStamp)> tRunFunction;

    enum tActivationType : uint32_t
    {
        RUN_UNSPECIFIED = 0,
        RUN_TIMER = 1,
        RUN_SIGNAL = 2,
        RUN_EXCEPTION = 3,
        RUN_MESSAGE = 5,
        RUN_THREAD = 6,
        RUN_JOB = 7,
        RUN_TRIGGER = 8,
        RUN_PUSH = 9,

        RUN_USER = 0x1000
    };
 
public:
    ADTF3_DEPRECATED(
        "Use adtf::base::flash::IRunnable::Run(tNanoSeconds tmTimeofActivation, ant::IRunnable::tActivationType "
        "ui32ActivationType, const void* pvUserData, size_t nUserDataSize) instead.")
    virtual tResult Run(tTimeStamp tmTimeofActivation,
                        tActivationType ui32ActivationType,
                        const void* pvUserData,
                        size_t nUserDataSize) = 0;

    virtual tActivationType GetActivationType() const
    {
        return RUN_UNSPECIFIED;
    }
};
} // namespace ant
 
namespace flash
{
class IRunnable
{
public:
    ADTF_IID(IRunnable, "runnable.flash.base.adtf.iid");
 
protected:
    ~IRunnable() = default;
 
public:
    typedef std::function<tResult(tNanoSeconds)> tRunFunction;
    typedef ant::IRunnable::tActivationType tActivationType;
 
public:
    virtual tResult Run(tNanoSeconds tmTimeofActivation,
                        ant::IRunnable::tActivationType ui32ActivationType,
                        const void* pvUserData,
                        size_t nUserDataSize) = 0;
};
 
} // namespace flash

using ant::IRunnable;
 
} // namespace base
} // namespace adtf