The IRuntime interface controls global system startup and shutdown. More...

#include <runtime_intf.h>

Inheritance diagram for IRuntime:

Public Types
enum	tRunLevel : int8_t { RL_Shutdown = 0 , RL_Internal = 99 }
	Run levels. More...

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 }
	Runtime hook identifiers. More...

enum	tChangeRunLevelFlags : uint32_t { CRLF_None = 0x0 , CRLF_PreIncrementLevel = 0x1 , CRLF_PostIncrementLevel = 0x2 , CRLF_PreDecrementLevel = 0x4 , CRLF_PostDecrementLevel = 0x8 }
	Run level change flags. More...

enum	tUnregisterObjectFlags : uint32_t { UOF_None = 0x0 , UOF_Manually = 0x1 , UOF_Automatically = 0x2 }
	Run level change flags. More...

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 }
	InternalFlags. More...

enum	tClassRegistryFlags : uint32_t { CRF_None = 0x0 , CRF_NoHookOnCreation = 0x1 , CRF_FastCreation = 0x2 , CRF_NoAutoDeregistration = 0x4 }
	Flags to affect the creation speed of classes. More...

Public Member Functions
	ADTF_IID (IRuntime, "runtime.ant.ucom.adtf.iid")
	Marks the `IRuntime` to be castable with the ucom_cast<>

virtual tResult	SetRunLevel (int8_t nRunLevel, bool bWait=true)=0
	Set run level.

virtual int8_t	GetRunLevel () const =0
	Get current run level.

virtual tResult	RegisterClassFactory (const iobject_ptr< const IClassFactory > &pClassFactory, uint32_t ui32Flags=0)=0
	Register class at class registry The RegisterClass method registers all classes of the given factory at the class registry.

virtual tResult	UnregisterClassFactory (const iobject_ptr< const IClassFactory > &pClassFactory)=0
	Unregister a class factory from class registry.

virtual tResult	GetClasses (iobject_enum< const IClassInfo > &lstOfClasses) const =0
	Returns a list of classes.

virtual tResult	GetClassFactories (iobject_enum< const IClassFactory > &lstOfClassFactories) const =0
	Gets a list for all registered class factories.

virtual tResult	RegisterObject (const iobject_ptr< IObject > &pObject, const char *strNameOID, int8_t nRunLevel, uint32_t ui32Flags=0)=0
	Register object at object registry.

virtual tResult	UnregisterObject (const iobject_ptr< IObject > &pObject, const tChar *strNameOID="")=0
	Unregister object from object registry.

virtual tResult	GetObjects (iobject_enum< IObject > &lstOfObjects) const =0
	Get a list (enumeration) of registered instances.

virtual tResult	RegisterPlugin (const char *strUrl, int8_t nRunLevel, iobject_ptr< IPluginInfo > &pPluginInfo, uint32_t ui32Flags=0)=0
	Register plugin at the plugin registry.

virtual tResult	UnregisterPlugin (const iobject_ptr< IPluginInfo > &pPluginInfo, uint32_t ui32Flags=0)=0
	Unregister plugin from plugin registry.

virtual tResult	UnregisterAllPlugins (int8_t nRunLevel, uint32_t ui32Flags=0)=0
	Unregister all plugin from plugin registry.

virtual tResult	GetPlugins (iobject_enum< const IPluginInfo > &lstPluginInfos) const =0
	Gets a object reference list of registered plugins.

virtual tResult	RegisterHook (IRuntimeHook &oHook)=0
	Register hook.

virtual tResult	UnregisterHook (IRuntimeHook &oHook)=0
	Unregister hook.

virtual tResult	GetObject (iobject_ptr< IObject > &pObject, const char *strNameOID) const =0
	Get registered object from object registry.

virtual tResult	GetObject (iobject_ptr< IObject > &pObject) const =0
	Get registered object from object registry by interface.

virtual tResult	CreateInstance (const char strCID, iobject_ptr< IObject > &pObject, const tChar strNameOfObject="") const =0
	Creates a new instance of an object.

Public Member Functions inherited from IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")
	Marks the `IObject` to be castable with the `ucom_cast()`

Protected Member Functions
	~IRuntime ()=default
	Protected destructor --> Only the final implementation can be destroyed!

Protected Member Functions inherited from IObject
	~IObject ()=default
	Protected destructor --> Only the final implementation can be destroyed!

Detailed Description

The IRuntime interface controls global system startup and shutdown.

Definition at line 111 of file runtime_intf.h.

Member Enumeration Documentation

◆ tChangeRunLevelFlags

enum tChangeRunLevelFlags : uint32_t

Run level change flags.

Enumerator
CRLF_None	Unused.
CRLF_PreIncrementLevel	Called before the run level is incremented.
CRLF_PostIncrementLevel	Called after the run level was incremented.
CRLF_PreDecrementLevel	Called before the run level is decremented.
CRLF_PostDecrementLevel	Called after the run level was decremented.

Definition at line 241 of file runtime_intf.h.

◆ tClassRegistryFlags

enum tClassRegistryFlags : uint32_t

Flags to affect the creation speed of classes.

Enumerator
CRF_None	No special treatment.
CRF_NoHookOnCreation	The runtime hooks don't get called.
CRF_FastCreation	The class is placed at the front of the classlist.
CRF_NoAutoDeregistration	The class will be registered for the current Run level and will be automatically unregistered on post decreasing this Run level.

Definition at line 292 of file runtime_intf.h.

◆ tObjectRegistryFlags

enum tObjectRegistryFlags : uint32_t

Enumerator
ORF_None
ORF_MarkedForDeletion
ORF_ServiceIsShutdown
ORF_RegisterOnChangingRL

Definition at line 273 of file runtime_intf.h.

◆ tPluginFlags

enum tPluginFlags : uint8_t

InternalFlags.

Enumerator

PF_NONE

no flags, default setting

PF_UNMANAGED

if plugin is unloaded, also remove entry from registration.

this makes sense, if a plugin is registered manually through an api call.

PF_MARKEDFORDELETION

if plugin is unloaded, this is the flag for deletion

Definition at line 282 of file runtime_intf.h.

◆ tRunLevel

enum tRunLevel : int8_t

Run levels.

Enumerator
RL_Shutdown	The system is shut down.
RL_Internal	Invalid run level that signals unmanaged modules.

Definition at line 122 of file runtime_intf.h.

◆ tRuntimeHookId

enum tRuntimeHookId : uint32_t

Runtime hook identifiers.

Enumerator
RHI_Create	Called after the runtime instance was created.
RHI_Start	Called after the runtime instance was started.
RHI_Stop	Called before the runtime instance is stopped.
RHI_Destroy	Called before the runtime instance is destroyed.
RHI_RegisterObject	Called after an object has been registered. `pObject` of RuntimeHook is set to the object registered. IRuntimeHook::tHookInfo::pvData is a const char* pointer and contains the name of the object. IRuntimeHook::tHookInfo::ui32Param1 contains the runlevel for which the object is registered. IRuntimeHook::tHookInfo::ui32Param2 contains the object registration flags, see tObjectRegistryFlags.
RHI_UnregisterObject	Called before an object is unregistered. `pObject` of RuntimeHook is set to the object unregistered. IRuntimeHook::tHookInfo::pvData is a const char* pointer and contains the name of the object. IRuntimeHook::tHookInfo::ui32Param1 contains the object deregistration flags, see tUnregisterObjectFlags.
RHI_RegisterClass	Called after a class has been registered. `pObject` of RuntimeHook is set to the class factory. pvData is a const char* pointer and contains the class id. ui32Param2 contains the class registration flags, see tClassRegistryFlags.
RHI_UnregisterClass	Called before a class is unregistered. `pObject` of RuntimeHook is set to the class factory. pvData is a const char* pointer and contains the class id. ui32Param2 contains the class registration flags, see tClassRegistryFlags.
RHI_RegisterPlugin	Called after a plugin has been registered, after it has been loaded, see RHI_LoadPlugin. `pObject` of RuntimeHook is set to the plugin object. pvData is a const char* pointer and contains the URL of the plugin. ui32Param1 contains the runlevel for which the plugin is registered. ui32Param2 contains the plugin registration flags, see tPluginFlags.
RHI_UnregisterPlugin	Called before a plugin is unregistered. `pObject` of RuntimeHook is set to the plugin object. IRuntimeHook::tHookInfo::ui32Param2 contains the plugin registration flags, see tPluginFlags.
RHI_LoadPlugin	Called after a plugin has been loaded. `pObject` of RuntimeHook is set to the plugin object. IRuntimeHook::tHookInfo::pvData is a const char* pointer and contains the URL of the plugin. IRuntimeHook::tHookInfo::ui32Param1 contains the runlevel for which the plugin is registered. IRuntimeHook::tHookInfo::ui32Param2 contains the plugin registration flags, see tPluginFlags.
RHI_CreateInstance	Called after an instance has been created. `pObject` of RuntimeHook is set to the newly created object. IRuntimeHook::tHookInfo::pvData is a const char* pointer and contains the class id/OID of the object.
RHI_ServiceStarting	Called before a service is started. `pObject` of RuntimeHook is set to the service. IRuntimeHook::tHookInfo::pvData is a const char* pointer and contains the registered name of the service.
RHI_ServiceStarted	Called after a service was started. `pObject` of RuntimeHook is set to the service. IRuntimeHook::tHookInfo::pvData is a const char* pointer and contains the registered name of the service.
RHI_ServiceStopping	Called before a service is stopped. `pObject` of RuntimeHook is set to the service. IRuntimeHook::tHookInfo::pvData is a const char* pointer and contains the registered name of the service.
RHI_ServiceStopped	Called after a service has been stopped. `pObject` of RuntimeHook is set to the service. IRuntimeHook::tHookInfo::pvData is a const char* pointer and contains the registered name of the service.
RHI_RunLevelPreIncrement	Called before the run level is incremented. IRuntimeHook::tHookInfo::ui32Param1 contains the runlevel.
RHI_RunLevelPostIncrement	Called after the run level was incremented. IRuntimeHook::tHookInfo::ui32Param1 contains the runlevel.
RHI_RunLevelPreDecrement	Called before the run level is decremented. ui32Param1 contains the runlevel.
RHI_RunLevelPostDecrement	Called after the run level was decremented. ui32Param1 contains the runlevel.
RHI_RunLevelIncrementing	Called before the run level is incrementing. ui32Param1 contains the runlevel reaching.
RHI_RunLevelDecrementing	Called while the run level is decrementing. ui32Param1 contains the runlevel leaving.

Definition at line 132 of file runtime_intf.h.

◆ tUnregisterObjectFlags

enum tUnregisterObjectFlags : uint32_t

Run level change flags.

Enumerator
UOF_None	Unused.
UOF_Manually	Manually Unregistered Object.
UOF_Automatically	Automatically Unregistered Object by Runlevelchange.

Definition at line 260 of file runtime_intf.h.

Member Function Documentation

◆ ADTF_IID()

ADTF_IID	(	IRuntime	,
		"runtime.ant.ucom.adtf.iid"	)

Marks the IRuntime to be castable with the ucom_cast<>

See also: ADTF_IID(_interface, _striid)

◆ CreateInstance()

virtual tResult CreateInstance	(	const char *	strCID,
		iobject_ptr< IObject > &	pObject,
		const tChar *	strNameOfObject = "" ) const

pure virtual

Creates a new instance of an object.

The CreateInstance method creates a single uninitialized object of the class associated with a specified class identifier.

Parameters

[in]	strCID	Class identifier (CID) identifying the type of the object to create
[out]	pObject	Shared pointer that receives the created instance as base pointer of type IObject. Upon successful return, `o_pObject` points to the `IObject` interface of the requested object. Upon failure, `nullptr == o_pObject.Get()`.
[in]	strNameOfObject	Name of the object to set

Returns: Returns a standard result code.

◆ GetClasses()

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

pure virtual

Returns a list of classes.

Parameters

[out] lstOfClasses push interface to an list af IClassInfo Container (see i.e. object_list)

Returns: Returns a standard result code.

◆ GetClassFactories()

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

pure virtual

Gets a list for all registered class factories.

Parameters

[out] lstOfClassFactories push interface to an list af IClassFactory Container (see i.e. object_list)

Returns: Returns a standard result code.

◆ GetObject() [1/2]

virtual tResult GetObject ( iobject_ptr< IObject > & pObject ) const

pure virtual

Get registered object from object registry by interface.

Parameters

[out] pObject Shared pointer that receives the identified object as base pointer of type IObject. Upon successful return, pObject points to the IObject interface of the requested object. Upon failure, nullptr == pObject.Get().

Returns: Returns a standard result code.

Return values

ERR_NOERROR	Everything went fine.
ERR_INVALID_STATE	The runtime hasn't been initialized yet.
ERR_NOT_FOUND	Object identified by `strOID` is unknown to the object registry.

◆ GetObject() [2/2]

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

pure virtual

Get registered object from object registry.

Parameters

[in]	strNameOID	Object instance identifier. If nullptr, the first object matching the requested interface type is returned.
[out]	pObject	Shared pointer that receives the identified object as base pointer of type IObject. Upon successful return, `o_pObject` points to the `IObject` interface of the requested object. Upon failure, `nullptr == o_pObject.Get()`.

Returns: Returns a standard result code.

Return values

ERR_NOERROR	Everything went fine.
ERR_INVALID_STATE	The runtime hasn't been initialized yet.
ERR_NOT_FOUND	Object identified by `strOID` is unknown to the object registry.

◆ GetObjects()

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

pure virtual

Get a list (enumeration) of registered instances.

The EnumObjects method enumerates all registered instances of the object registry.

Parameters

[out] lstOfObjects pointer to a iobject_enum where to push the objects (see i.e. object_list)

Returns: Returns a standard result code.

◆ GetPlugins()

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

pure virtual

Gets a object reference list of registered plugins.

The GetPlugins method enumerates all registered plugins of the plugin registry.

Parameters

[out] lstPluginInfos reference to a iobject_enum where to push the plugin references (see i.e. object_list)

Returns: Returns a standard result code.

◆ GetRunLevel()

virtual int8_t GetRunLevel ( ) const

pure virtual

Get current run level.

The GetRunLevel method returns the current run level.

Returns: Returns the current run level.

◆ RegisterClassFactory()

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

pure virtual

Register class at class registry The RegisterClass method registers all classes of the given factory at the class registry.

Parameters

pClassFactory	[in] Pointer to the class factory instance.
ui32Flags	[in] Registration flags (see tClassRegistryFlags for an explanation of the flags).

Returns: Returns a standard result code.

◆ RegisterHook()

virtual tResult RegisterHook ( IRuntimeHook & oHook )

pure virtual

Register hook.

The RegisterHook method registers a hook interface.

Parameters

[in] oHook Refernce to the hook interface to be registered.

Returns: Returns a standard result code.

◆ RegisterObject()

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

pure virtual

Register object at object registry.

The RegisterObject method registers an object at the object registry.

Parameters

[in]	pObject	Pointer to the object instance.
[in]	strNameOID	Unique identifier for the registered object.
[in]	nRunLevel	Required runlevel.
[in]	ui32Flags	Registration flags. (for internal use only)

Returns: Returns a standard result code.

◆ RegisterPlugin()

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

pure virtual

Register plugin at the plugin registry.

The RegisterPlugin method registers a plugin at the plugin registry.

Parameters

[in]	strUrl	Url of plugin to be registered.
[in]	nRunLevel	Plugin runlevel.
[in]	pPluginInfo	Pointer to plugininfo interface.
[in]	ui32Flags	Registration flags.

Returns: Returns a standard result code.

◆ SetRunLevel()

virtual tResult SetRunLevel	(	int8_t	nRunLevel,
		bool	bWait = true )

pure virtual

Set run level.

The SetRunLevel method changes the global run level and manages all services dependencies.

Parameters

[in]	nRunLevel	runlevel to set.
[in]	bWait	wait until runlevel is changed

Returns: Returns a standard result code.

◆ UnregisterAllPlugins()

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

pure virtual

Unregister all plugin from plugin registry.

The UnregisterAllPlugins method unregisters all plugin from the plugin registry.

Parameters

nRunLevel	[in] Runlevel information.
ui32Flags	[in] Unregistration flags.

Returns: Returns a standard result code.

◆ UnregisterClassFactory()

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

pure virtual

Unregister a class factory from class registry.

All classes this factory is able to construct will be unregistered.

Parameters

[in] pClassFactory classfactory reference to unregister.

Returns: Returns a standard result code.

◆ UnregisterHook()

virtual tResult UnregisterHook ( IRuntimeHook & oHook )

pure virtual

Unregister hook.

The UnregisterHook method unregisters a hook interface.

Parameters

[in] oHook Refernce to the hook interface to be registered..

Returns: Returns a standard result code.

◆ UnregisterObject()

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

pure virtual

Unregister object from object registry.

The UnregisterObject method unregisters an object from the object registry.

Parameters

[in]	pObject	Pointer to the object instance.
[in]	strNameOID	Unique identifier for the registered instance.

Returns: Returns a standard result code.

◆ UnregisterPlugin()

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

pure virtual

Unregister plugin from plugin registry.

The UnregisterPlugin method unregisters a plugin from the plugin registry.

Parameters

pPluginInfo	[in] object reference to a plugin info instance.
ui32Flags	[in] Unregistration flags.

Returns: Returns a standard result code.

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Member Enumeration Documentation

◆ tChangeRunLevelFlags

◆ tClassRegistryFlags

◆ tObjectRegistryFlags

◆ tPluginFlags

◆ tRunLevel

◆ tRuntimeHookId

◆ tUnregisterObjectFlags

Member Function Documentation

◆ ADTF_IID()

◆ CreateInstance()

◆ GetClasses()

◆ GetClassFactories()

◆ GetObject() [1/2]

◆ GetObject() [2/2]

◆ GetObjects()

◆ GetPlugins()

◆ GetRunLevel()

◆ RegisterClassFactory()

◆ RegisterHook()

◆ RegisterObject()

◆ RegisterPlugin()

◆ SetRunLevel()

◆ UnregisterAllPlugins()

◆ UnregisterClassFactory()

◆ UnregisterHook()

◆ UnregisterObject()

◆ UnregisterPlugin()