AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Classes | Public Member Functions | List of all members
alexaClientSDK::acl::transport::test::MockExchangeHandlerContext Class Reference
Inheritance diagram for alexaClientSDK::acl::transport::test::MockExchangeHandlerContext:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::acl::transport::test::MockExchangeHandlerContext:
Collaboration graph
[legend]

Classes

class  HTTP2Request
 

Public Member Functions

void onDownchannelConnected () override
 
void onDownchannelFinished () override
 
void onMessageRequestSent (const std::shared_ptr< avsCommon::avs::MessageRequest > &request) override
 
void onMessageRequestTimeout () override
 
void onMessageRequestAcknowledged (const std::shared_ptr< avsCommon::avs::MessageRequest > &request) override
 
void onMessageRequestFinished () override
 
void onPingRequestAcknowledged (bool success) override
 
void onPingTimeout () override
 
void onActivity () override
 
void onForbidden (const std::string &authToken) override
 
std::shared_ptr< avsCommon::utils::http2::HTTP2RequestInterfacecreateAndSendRequest (const avsCommon::utils::http2::HTTP2RequestConfig &cfg) override
 
std::string getAVSGateway () override
 
- Public Member Functions inherited from alexaClientSDK::acl::ExchangeHandlerContextInterface
virtual ~ExchangeHandlerContextInterface ()=default
 
virtual void onMessageRequestSent (const std::shared_ptr< avsCommon::avs::MessageRequest > &request)=0
 
virtual void onMessageRequestAcknowledged (const std::shared_ptr< avsCommon::avs::MessageRequest > &request)=0
 

Member Function Documentation

◆ createAndSendRequest()

std::shared_ptr<avsCommon::utils::http2::HTTP2RequestInterface> alexaClientSDK::acl::transport::test::MockExchangeHandlerContext::createAndSendRequest ( const avsCommon::utils::http2::HTTP2RequestConfig cfg)
inlineoverridevirtual

Create an HTTP2Request for this HTTP2Transport.

Parameters
cfgThe configuration object which defines the request.
Returns
The new instance of HTTP2RequestInterface, or nullptr if the operation failed.

Implements alexaClientSDK::acl::ExchangeHandlerContextInterface.

◆ getAVSGateway()

std::string alexaClientSDK::acl::transport::test::MockExchangeHandlerContext::getAVSGateway ( )
inlineoverridevirtual

Get AVS gateway to send request to.

Implements alexaClientSDK::acl::ExchangeHandlerContextInterface.

◆ onActivity()

void alexaClientSDK::acl::transport::test::MockExchangeHandlerContext::onActivity ( )
inlineoverridevirtual

Notification of network activity between this client and AVS. (this is used to detect sustained inactivity requiring the send of a ping).

Implements alexaClientSDK::acl::ExchangeHandlerContextInterface.

◆ onDownchannelConnected()

void alexaClientSDK::acl::transport::test::MockExchangeHandlerContext::onDownchannelConnected ( )
inlineoverridevirtual

Notification that the downchannel has been established.

Implements alexaClientSDK::acl::ExchangeHandlerContextInterface.

◆ onDownchannelFinished()

void alexaClientSDK::acl::transport::test::MockExchangeHandlerContext::onDownchannelFinished ( )
inlineoverridevirtual

Notification that the downchannel has failed to be established or has disconnected.

Implements alexaClientSDK::acl::ExchangeHandlerContextInterface.

◆ onForbidden()

void alexaClientSDK::acl::transport::test::MockExchangeHandlerContext::onForbidden ( const std::string &  authToken)
inlineoverridevirtual

Notification that a request received a FORBIDDEN (403) response.

Parameters
authTokenThe auth token used for the forbidden request or an empty string if the token is not specified.

Implements alexaClientSDK::acl::ExchangeHandlerContextInterface.

◆ onMessageRequestAcknowledged()

void alexaClientSDK::acl::transport::test::MockExchangeHandlerContext::onMessageRequestAcknowledged ( const std::shared_ptr< avsCommon::avs::MessageRequest > &  request)
inlineoverride

◆ onMessageRequestFinished()

void alexaClientSDK::acl::transport::test::MockExchangeHandlerContext::onMessageRequestFinished ( )
inlineoverridevirtual

Notification tht a message request has finished it's exchange with AVS.

Implements alexaClientSDK::acl::ExchangeHandlerContextInterface.

◆ onMessageRequestSent()

void alexaClientSDK::acl::transport::test::MockExchangeHandlerContext::onMessageRequestSent ( const std::shared_ptr< avsCommon::avs::MessageRequest > &  request)
inlineoverride

◆ onMessageRequestTimeout()

void alexaClientSDK::acl::transport::test::MockExchangeHandlerContext::onMessageRequestTimeout ( )
inlineoverridevirtual

Notification that sending a message request timed out.

Implements alexaClientSDK::acl::ExchangeHandlerContextInterface.

◆ onPingRequestAcknowledged()

void alexaClientSDK::acl::transport::test::MockExchangeHandlerContext::onPingRequestAcknowledged ( bool  success)
inlineoverridevirtual

Notification that sending a ping to AVS has failed or been acknowledged by AVS.

Parameters
successWhether the ping was acknowledged successfully.

Implements alexaClientSDK::acl::ExchangeHandlerContextInterface.

◆ onPingTimeout()

void alexaClientSDK::acl::transport::test::MockExchangeHandlerContext::onPingTimeout ( )
inlineoverridevirtual

Notification that a ping request timed out.

Implements alexaClientSDK::acl::ExchangeHandlerContextInterface.


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

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