rtctk::componentFramework::Optimisable< Super >::BizLogicIf Class Reference

Business logic interface for Optimisable mixin. More...

#include <rtctk/componentFramework/optimisable.hpp>

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

Public Member Functions
virtual void	ActivityOptimising (StopToken st, const JsonPayload &arg)
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

ActivityOptimising()

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 optimisation

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

      \par Thread Safety
 \parblock \ref thread-safety "thread-safe" --  Method is invoked from unspecified thread and must be thread safe. \endparblock
      \par Exception Safety
 \parblock \ref exception-safety "basic" --  Method may throw exception. The exception message will returned to

requestor.

GuardOptimisingAllowed()

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