#include <DirectiveHandlerInterface.h>

Inheritance diagram for alexaClientSDK::avsCommon::sdkInterfaces::DirectiveHandlerInterface:

[legend]

Public Member Functions
virtual	~DirectiveHandlerInterface ()=default

virtual void	handleDirectiveImmediately (std::shared_ptr< avsCommon::avs::AVSDirective > directive)=0

virtual void	preHandleDirective (std::shared_ptr< avsCommon::avs::AVSDirective > directive, std::unique_ptr< DirectiveHandlerResultInterface > result)=0

virtual bool	handleDirective (const std::string &messageId)=0

virtual void	cancelDirective (const std::string &messageId)=0

virtual void	onDeregistered ()=0

virtual avs::DirectiveHandlerConfiguration	getConfiguration () const =0

Detailed Description

Interface for handling AVSDirectives. For each AVSDirective received, implementations of this interface should expect either a single call to handleDirectiveImmediately() or a call to preHandleDirective() followed by a call to handleDirective() unless cancelDirective() is called first. cancelDirective() may also be called after handleDirective().

Note: The implementation of the methods of this interface MUST be thread-safe.; The implementation of the methods of this interface MUST return quickly. Failure to do so blocks the processing of subsequent AVSDirectives.

Constructor & Destructor Documentation

◆ ~DirectiveHandlerInterface()

virtual alexaClientSDK::avsCommon::sdkInterfaces::DirectiveHandlerInterface::~DirectiveHandlerInterface ( )

virtualdefault

Destructor.

Member Function Documentation

◆ cancelDirective()

virtual void alexaClientSDK::avsCommon::sdkInterfaces::DirectiveHandlerInterface::cancelDirective ( const std::string & messageId )

pure virtual

Cancel an ongoing preHandleDirective() or handleDirective() operation for the specified AVSDirective. Once this has been called the DirectiveHandler should not expect to receive further calls regarding this directive.

Note: The implementation of this method MUST be thread-safe.; The implementation of this method MUST return quickly. Failure to do so blocks the processing of subsequent AVSDirectives.

Parameters

messageId The message ID of a directive previously passed to preHandleDirective().

Implemented in alexaClientSDK::avsCommon::avs::CapabilityAgent, and alexaClientSDK::avsCommon::avs::test::TestDirectiveHandler.

◆ getConfiguration()

virtual avs::DirectiveHandlerConfiguration alexaClientSDK::avsCommon::sdkInterfaces::DirectiveHandlerInterface::getConfiguration ( ) const

pure virtual

Returns the configuration of the directive handler.

The configuration consists of multiple directive routing rules and their respective blocking policy. The directives will be matched from the most specific rule (with all fields defined) to the least specific rule (which only matches the directive endpointId).

Returns: The avs::DirectiveHandlerConfiguration of the handler.

◆ handleDirective()

virtual bool alexaClientSDK::avsCommon::sdkInterfaces::DirectiveHandlerInterface::handleDirective ( const std::string & messageId )

pure virtual

Handle the action specified by the directive identified by messageId. The handling of subsequent directives with the same DialogRequestId may be blocked until the DirectiveHandler calls the setSucceeded() method of the DirectiveHandlingResult instance passed in to the preHandleDirective() call for the directive specified by messageId. If handling of this directive fails such that subsequent directives with the same DialogRequestId should be cancelled, this DirectiveHandler should instead call setFailed() to indicate a failure.

Note: If this operation fails, an ExceptionEncountered message should be sent to AVS.; The implementation of this method MUST be thread-safe.; The implementation of this method MUST return quickly. Failure to do so blocks the processing of subsequent AVSDirectives.

Parameters

messageId The message ID of a directive previously passed to preHandleDirective().

Returns: false when messageId is not recognized, else true. Any errors related to handling of a valid messageId should be reported using DirectiveHandlerResultInterface::setFailed().

Implemented in alexaClientSDK::avsCommon::avs::CapabilityAgent, and alexaClientSDK::avsCommon::avs::test::TestDirectiveHandler.

◆ handleDirectiveImmediately()

virtual void alexaClientSDK::avsCommon::sdkInterfaces::DirectiveHandlerInterface::handleDirectiveImmediately ( std::shared_ptr< avsCommon::avs::AVSDirective > directive )

pure virtual

Handle the action specified AVSDirective. Once this has been called the DirectiveHandler should not expect to receive further calls regarding this directive.

Note: The implementation of this method MUST be thread-safe.; The implementation of this method MUST return quickly. Failure to do so blocks the processing of subsequent AVSDirectives.; If this operation fails, an ExceptionEncountered message should be sent to AVS.

Parameters

directive The directive to handle.

◆ onDeregistered()

virtual void alexaClientSDK::avsCommon::sdkInterfaces::DirectiveHandlerInterface::onDeregistered ( )

pure virtual

Notification that this handler has been de-registered and will not receive any more calls.

Implemented in alexaClientSDK::capabilityAgents::aip::AudioInputProcessor, alexaClientSDK::acsdkAudioPlayer::AudioPlayer, alexaClientSDK::acsdkExternalMediaPlayer::ExternalMediaPlayer, alexaClientSDK::acsdkAlerts::AlertsCapabilityAgent, alexaClientSDK::capabilityAgents::speechSynthesizer::SpeechSynthesizer, alexaClientSDK::avsCommon::avs::CapabilityAgent, and alexaClientSDK::avsCommon::avs::test::TestDirectiveHandler.

◆ preHandleDirective()

virtual void alexaClientSDK::avsCommon::sdkInterfaces::DirectiveHandlerInterface::preHandleDirective	(	std::shared_ptr< avsCommon::avs::AVSDirective >	directive,
		std::unique_ptr< DirectiveHandlerResultInterface >	result
	)

pure virtual

Notification that a directive has arrived. This notification gives the DirectiveHandler a chance to prepare for handling the directive. For example, the DirectiveHandler might use this notification to start downloading an asset that will be required when it becomes time to actually handle the directive. The DirectiveHandler will be notified when it should start the actual handling of the directive by a subsequent call to handleDirective(). If an error occurs during the pre-Handling phase and that error should cancel the handling of subsequent AVSDirectives with the same DialogRequestId, the DirectiveHandler should call the setFailed() method on the result instance passed in to this call.

Note: If this operation fails, an ExceptionEncountered message should be sent to AVS.; The implementation of this method MUST be thread-safe.; The implementation of this method MUST return quickly. Failure to do so blocks the processing of subsequent AVSDirectives.

Parameters

directive	The directive to pre-handle.
result	An object to receive the result of the operation.

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

/workplace/avs-device-sdk/AVSCommon/SDKInterfaces/include/AVSCommon/SDKInterfaces/DirectiveHandlerInterface.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~DirectiveHandlerInterface()

Member Function Documentation

◆ cancelDirective()

◆ getConfiguration()

◆ handleDirective()

◆ handleDirectiveImmediately()

◆ onDeregistered()

◆ preHandleDirective()