AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Static Public Member Functions | List of all members
alexaClientSDK::acl::DownchannelHandler Class Reference

#include <DownchannelHandler.h>

Inheritance diagram for alexaClientSDK::acl::DownchannelHandler:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::acl::DownchannelHandler:
Collaboration graph
[legend]

Static Public Member Functions

static std::shared_ptr< DownchannelHandlercreate (std::shared_ptr< ExchangeHandlerContextInterface > context, const std::string &authToken, std::shared_ptr< MessageConsumerInterface > messageConsumer, std::shared_ptr< avsCommon::avs::attachment::AttachmentManagerInterface > attachmentManager, const std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface > &metricRecorder)
 

Additional Inherited Members

- Public Member Functions inherited from alexaClientSDK::acl::ExchangeHandler
 ExchangeHandler (std::shared_ptr< ExchangeHandlerContextInterface > context, const std::string &authToken)
 
virtual ~ExchangeHandler ()=default
 
- Public Member Functions inherited from alexaClientSDK::avsCommon::utils::http2::HTTP2RequestSourceInterface
virtual ~HTTP2RequestSourceInterface ()=default
 
- Public Member Functions inherited from alexaClientSDK::acl::MimeResponseStatusHandlerInterface
virtual ~MimeResponseStatusHandlerInterface ()=default
 
- Protected Attributes inherited from alexaClientSDK::acl::ExchangeHandler
std::shared_ptr< ExchangeHandlerContextInterfacem_context
 The HTTP2Transport instance for which this exchange is to be performed. More...
 
const std::string m_authToken
 The auth token used to make the request. More...
 
const std::string m_authHeader
 The AVS authorization header to send in the request. More...
 

Detailed Description

Handle the HTTP2 request and response that establishes and services the downchannel of an connection to AVS.

Member Function Documentation

◆ create()

static std::shared_ptr<DownchannelHandler> alexaClientSDK::acl::DownchannelHandler::create ( std::shared_ptr< ExchangeHandlerContextInterface context,
const std::string &  authToken,
std::shared_ptr< MessageConsumerInterface messageConsumer,
std::shared_ptr< avsCommon::avs::attachment::AttachmentManagerInterface attachmentManager,
const std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface > &  metricRecorder 
)
static

Create a DownchannelHandler, and send the downchannel request.

Parameters
contextThe ExchangeContext in which this MessageRequest handler will operate.
authTokenThe token to use to authorize the request.
messageConsumerObject to send decoded messages to.
attachmentManagerObject with which to get attachments to write to.
metricRecorderObject with which metrics are logged.
Returns
The new DownchannelHandler or nullptr if the operation failed.

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