#include <PostConnectSequencer.h>

Inheritance diagram for alexaClientSDK::acl::PostConnectSequencer:

Collaboration diagram for alexaClientSDK::acl::PostConnectSequencer:

Public Types
using	PostConnectOperationsSet = std::set< std::shared_ptr< avsCommon::sdkInterfaces::PostConnectOperationInterface >, PostConnectOperationPriorityCompare >
	Alias for the custom post connect operations set where items are grouped based on operation priority. More...

Public Member Functions
	~PostConnectSequencer () override

PostConnectInterface methods
bool	doPostConnect (std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface > postConnectSender, std::shared_ptr< PostConnectObserverInterface > postConnectObserver) override

void	onDisconnect () override

Public Member Functions inherited from alexaClientSDK::acl::PostConnectInterface
virtual	~PostConnectInterface ()=default

Static Public Member Functions
static std::shared_ptr< PostConnectSequencer >	create (const PostConnectOperationsSet &postConnectOperations)

Detailed Description

Class that runs a PostConnectOperationInterface list in sequence.

Member Typedef Documentation

◆ PostConnectOperationsSet

using alexaClientSDK::acl::PostConnectSequencer::PostConnectOperationsSet = std::set< std::shared_ptr<avsCommon::sdkInterfaces::PostConnectOperationInterface>, PostConnectOperationPriorityCompare>

Alias for the custom post connect operations set where items are grouped based on operation priority.

Constructor & Destructor Documentation

◆ ~PostConnectSequencer()

alexaClientSDK::acl::PostConnectSequencer::~PostConnectSequencer ( )

override

Destructor.

Member Function Documentation

◆ create()

static std::shared_ptr<PostConnectSequencer> alexaClientSDK::acl::PostConnectSequencer::create ( const PostConnectOperationsSet & postConnectOperations )

static

Creates a PostConnectSequencer instance.

Parameters

postConnectOperations The ordered list of PostConnectOperationInterfaces.

Returns: a new instance of the PostConnectSequencer.

◆ doPostConnect()

bool alexaClientSDK::acl::PostConnectSequencer::doPostConnect	(	std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface >	postConnectSender,
		std::shared_ptr< PostConnectObserverInterface >	postConnectObserver
	)

overridevirtual

The main method which is responsible for doing the PostConnect action.

Note: : This method is not expected to be called twice throughout the lifecycle of the object.

Parameters

postConnectSender	The `MessageSenderInterface` used to send post connect messages.
postConnectObserver	The `PostConnectObserverInterface` to get notified on success or failure of the post connect action.

Returns: A boolean to indicate that the post connect process has been successfully initiated.

Implements alexaClientSDK::acl::PostConnectInterface.

◆ onDisconnect()

void alexaClientSDK::acl::PostConnectSequencer::onDisconnect ( )

overridevirtual

Handle notification that the connection has been lost.