ADTF  3.18.2
IRunnableabstract
Inheritance diagram for IRunnable:
[legend]

Public Types

typedef std::function< tResult(tNanoSeconds)> tRunFunction
 Type defintion of the function used to implement Run.
 
typedef ant::IRunnable::tActivationType tActivationType
 

Public Member Functions

 ADTF_IID (IRunnable, "runnable.flash.base.adtf.iid")
 defintion of interface id
 
virtual tResult Run (tNanoSeconds tmTimeofActivation, ant::IRunnable::tActivationType ui32ActivationType, const void *pvUserData, size_t nUserDataSize)=0
 The Run method to set the component in running state. More...
 

Protected Member Functions

 ~IRunnable ()=default
 not destructable
 

Detailed Description

Definition at line 102 of file runnable_intf.h.

Member Function Documentation

◆ Run()

virtual tResult Run ( tNanoSeconds  tmTimeofActivation,
ant::IRunnable::tActivationType  ui32ActivationType,
const void *  pvUserData,
size_t  nUserDataSize 
)
pure virtual

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]tmTimeofActivationTime of activation. Usually this is the StreamTime.
[in]ui32ActivationTypeThe activation type for running.
[in]pvUserDatapointer to a activation structure depending on the activation type.
[in]nUserDataSizeSize of the activation structure. (in byte)
Returns
Standard result code.
Return values
ERR_CANCELEDDepending on the caller (timer, cyclic thread) it will break cyclic running.

Implemented in cTriggerFunction, and cTriggerFunction.