alexaClientSDK::avsCommon::sdkInterfaces::PostConnectOperationInterface Class Reference

#include <PostConnectOperationInterface.h>

Inheritance diagram for alexaClientSDK::avsCommon::sdkInterfaces::PostConnectOperationInterface:

Public Member Functions
virtual	~PostConnectOperationInterface ()=default
virtual unsigned int	getOperationPriority ()=0
virtual bool	performOperation (const std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface > &messageSender)=0
virtual void	abortOperation ()=0

Static Public Attributes
static constexpr unsigned int	VERIFY_GATEWAY_PRIORITY = 50
	Operation priority for AVS Gateway Verification. More...
static constexpr unsigned int	ENDPOINT_DISCOVERY_PRIORITY = 100
	Operation priority for Publishing Capabilities to AVS. More...
static constexpr unsigned int	SYNCHRONIZE_STATE_PRIORITY = 150
	Operation priority for sending SynchronizeState event to AVS. More...

Constructor & Destructor Documentation

~PostConnectOperationInterface()

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

virtualdefault

Destructor.

Member Function Documentation

abortOperation()

virtual void alexaClientSDK::avsCommon::sdkInterfaces::PostConnectOperationInterface::abortOperation ( )

pure virtual

Aborts an operation that is currently being executed using the performOperation() method.

Note: This method will be called from a different thread from where the performOperation() is being called from.

Implemented in alexaClientSDK::capabilitiesDelegate::PostConnectCapabilitiesPublisher, alexaClientSDK::synchronizeStateSender::PostConnectSynchronizeStateSender, and alexaClientSDK::avsGatewayManager::PostConnectVerifyGatewaySender.

getOperationPriority()

virtual unsigned int alexaClientSDK::avsCommon::sdkInterfaces::PostConnectOperationInterface::getOperationPriority ( )

pure virtual

Returns the operation priority. The Priority is used to order the sequence of operations in ascending order.

Returns

unsigined int that representing the operation priority.

Implemented in alexaClientSDK::capabilitiesDelegate::PostConnectCapabilitiesPublisher, alexaClientSDK::synchronizeStateSender::PostConnectSynchronizeStateSender, and alexaClientSDK::avsGatewayManager::PostConnectVerifyGatewaySender.

performOperation()

virtual bool alexaClientSDK::avsCommon::sdkInterfaces::PostConnectOperationInterface::performOperation ( const std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface > &  messageSender )

pure virtual

Performs the post connect operation. The implementation should ensure that the performOperation returns immediately after the abortOperation() method is called.

Note

: The performOperation() method is not expected to be called twice.

Parameters

messageSender

- The MessageSenderInterface to send post connect message.

Returns

True if the post connect operation is successful, else false.

Implemented in alexaClientSDK::capabilitiesDelegate::PostConnectCapabilitiesPublisher, alexaClientSDK::synchronizeStateSender::PostConnectSynchronizeStateSender, and alexaClientSDK::avsGatewayManager::PostConnectVerifyGatewaySender.

Member Data Documentation

ENDPOINT_DISCOVERY_PRIORITY

constexpr unsigned int alexaClientSDK::avsCommon::sdkInterfaces::PostConnectOperationInterface::ENDPOINT_DISCOVERY_PRIORITY = 100

static

Operation priority for Publishing Capabilities to AVS.

SYNCHRONIZE_STATE_PRIORITY

constexpr unsigned int alexaClientSDK::avsCommon::sdkInterfaces::PostConnectOperationInterface::SYNCHRONIZE_STATE_PRIORITY = 150

static

Operation priority for sending SynchronizeState event to AVS.

VERIFY_GATEWAY_PRIORITY

constexpr unsigned int alexaClientSDK::avsCommon::sdkInterfaces::PostConnectOperationInterface::VERIFY_GATEWAY_PRIORITY = 50

static

Operation priority for AVS Gateway Verification.

---

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

• /workplace/avs-device-sdk/AVSCommon/SDKInterfaces/include/AVSCommon/SDKInterfaces/PostConnectOperationInterface.h