Business logic interface for Measurable mixin. More...

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

Public Member Functions
virtual JsonPayload	ActivityMeasuring (StopToken stop_token, const JsonPayload &arg)
	Activity executed in its own thread that peforms the requested measurement specified by JSON argument.

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

Detailed Description

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

Business logic interface for Measurable mixin.

Member Function Documentation

template<typename Super >

virtual JsonPayload rtctk::componentFramework::Measurable< Super >::BizLogicIf::ActivityMeasuring	(	StopToken	stop_token,
		const JsonPayload &	arg )

inlinevirtual

Activity executed in its own thread that peforms the requested measurement specified by JSON argument.

Parameters

stop_token	Indicates when activity is requested to stop.
arg	Provides arguments for measurement 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::Measurable< Super >::BizLogicIf::GuardMeasuringAllowed ( const JsonPayload & arg )

inlinevirtual

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

Parameters

arg	Provides arguments for measurement to be performed.

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

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

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

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