ADTF
|
The Runnable interface defines common methods for a running component. More...
Public Types | |
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. | |
Public Member Functions | |
ADTF_IID (IRunnable, "runnable.ant.base.adtf.iid") | |
defintion of interface id | |
virtual tResult | Run (tTimeStamp tmTimeofActivation, tActivationType ui32ActivationType, const void *pvUserData, size_t nUserDataSize)=0 |
The Run method to set the component in running state. More... | |
virtual tActivationType | GetActivationType () const |
Gets the activation code of the runnable it reacts to. More... | |
Protected Member Functions | |
~IRunnable ()=default | |
not destructable | |
The Runnable interface defines common methods for a running component.
Within ADTF the IRunnable interface is the main interface to use for Running objects.
Definition at line 25 of file runnable_intf.h.
enum tActivationType : uint32_t |
Enumeration of the possible activation types to set a component in running state.
This activation type is part of the adtf::IRunnable::Run call.
Definition at line 43 of file runnable_intf.h.
|
inlinevirtual |
Gets the activation code of the runnable it reacts to.
Definition at line 92 of file runnable_intf.h.
References IRunnable::RUN_UNSPECIFIED.
|
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.
[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) |
ERR_CANCELED | Depending on the caller (timer, cyclic thread) it will break cyclic running. |
Implemented in cRunnable.
Referenced by trigger_pipe_item< INTERFACE >::Run().