runtime_intf.h

Go to the documentation of this file.

#ifndef _ADTF_UCOM_ANT_RUNTIME_RUNTIME_HOOK_INTERFACE_INCLUDES_HEADER_
#define _ADTF_UCOM_ANT_RUNTIME_RUNTIME_HOOK_INTERFACE_INCLUDES_HEADER_
 
#ifdef GetObject
#undef GetObject
#endif
#include "adtfucom3/function_ptr.h"
 
namespace adtf
{
namespace ucom
{
namespace ant
{

class DOEXPORT IRuntimeHook
{
    public:
        typedef struct
        {
            uint32_t               idHook;    
            uint32_t               ui32Param1;
            uint32_t               ui32Param2;
            void*                  pvData;    
            size_t                 szData;    
        } tHookInfo;
 
    public:
        virtual tResult RuntimeHook(const tHookInfo& sHookInfo,
                                    const iobject_ptr<IObject>& pObject) = 0;
};

class DOEXPORT IRuntime : public IObject
{
public:
    ADTF_IID(IRuntime, "runtime.ant.ucom.adtf.iid");
 
public:
    enum tRunLevel : int8_t
    {
        RL_Shutdown     = 0,

        RL_Internal     = 99
    };

    enum tRuntimeHookId : uint32_t
    {
        RHI_Create,

        RHI_Start,

        RHI_Stop,

        RHI_Destroy,

        RHI_RegisterObject,

        RHI_UnregisterObject,

        RHI_RegisterClass,

        RHI_UnregisterClass,

        RHI_RegisterPlugin,

        RHI_UnregisterPlugin,

        RHI_LoadPlugin,

        RHI_CreateInstance,

        RHI_ServiceStarting,

        RHI_ServiceStarted,

        RHI_ServiceStopping,

        RHI_ServiceStopped,

        RHI_RunLevelPreIncrement,

        RHI_RunLevelPostIncrement,

        RHI_RunLevelPreDecrement,

        RHI_RunLevelPostDecrement,

        RHI_RunLevelIncrementing,

        RHI_RunLevelDecrementing
    };

    enum tChangeRunLevelFlags : uint32_t
    {
        CRLF_None               = 0x0,

        CRLF_PreIncrementLevel  = 0x1,

        CRLF_PostIncrementLevel = 0x2,

        CRLF_PreDecrementLevel  = 0x4,

        CRLF_PostDecrementLevel = 0x8
    } ;

    enum tUnregisterObjectFlags : uint32_t
    {
        UOF_None          = 0x0,

        UOF_Manually      = 0x1,

        UOF_Automatically = 0x2
    };

    enum tObjectRegistryFlags : uint32_t
    {
        ORF_None                 = 0,   
        ORF_MarkedForDeletion    = 0x1, 
        ORF_ServiceIsShutdown    = 0x2, 
        ORF_RegisterOnChangingRL = 0x4  
    } ;

    enum tPluginFlags : uint8_t
    {
        PF_NONE      = 0x0, 
        PF_UNMANAGED = 0x1,  
        PF_MARKEDFORDELETION = 0x2  
    } ;

    enum tClassRegistryFlags : uint32_t
    {
        CRF_None             = 0x0,

        CRF_NoHookOnCreation = 0x1,

        CRF_FastCreation     = 0x2,

        CRF_NoAutoDeregistration = 0x4
    };
 
 public:
     virtual tResult SetRunLevel(int8_t nRunLevel, bool bWait = true) = 0;

    virtual int8_t GetRunLevel() const = 0;

    virtual tResult RegisterClassFactory(const iobject_ptr<const IClassFactory>& pClassFactory,
                                         uint32_t ui32Flags = 0) = 0;

    virtual tResult UnregisterClassFactory(const iobject_ptr<const IClassFactory>& pClassFactory) = 0;

    virtual tResult GetClasses(iobject_enum<const IClassInfo>& lstOfClasses) const = 0;

    virtual tResult GetClassFactories(iobject_enum<const IClassFactory>& lstOfClassFactories) const = 0;

    virtual tResult RegisterObject(const iobject_ptr<IObject>& pObject,
                                   const char* strNameOID,
                                   int8_t nRunLevel,
                                   uint32_t ui32Flags = 0) = 0;

    virtual tResult UnregisterObject(const iobject_ptr<IObject>& pObject,
                                     const tChar* strNameOID = "") = 0;

    virtual tResult GetObjects(iobject_enum<IObject>& lstOfObjects) const = 0;

    virtual tResult RegisterPlugin(const char* strUrl,
                                   int8_t nRunLevel,
                                   iobject_ptr<IPluginInfo>& pPluginInfo,
                                   uint32_t ui32Flags = 0) = 0;

    virtual tResult UnregisterPlugin(const iobject_ptr<IPluginInfo>& pPluginInfo, uint32_t ui32Flags = 0) = 0;

    virtual tResult UnregisterAllPlugins(int8_t nRunLevel,
                                         uint32_t ui32Flags=0) = 0;

    virtual tResult GetPlugins(iobject_enum<const IPluginInfo>& lstPluginInfos) const = 0;

    virtual tResult RegisterHook(IRuntimeHook& oHook) = 0;

    virtual tResult UnregisterHook(IRuntimeHook& oHook) = 0;

    virtual tResult GetObject(iobject_ptr<IObject>& pObject, const char* strNameOID) const = 0;
    virtual tResult GetObject(iobject_ptr<IObject>& pObject) const = 0;

    virtual tResult CreateInstance(const char* strCID,
                                   iobject_ptr<IObject>& pObject,
                                   const tChar* strNameOfObject = "") const = 0;
 
protected:
    ~IRuntime() = default;
};//class IRuntime
 
}//namespace ant
 
namespace spider
{
 
class DOEXPORT IRuntimeStartup : public ant::IObject
{
public:
    ADTF_IID(IRuntimeStartup, "runtime_startup.spider.ucom.adtf.iid");

    virtual bool StartupCompleted() const = 0;
};
 
}//namespace spider
 
namespace vision
{
 
class DOEXPORT IRuntimeArguments : public ant::IObject
{
public:
    ADTF_IID(IRuntimeArguments, "runtime_arguments.vision.ucom.adtf.iid");

    virtual tResult GetArguments(const adtf::ucom::nitro::ifunction<tResult(const char*)>& oCallback) const = 0;
};
 
}// namespace vision

using ant::IRuntimeHook;

using ant::IRuntime;
 
using spider::IRuntimeStartup;
 
}//namespace ucom
}//namespace adtf
 
#endif //_ADTF_UCOM_ANT_RUNTIME_RUNTIME_HOOK_INTERFACE_INCLUDES_HEADER_