DiscoveryUtils.h

Go to the documentation of this file.

/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *     http://aws.amazon.com/apache2.0/
 *
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */

#ifndef ALEXA_CLIENT_SDK_CAPABILITIESDELEGATE_INCLUDE_CAPABILITIESDELEGATE_UTILS_DISCOVERYUTILS_H_
#define ALEXA_CLIENT_SDK_CAPABILITIESDELEGATE_INCLUDE_CAPABILITIESDELEGATE_UTILS_DISCOVERYUTILS_H_

#include <map>
#include <utility>
#include <string>
#include <vector>

#include <AVSCommon/AVS/AVSDiscoveryEndpointAttributes.h>
#include <AVSCommon/AVS/CapabilityConfiguration.h>

namespace alexaClientSDK {
namespace capabilitiesDelegate {
namespace utils {

static constexpr int MAX_DISCOVERY_PAYLOAD_SIZE = 256 * 1024;

static constexpr int MAX_DISCOVERY_HEADER_AND_SCOPE_SIZE = 10 * 1024;

static constexpr int MAX_ENDPOINTS_SIZE_IN_PAYLOAD = MAX_DISCOVERY_PAYLOAD_SIZE - MAX_DISCOVERY_HEADER_AND_SCOPE_SIZE;

bool validateCapabilityConfiguration(const avsCommon::avs::CapabilityConfiguration& capabilityConfig);

bool validateEndpointAttributes(const avsCommon::avs::AVSDiscoveryEndpointAttributes& endpointAttributes);

bool compareEndpointConfigurations(
    const std::string& firstEndpointConfigJson,
    const std::string& secondEndpointConfigJson);

std::string getEndpointConfigJson(
    const avsCommon::avs::AVSDiscoveryEndpointAttributes& endpointAttributes,
    const std::vector<avsCommon::avs::CapabilityConfiguration>& capabilities);

std::pair<std::string, std::string> getAddOrUpdateReportEventJson(
    const std::vector<std::string>& endpointConfigurations,
    const std::string& authToken);

std::string getDeleteReportEndpointConfigJson(const std::string& endpointId);

std::string getDeleteReportEventJson(
    const std::vector<std::string>& endpointConfigurations,
    const std::string& authToken);

size_t getMaxEndpoints();

size_t getMaxCapabilitiesPerEndpoint();

}  // namespace utils
}  // namespace capabilitiesDelegate
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_CAPABILITIESDELEGATE_INCLUDE_CAPABILITIESDELEGATE_UTILS_DISCOVERYUTILS_H_