#include <PostConnectVerifyGatewaySender.h>

Inheritance diagram for alexaClientSDK::avsGatewayManager::PostConnectVerifyGatewaySender:

Collaboration diagram for alexaClientSDK::avsGatewayManager::PostConnectVerifyGatewaySender:

Public Member Functions
	~PostConnectVerifyGatewaySender ()

void	wakeOperation ()

PostConnectOperationInterface Methods
unsigned int	getOperationPriority () override

bool	performOperation (const std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface > &messageSender) override

void	abortOperation () override

Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::PostConnectOperationInterface
virtual	~PostConnectOperationInterface ()=default

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

Static Public Member Functions
static std::shared_ptr< PostConnectVerifyGatewaySender >	create (std::function< void(const std::shared_ptr< PostConnectVerifyGatewaySender > &)> gatewayVerifiedCallback, std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface > metricRecorder=nullptr)

Additional Inherited Members
Static Public Attributes inherited from alexaClientSDK::avsCommon::sdkInterfaces::PostConnectOperationInterface
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...

Detailed Description

The post connect operation which sends the VerifyGateway event.

Constructor & Destructor Documentation

◆ ~PostConnectVerifyGatewaySender()

alexaClientSDK::avsGatewayManager::PostConnectVerifyGatewaySender::~PostConnectVerifyGatewaySender ( )

Destructor for tracking lifecycle.

Member Function Documentation

◆ abortOperation()

void alexaClientSDK::avsGatewayManager::PostConnectVerifyGatewaySender::abortOperation ( )

overridevirtual

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. It is possible, that the method is called before performOperation() call is made.

Implements alexaClientSDK::avsCommon::sdkInterfaces::PostConnectOperationInterface.

◆ create()

static std::shared_ptr<PostConnectVerifyGatewaySender> alexaClientSDK::avsGatewayManager::PostConnectVerifyGatewaySender::create	(	std::function< void(const std::shared_ptr< PostConnectVerifyGatewaySender > &)>	gatewayVerifiedCallback,
		std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface >	metricRecorder = `nullptr`
	)

static

Creates a new instance of PostConnectVerifyGatewaySender.

Parameters

gatewayVerifiedCallback	The callback method that should be called on successful gateway verification.
metricRecorder	Optional (may be nullptr) reference to metric recorder.

Returns: a new instance of the PostConnectVerifyGatewaySender.

◆ getOperationPriority()

unsigned int alexaClientSDK::avsGatewayManager::PostConnectVerifyGatewaySender::getOperationPriority ( )

overridevirtual

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

Returns: unsigned int that representing the operation priority.

Implements alexaClientSDK::avsCommon::sdkInterfaces::PostConnectOperationInterface.

◆ performOperation()

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

override

◆ wakeOperation()

void alexaClientSDK::avsGatewayManager::PostConnectVerifyGatewaySender::wakeOperation ( )

Wakes the PostConnectVerifyGatewaySender if it is on wait state

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

/workplace/avs-device-sdk/AVSGatewayManager/include/AVSGatewayManager/PostConnectVerifyGatewaySender.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members