alexaClientSDK::capabilityAgents::mrm::test::WaitableExceptionEncounteredSender Class Reference

Inheritance diagram for alexaClientSDK::capabilityAgents::mrm::test::WaitableExceptionEncounteredSender:

Collaboration diagram for alexaClientSDK::capabilityAgents::mrm::test::WaitableExceptionEncounteredSender:

Public Member Functions
void	sendExceptionEncountered (const std::string &unparsedDirective, avsCommon::avs::ExceptionErrorType error, const std::string &message) override
bool	wait (const std::chrono::milliseconds timeout)
Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface
virtual	~ExceptionEncounteredSenderInterface ()=default

Detailed Description

WaitableExceptionEncounteredSender is a mock of the ExceptionEncounteredSenderInterface and allows tests to wait for invocations upon those interfaces and inspect the parameters of those invocations.

Member Function Documentation

sendExceptionEncountered()

void alexaClientSDK::capabilityAgents::mrm::test::WaitableExceptionEncounteredSender::sendExceptionEncountered ( const std::string &  unparsedDirective, avsCommon::avs::ExceptionErrorType  error, const std::string &  errorDescription  )

inlineoverridevirtual

Send a System::ExceptionEncountered message to AVS.

Note

The implementation of this method MUST return quickly. Failure to do so blocks the processing of subsequent AVSDirectives.

Parameters

unparsedDirective	The unparsed JSON of the directive.
error	The type of error encountered.
errorDescription	Additional error details for logging and troubleshooting.

Implements alexaClientSDK::avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface.

wait()

bool alexaClientSDK::capabilityAgents::mrm::test::WaitableExceptionEncounteredSender::wait ( const std::chrono::milliseconds  timeout )

inline

Allows the caller to wait until an exception has been sent, up to a maximum timeout. Also returns true if an exception has been previously sent which was not waited upon.

Returns

Whether the exception was sent within the specified timeout, or if an exception has been previously sent, which was not waited upon.

---

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

• /workplace/avs-device-sdk/capabilities/MultiRoomMusic/acsdkMultiRoomMusic/test/MRMCapabilityAgentTest.cpp