#include <IPCVersionManager.h>
◆ IPCVersionManager()
alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::IPCVersionManager::IPCVersionManager |
( |
| ) |
|
◆ ~IPCVersionManager()
virtual alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::IPCVersionManager::~IPCVersionManager |
( |
| ) |
|
|
virtualdefault |
◆ deregisterNamespaceVersionEntry()
void alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::IPCVersionManager::deregisterNamespaceVersionEntry |
( |
const std::string & |
ns | ) |
|
Removes a namespace-version entry from the VersionManager
- Parameters
-
ns | Namespace of the namespace-version entry to remove |
◆ handleAssertNamespaceVersions()
bool alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::IPCVersionManager::handleAssertNamespaceVersions |
( |
const rapidjson::Document & |
payload | ) |
|
Validates the Namespace Versions
- Parameters
-
payload | The 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
-
payload | The 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
-
ns | The namespace to add |
version | The version to add |
◆ validateVersionForNamespace()
bool alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::IPCVersionManager::validateVersionForNamespace |
( |
const std::string & |
ns, |
|
|
int |
clientNamespaceVersion |
|
) |
| |
Validates an individual namespace-version entry
- Parameters
-
ns | The namespace to validate the version of |
clientNamespaceVersion | The 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:
- /workplace/avs-device-sdk/SampleApplications/IPCServerSampleApplication/LibIPCServerSampleApp/include/IPCServerSampleApp/IPC/IPCVersionManager.h
AlexaClientSDK 3.0.0 - Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
Licensed under the Apache License, Version 2.0