rtctk::componentFramework::detail::OptimiseContext Class Reference

Holds context necessary for processing a optimise request to completion. More...

#include <rtctk/componentFramework/optimisable.hpp>

Public Member Functions
	OptimiseContext (const rad::cii::Request< std::string, std::string > &request)
	Construct context with provided request.
	OptimiseContext (OptimiseContext &&) noexcept=default
const JsonPayload &	GetArg () const noexcept
void	SendReply () noexcept
	Sends hardcoded string reply.
void	SendErrorReply (std::exception_ptr eptr) noexcept
	Send exceptional reply.

Detailed Description

Holds context necessary for processing a optimise request to completion.

It is meant to encapsulate the life time of a request and provides methods to send result or exceptional replies.

See also

rtctk::componentFramework::Optimisable

Constructor & Destructor Documentation

OptimiseContext() [1/2]

rtctk::componentFramework::detail::OptimiseContext::OptimiseContext ( const rad::cii::Request< std::string, std::string > & request )

inlineexplicit

Construct context with provided request.

Parameters

request

containing JSON encoded string with arguments.

Exceptions

JsonPayload::parse_error

if parsing fails.

OptimiseContext() [2/2]

rtctk::componentFramework::detail::OptimiseContext::OptimiseContext ( OptimiseContext && )

defaultnoexcept

Member Function Documentation

GetArg()

const JsonPayload & rtctk::componentFramework::detail::OptimiseContext::GetArg ( ) const

inlinenoexcept

Returns

Deserialized argument from request.

SendErrorReply()

void rtctk::componentFramework::detail::OptimiseContext::SendErrorReply ( std::exception_ptr eptr )

inlinenoexcept

Send exceptional reply.

Parameters

eptr	Exception to send.

SendReply()

void rtctk::componentFramework::detail::OptimiseContext::SendReply ( )

inlinenoexcept

Sends hardcoded string reply.

Exceptions

boost::promise_already_satisfied

if reply has already been set.

---

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

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