AlexaClientSDK  1.23.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::acl::PostConnectInterface Class Referenceabstract

#include <PostConnectInterface.h>

Inheritance diagram for alexaClientSDK::acl::PostConnectInterface:
Inheritance graph
[legend]

Public Member Functions

virtual bool doPostConnect (std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface > postConnectSender, std::shared_ptr< PostConnectObserverInterface > postConnectObserver)=0
 
virtual void onDisconnect ()=0
 
virtual ~PostConnectInterface ()=default
 

Detailed Description

Interface for post-connect objects which should be used to perform activities after a connection is established.

Constructor & Destructor Documentation

◆ ~PostConnectInterface()

virtual alexaClientSDK::acl::PostConnectInterface::~PostConnectInterface ( )
virtualdefault

Member Function Documentation

◆ doPostConnect()

virtual bool alexaClientSDK::acl::PostConnectInterface::doPostConnect ( std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface postConnectSender,
std::shared_ptr< PostConnectObserverInterface postConnectObserver 
)
pure virtual

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
postConnectSenderThe MessageSenderInterface used to send post connect messages.
postConnectObserverThe 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.

Implemented in alexaClientSDK::acl::PostConnectSequencer.

◆ onDisconnect()

virtual void alexaClientSDK::acl::PostConnectInterface::onDisconnect ( )
pure virtual

Handle notification that the connection has been lost.

Implemented in alexaClientSDK::acl::PostConnectSequencer.


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

AlexaClientSDK 1.23.0 - Copyright 2016-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0