Business logic interface for Optimisable mixin. More...

Inheritance diagram for rtctk::componentFramework::Optimisable< Super >::BizLogicIf:

Public Member Functions
virtual void	ActivityOptimising (StopToken st, const JsonPayload &arg)
	Activity executed in its own thread that performs the requested optimization.

virtual bool	GuardOptimisingAllowed (const JsonPayload &arg)
	Determines if optimising is possible at this time with the provided argument.

Detailed Description

template<typename Super>
class rtctk::componentFramework::Optimisable< Super >::BizLogicIf

Business logic interface for Optimisable mixin.

Member Function Documentation

template<typename Super >

virtual void rtctk::componentFramework::Optimisable< Super >::BizLogicIf::ActivityOptimising	(	StopToken	st,
		const JsonPayload &	arg )

inlinevirtual

Activity executed in its own thread that performs the requested optimization.

Parameters

st	Indicates when activity is requested to stop.
arg	Provides arguments for the optimization to be performed.

Thread Safety: thread-safe – Method is invoked from unspecified thread and must be thread safe.

Exception Safety: basic – Method may throw exception. The exception message will returned to requestor.

template<typename Super >

virtual bool rtctk::componentFramework::Optimisable< Super >::BizLogicIf::GuardOptimisingAllowed ( const JsonPayload & arg )

inlinevirtual

Determines if optimising is possible at this time with the provided argument.

Parameters

arg	Provided argument.

Returns: true if optimising is allowed.; false if optimising is disallowed. This results in the command being rejected.

Exception Safety: basic – Method may throw which will result in optimise request being rejected.

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

componentFramework/rtcComponent/lib/src/include/rtctk/componentFramework/optimisable.hpp