ADTF  3.18.2
cRunnerFallback

This class is used to provide a fallback kernel thread/timer for a runner of a streaming service. More...

Public Member Functions

 cRunnerFallback ()
 Constructs an empty fallback.
 
 ~cRunnerFallback ()
 Destructor.
 
 cRunnerFallback (streaming::ant::INamedGraphObject *pGraphObject, const char *strRunnerName, const flash::cGraphObject::cTriggerHint &oTriggerHint, std::function< void()> fnCallback)
 This will create a runner with the given name at the graph object. More...
 
 cRunnerFallback (cRunnerFallback &&)
 
 cRunnerFallback (const cRunnerFallback &)=delete
 
cRunnerFallbackoperator= (cRunnerFallback &&)
 
cRunnerFallbackoperator= (const cRunnerFallback &)=delete
 
tResult Activate (tTimeStamp tmPeriod=0)
 This activates the calling of the callback, either by a connected Active Runner or by creating a kernel thread/timer on its own. More...
 
void Deactivate ()
 Prevents future calls to the callback, after the function returns.
 

Private Attributes

std::unique_ptr< cImplementation > m_pImplementation
 

Detailed Description

This class is used to provide a fallback kernel thread/timer for a runner of a streaming service.

Do not use this class in new filter implementations and just create a runner instead! This exists only for session compatibililty of our example streaming sinks and sources.

Definition at line 24 of file runner_fallback.h.

Constructor & Destructor Documentation

◆ cRunnerFallback()

cRunnerFallback ( streaming::ant::INamedGraphObject pGraphObject,
const char *  strRunnerName,
const flash::cGraphObject::cTriggerHint oTriggerHint,
std::function< void()>  fnCallback 
)

This will create a runner with the given name at the graph object.

Parameters
[in]pGraphObjectThe graph object that the runner should belong to.
[in]strRunnerNameThe name of the runner.
[in]fnCallbackThe callback that should be called upon triggers.

Member Function Documentation

◆ Activate()

tResult Activate ( tTimeStamp  tmPeriod = 0)

This activates the calling of the callback, either by a connected Active Runner or by creating a kernel thread/timer on its own.

Parameters
[in]tmPeriodIf no Active Runner is connected and this is not zero, a kernel timer with the given period will be created.
Returns
Standard result.