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

#include <IPCVersionManager.h>

Public Member Functions

 IPCVersionManager ()
 
virtual ~IPCVersionManager ()=default
 
bool handleAssertNamespaceVersions (const rapidjson::Document &payload)
 
bool handleAssertNamespaceVersionsFromString (const std::string &payload)
 
bool validateVersionForNamespace (const std::string &ns, int clientNamespaceVersion)
 
void registerNamespaceVersionEntry (const std::string &ns, int version)
 
void deregisterNamespaceVersionEntry (const std::string &ns)
 

Constructor & Destructor Documentation

◆ IPCVersionManager()

alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::IPCVersionManager::IPCVersionManager ( )

◆ ~IPCVersionManager()

virtual alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::IPCVersionManager::~IPCVersionManager ( )
virtualdefault

Member Function Documentation

◆ deregisterNamespaceVersionEntry()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::IPCVersionManager::deregisterNamespaceVersionEntry ( const std::string &  ns)

Removes a namespace-version entry from the VersionManager

Parameters
nsNamespace of the namespace-version entry to remove

◆ handleAssertNamespaceVersions()

bool alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::IPCVersionManager::handleAssertNamespaceVersions ( const rapidjson::Document &  payload)

Validates the Namespace Versions

Parameters
payloadThe rapidjson payload containing the namespace-version entries.
Returns
true if versions are the same, false if there is a version mismatch.

◆ handleAssertNamespaceVersionsFromString()

bool alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::IPCVersionManager::handleAssertNamespaceVersionsFromString ( const std::string &  payload)

Validates the Namespace Version using a serialized payload

Parameters
payloadThe serialized payload containing the namespace-version entries.
Returns
true if versions are the same, false if there is a version mismatch.

◆ registerNamespaceVersionEntry()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::IPCVersionManager::registerNamespaceVersionEntry ( const std::string &  ns,
int  version 
)

Adds a namespace-version entry to the VersionManager

Parameters
nsThe namespace to add
versionThe version to add

◆ validateVersionForNamespace()

bool alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::IPCVersionManager::validateVersionForNamespace ( const std::string &  ns,
int  clientNamespaceVersion 
)

Validates an individual namespace-version entry

Parameters
nsThe namespace to validate the version of
clientNamespaceVersionThe IPC client version to validate against
Returns
true if versions are the same, false if there is a version mismatch

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