#include <runner_fallback.h>

Public Member Functions
	cRunnerFallback ()

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

	cRunnerFallback (cRunnerFallback &&)

	cRunnerFallback (const cRunnerFallback &)=delete

	~cRunnerFallback ()

cRunnerFallback &	operator= (cRunnerFallback &&)

cRunnerFallback &	operator= (const cRunnerFallback &)=delete

tResult	Activate (tTimeStamp tmPeriod=0)

void	Deactivate ()

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.

Constructor & Destructor Documentation

◆ cRunnerFallback() [1/2]

adtf::filter::riddler::cRunnerFallback::cRunnerFallback ( )

Constructs an empty fallback.

◆ cRunnerFallback() [2/2]

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

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

Parameters

[in]	pGraphObject	The graph object that the runner should belong to.
[in]	strRunnerName	The name of the runner.
[in]	fnCallback	The callback that should be called upon triggers.

◆ ~cRunnerFallback()

adtf::filter::riddler::cRunnerFallback::~cRunnerFallback ( )

Destructor

Member Function Documentation

◆ Activate()

tResult adtf::filter::riddler::cRunnerFallback::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] tmPeriod If no Active Runner is connected and this is not zero, a kernel timer with the given period will be created.

Returns: Standard result.

◆ Deactivate()

void adtf::filter::riddler::cRunnerFallback::Deactivate ( )

Prevents future calls to the callback, after the function returns.

The documentation for this class was generated from the following file:

src/libraries/filtersdk/include/adtffiltersdk/runner_fallback.h

Public Member Functions