AlexaClientSDK  1.25.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Namespaces | Classes | Functions | Variables
alexaClientSDK::certifiedSender Namespace Reference

Namespaces

 test
 

Classes

class  CertifiedSender
 
class  MessageStorageInterface
 
class  SQLiteMessageStorage
 

Functions

static const std::string TAG ("CertifiedSender")
 String to identify log entries originating from this file. More...
 
bool shouldRetryTransmission (MessageRequestObserverInterface::Status status)
 
static const std::string TAG ("SQLiteMessageStorage")
 String to identify log entries originating from this file. More...
 

Variables

static const int CERTIFIED_SENDER_QUEUE_SIZE_WARN_LIMIT = 25
 The number of items we can store for sending without emitting a warning. More...
 
static const int CERTIFIED_SENDER_QUEUE_SIZE_HARD_LIMIT = 50
 The maximum number of items we can store for sending. More...
 
static const std::vector< int > EXPONENTIAL_BACKOFF_RETRY_TABLE
 
static const std::string CERTIFIED_SENDER_CONFIGURATION_ROOT_KEY = "certifiedSender"
 The key in our config file to find the root of settings for this Capability Agent. More...
 
static const std::string CERTIFIED_SENDER_DB_FILE_PATH_KEY = "databaseFilePath"
 The key in our config file to find the database file path. More...
 
static const std::string MESSAGES_TABLE_NAME = "messages_with_uri"
 The name of the alerts table. More...
 
static const std::string DATABASE_COLUMN_ID_NAME = "id"
 The name of the 'id' field we will use as the primary key in our tables. More...
 
static const std::string DATABASE_COLUMN_MESSAGE_TEXT_NAME = "message_text"
 The name of the 'message_text' field we will use as the primary key in our tables. More...
 
static const std::string DATABASE_COLUMN_URI = "uri"
 The name of the 'uriPathExtension' field corresponding to the uri path extension of the message. More...
 
static const std::string DATABASE_COLUMN_TIMESTAMP = "timestamp"
 The name of the 'timestamp' field is the creation time of the message. More...
 
static const std::string DATABASE_MESSAGE_SIZE_LIMIT = "25"
 The limit for the load() from the storage, it should be equal to CERTIFIED_SENDER_QUEUE_SIZE_WARN_LIMIT. More...
 
static const std::string DATABASE_MESSAGE_AGE_LIMIT = "5 minutes"
 The age limit of the message that can stay in the database. More...
 
static const std::string CREATE_MESSAGES_TABLE_SQL_STRING
 The SQL string to create the alerts table. More...
 

Function Documentation

◆ shouldRetryTransmission()

bool alexaClientSDK::certifiedSender::shouldRetryTransmission ( MessageRequestObserverInterface::Status  status)
inline

A function to evaluate if the given status suggests that the client should retry sending the message.

Parameters
statusThe status being queried.
Returns
Whether the status means the client should keep retrying.

◆ TAG() [1/2]

static const std::string alexaClientSDK::certifiedSender::TAG ( "SQLiteMessageStorage"  )
static

String to identify log entries originating from this file.

◆ TAG() [2/2]

static const std::string alexaClientSDK::certifiedSender::TAG ( "CertifiedSender"  )
static

String to identify log entries originating from this file.

Variable Documentation

◆ CERTIFIED_SENDER_CONFIGURATION_ROOT_KEY

const std::string alexaClientSDK::certifiedSender::CERTIFIED_SENDER_CONFIGURATION_ROOT_KEY = "certifiedSender"
static

The key in our config file to find the root of settings for this Capability Agent.

◆ CERTIFIED_SENDER_DB_FILE_PATH_KEY

const std::string alexaClientSDK::certifiedSender::CERTIFIED_SENDER_DB_FILE_PATH_KEY = "databaseFilePath"
static

The key in our config file to find the database file path.

◆ CERTIFIED_SENDER_QUEUE_SIZE_HARD_LIMIT

const int alexaClientSDK::certifiedSender::CERTIFIED_SENDER_QUEUE_SIZE_HARD_LIMIT = 50
static

The maximum number of items we can store for sending.

◆ CERTIFIED_SENDER_QUEUE_SIZE_WARN_LIMIT

const int alexaClientSDK::certifiedSender::CERTIFIED_SENDER_QUEUE_SIZE_WARN_LIMIT = 25
static

The number of items we can store for sending without emitting a warning.

◆ CREATE_MESSAGES_TABLE_SQL_STRING

const std::string alexaClientSDK::certifiedSender::CREATE_MESSAGES_TABLE_SQL_STRING
static
Initial value:
= std::string("CREATE TABLE ") + MESSAGES_TABLE_NAME + " (" +
DATABASE_COLUMN_ID_NAME + " INT PRIMARY KEY NOT NULL," +
DATABASE_COLUMN_URI + " TEXT NOT NULL," +
DATABASE_COLUMN_MESSAGE_TEXT_NAME + " TEXT NOT NULL," +
DATABASE_COLUMN_TIMESTAMP + " DATETIME DEFAULT CURRENT_TIMESTAMP);"
static const std::string DATABASE_COLUMN_ID_NAME
The name of the &#39;id&#39; field we will use as the primary key in our tables.
Definition: SQLiteMessageStorage.cpp:51
static const std::string DATABASE_COLUMN_MESSAGE_TEXT_NAME
The name of the &#39;message_text&#39; field we will use as the primary key in our tables.
Definition: SQLiteMessageStorage.cpp:53
static const std::string DATABASE_COLUMN_TIMESTAMP
The name of the &#39;timestamp&#39; field is the creation time of the message.
Definition: SQLiteMessageStorage.cpp:57
static const std::string DATABASE_COLUMN_URI
The name of the &#39;uriPathExtension&#39; field corresponding to the uri path extension of the message...
Definition: SQLiteMessageStorage.cpp:55
static const std::string MESSAGES_TABLE_NAME
The name of the alerts table.
Definition: SQLiteMessageStorage.cpp:49

The SQL string to create the alerts table.

◆ DATABASE_COLUMN_ID_NAME

const std::string alexaClientSDK::certifiedSender::DATABASE_COLUMN_ID_NAME = "id"
static

The name of the 'id' field we will use as the primary key in our tables.

◆ DATABASE_COLUMN_MESSAGE_TEXT_NAME

const std::string alexaClientSDK::certifiedSender::DATABASE_COLUMN_MESSAGE_TEXT_NAME = "message_text"
static

The name of the 'message_text' field we will use as the primary key in our tables.

◆ DATABASE_COLUMN_TIMESTAMP

const std::string alexaClientSDK::certifiedSender::DATABASE_COLUMN_TIMESTAMP = "timestamp"
static

The name of the 'timestamp' field is the creation time of the message.

◆ DATABASE_COLUMN_URI

const std::string alexaClientSDK::certifiedSender::DATABASE_COLUMN_URI = "uri"
static

The name of the 'uriPathExtension' field corresponding to the uri path extension of the message.

◆ DATABASE_MESSAGE_AGE_LIMIT

const std::string alexaClientSDK::certifiedSender::DATABASE_MESSAGE_AGE_LIMIT = "5 minutes"
static

The age limit of the message that can stay in the database.

◆ DATABASE_MESSAGE_SIZE_LIMIT

const std::string alexaClientSDK::certifiedSender::DATABASE_MESSAGE_SIZE_LIMIT = "25"
static

The limit for the load() from the storage, it should be equal to CERTIFIED_SENDER_QUEUE_SIZE_WARN_LIMIT.

◆ EXPONENTIAL_BACKOFF_RETRY_TABLE

const std::vector<int> alexaClientSDK::certifiedSender::EXPONENTIAL_BACKOFF_RETRY_TABLE
static
Initial value:
= {
10000,
50000,
250000,
1250000
}

◆ MESSAGES_TABLE_NAME

const std::string alexaClientSDK::certifiedSender::MESSAGES_TABLE_NAME = "messages_with_uri"
static

The name of the alerts table.

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