runnable< TYPE_OF_ACTIVATION, Interface >

Runnable helper implementaton template. More...

#include <runnable.h>

Inheritance diagram for runnable< TYPE_OF_ACTIVATION, Interface >:

Public Member Functions
	runnable ()
	CTOR.
	runnable (IRunnable::tRunFunction fcRunOnceFunc)
	Main CTOR with callable function.
virtual	~runnable ()=default
	DTOR.
tResult	Run (tTimeStamp tmTimeofActivation, IRunnable::tActivationType ui32ActivationType, const void *, size_t) override
	IRunnable::Run implementation which will call m_fcRunOnceFunc if ui32ActivationType is TYPE_OF_ACTIVATION.
virtual IRunnable::tActivationType	GetActivationType () const
	Returns the type of activation implemented.
Public Member Functions inherited from object< IRunnable, IRunnable >
tResult	GetInterface (const char *i_strIID, void *&o_pInterface) override
	Query interfaces on an object.
tResult	GetInterface (const char *i_strIID, const void *&o_pInterface) const override
	Provides const correct interface querying.
void	Destroy () const override
	Switch from non-virtual destructor to virtual destructor.
tResult	GetInterface (const char *i_strIID, void *&o_pInterface) override
	Query interfaces on an object.
tResult	GetInterface (const char *i_strIID, const void *&o_pInterface) const override
	Provides const correct interface querying.
void	Destroy () const override
	Switch from non-virtual destructor to virtual destructor.
tResult	GetInterface (const char *i_strIID, void *&o_pInterface) override
	Query interfaces on an object.
tResult	GetInterface (const char *i_strIID, const void *&o_pInterface) const override
	Provides const correct interface querying.
void	Destroy () const override
	Switch from non-virtual destructor to virtual destructor.
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 Attributes
IRunnable::tRunFunction	m_fcRunOnceFunc = nullptr
	given function to call on Run

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

Detailed Description

template<IRunnable::tActivationType TYPE_OF_ACTIVATION = IRunnable::RUN_UNSPECIFIED, typename Interface = IRunnable>
class adtf::base::ant::runnable< TYPE_OF_ACTIVATION, Interface >

Runnable helper implementaton template.

This type will call the given function if Run is called.

Template Parameters

TYPE_OF_ACTIVATION	Activation type this runnable calles the given function
Interface	interface type the runnable will derived from

Definition at line 57 of file runnable.h.

Constructor & Destructor Documentation

runnable() [1/2]

template<IRunnable::tActivationType TYPE_OF_ACTIVATION = IRunnable::RUN_UNSPECIFIED, typename Interface = IRunnable>

runnable ( )

inline

CTOR.

Definition at line 65 of file runnable.h.

runnable() [2/2]

template<IRunnable::tActivationType TYPE_OF_ACTIVATION = IRunnable::RUN_UNSPECIFIED, typename Interface = IRunnable>

runnable ( IRunnable::tRunFunction fcRunOnceFunc )

inline

Main CTOR with callable function.

Parameters

fcRunOnceFunc

run function

Definition at line 68 of file runnable.h.

Member Function Documentation

GetActivationType()

template<IRunnable::tActivationType TYPE_OF_ACTIVATION = IRunnable::RUN_UNSPECIFIED, typename Interface = IRunnable>

virtual IRunnable::tActivationType GetActivationType ( ) const

inlinevirtual

Returns the type of activation implemented.

Returns

the activation type given by TYPE_OF_ACTIVATION

Definition at line 103 of file runnable.h.

Run()

template<IRunnable::tActivationType TYPE_OF_ACTIVATION = IRunnable::RUN_UNSPECIFIED, typename Interface = IRunnable>

tResult Run ( tTimeStamp tmTimeofActivation, IRunnable::tActivationType ui32ActivationType, const void * , size_t  )

inlineoverride

IRunnable::Run implementation which will call m_fcRunOnceFunc if ui32ActivationType is TYPE_OF_ACTIVATION.

Return values

ERR_NOT_INITIALIZED

m_fcRunOnceFunc is not set

The Run method to set the component in running state.

This method will be called to activate the component by a given activation type.

Parameters

[in]	tmTimeofActivation	Time of activation. Usually this is the StreamTime.
[in]	ui32ActivationType	The activation type for running.
[in]	pvUserData	pointer to a activation structure depending on the activation type.
[in]	nUserDataSize	Size of the activation structure. (in byte)

Returns

Standard result code.

Return values

ERR_CANCELED

Depending on the caller (timer, cyclic thread) it will break cyclic running.

Deprecated

Use tActivationType ui32ActivationType, const void* pvUserData, size_t nUserDataSize) instead.

Definition at line 82 of file runnable.h.

Member Data Documentation

m_fcRunOnceFunc

template<IRunnable::tActivationType TYPE_OF_ACTIVATION = IRunnable::RUN_UNSPECIFIED, typename Interface = IRunnable>

IRunnable::tRunFunction m_fcRunOnceFunc = nullptr

protected

given function to call on Run

Definition at line 61 of file runnable.h.

Referenced by runnable< base::ant::IRunnable::RUN_PUSH, ISampleStream::IPushReadEventSink >::Run().