Inheritance diagram for alexaClientSDK::integration::test::AVSCommunication:

Collaboration diagram for alexaClientSDK::integration::test::AVSCommunication:

Public Member Functions
void	connect ()

void	disconnect ()

std::shared_ptr< ConnectionStatusObserver >	getConnectionStatusObserver ()

bool	sendEvent (const std::string &jsonContent, avsCommon::sdkInterfaces::MessageRequestObserverInterface::Status expectedStatus, std::chrono::seconds timeout, std::shared_ptr< avsCommon::avs::attachment::AttachmentReader > attachmentReader=nullptr)

bool	checkForServerSideDisconnect ()

Public Member Functions inherited from alexaClientSDK::avsCommon::utils::RequiresShutdown
	RequiresShutdown (const std::string &name)

virtual	~RequiresShutdown ()
	Destructor. More...

const std::string &	name () const

void	shutdown ()

bool	isShutdown () const

Static Public Member Functions
static std::unique_ptr< AVSCommunication >	create (std::shared_ptr< AuthDelegateInterface > authDelegate)

Protected Member Functions
void	doShutdown () override

Detailed Description

This class tests the functionality for communication between client and AVS using ACL library.

Member Function Documentation

◆ checkForServerSideDisconnect()

bool alexaClientSDK::integration::test::AVSCommunication::checkForServerSideDisconnect ( )

The function to check for Server Side Disconnect for the current connection.

Returns: true if disconnect is due to SERVER_SIDE_DISCONNECT else false.

◆ connect()

void alexaClientSDK::integration::test::AVSCommunication::connect ( )

The function to establish connection by enabling the m_avsConnectionManager.

◆ create()

std::unique_ptr< AVSCommunication > alexaClientSDK::integration::test::AVSCommunication::create ( std::shared_ptr< AuthDelegateInterface > authDelegate )

static

Create an AVSCommunication object which initializes m_connectionStatusObserver, m_avsConnectionManager, m_authDelegate and m_messageRouter.

Parameters

authDelegate AuthDelegate to use to authorize access to AVS.

Returns: The created AVSCommunication object or nullptr if create fails.

◆ disconnect()

void alexaClientSDK::integration::test::AVSCommunication::disconnect ( )

The function to tear down the connection by disabling the m_avsConnectionManager.

◆ doShutdown()

void alexaClientSDK::integration::test::AVSCommunication::doShutdown ( )

overrideprotectedvirtual

Prepares/enables this object to be deleted. This should be the last function called on this object prior to deleting (or resetting) its shared_ptr.

Warning

Attempting to call functions on this object after calling shutdown() can result in undefined behavior.
Neglecting to call shutdown() on this object can result in resource leaks or other undefined behavior.

Implements alexaClientSDK::avsCommon::utils::RequiresShutdown.

◆ getConnectionStatusObserver()

std::shared_ptr< ConnectionStatusObserver > alexaClientSDK::integration::test::AVSCommunication::getConnectionStatusObserver ( )

Function to retun the connection status observer.

◆ sendEvent()

bool alexaClientSDK::integration::test::AVSCommunication::sendEvent	(	const std::string &	jsonContent,
		avsCommon::sdkInterfaces::MessageRequestObserverInterface::Status	expectedStatus,
		std::chrono::seconds	timeout,
		std::shared_ptr< avsCommon::avs::attachment::AttachmentReader >	attachmentReader = `nullptr`
	)

The function to send one message to AVS.