ADTF: cRunnable

Empty Runnable helper implementation. More...

Inheritance diagram for cRunnable:

Public Member Functions
	cRunnable ()
	default CTOR

virtual	~cRunnable ()
	DTOR.

tResult	Run (tTimeStamp tmTimeofActivation, tActivationType ui32ActivationType, const void *pvUserData, size_t nUserDataSize) override
	The Run method to set the component in running state. More...

Public Member Functions inherited from IRunnable
	ADTF_IID (IRunnable, "runnable.ant.base.adtf.iid")
	defintion of interface id

virtual tActivationType	GetActivationType () const
	Gets the activation code of the runnable it reacts to. More...

Protected Member Functions
	cRunnable (const cRunnable &)=delete
	no copy CTOR

	cRunnable (cRunnable &&)=delete
	no move CTOR

cRunnable &	operator= (const cRunnable &)=delete
	no copy operator

cRunnable &	operator= (cRunnable &&)=delete
	no move operator

Protected Member Functions inherited from IRunnable
	~IRunnable ()=default
	not destructable

Additional Inherited Members
Public Types inherited from IRunnable
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 }
	Enumeration of the possible activation types to set a component in running state. More...

typedef std::function< tResult(tTimeStamp)>	tRunFunction
	Type definition of the function used to implement Run.

Detailed Description

Empty Runnable helper implementation.

Definition at line 22 of file runnable.h.

overridevirtual

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)

Return values

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

Implements IRunnable.