AVSDiscoveryEndpointAttributes.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_AVSCOMMON_AVS_INCLUDE_AVSCOMMON_AVS_AVSDISCOVERYENDPOINTATTRIBUTES_H_
#define ALEXA_CLIENT_SDK_AVSCOMMON_AVS_INCLUDE_AVSCOMMON_AVS_AVSDISCOVERYENDPOINTATTRIBUTES_H_

#include <map>
#include <memory>
#include <string>
#include <vector>

#include <AVSCommon/SDKInterfaces/Endpoints/EndpointIdentifier.h>
#include <AVSCommon/Utils/Optional.h>

namespace alexaClientSDK {
namespace avsCommon {
namespace avs {

struct AVSDiscoveryEndpointAttributes {
    struct Registration {
        std::string productId;

        std::string serialNumber;

        std::string registrationKey;

        std::string productIdKey;

        Registration(
            const std::string& productId,
            const std::string& serialNumber,
            const std::string& registrationKey,
            const std::string& productIdKey);

        Registration() = default;

        bool operator==(const Registration& rhs) {
            return (
                productId == rhs.productId && serialNumber == rhs.serialNumber &&
                registrationKey == rhs.registrationKey && productIdKey == rhs.productIdKey);
        }

        bool operator!=(const Registration& rhs) {
            return !(*this == rhs);
        }
    };

    struct AdditionalAttributes {
        std::string manufacturer;
        std::string model;
        std::string serialNumber;
        std::string firmwareVersion;
        std::string softwareVersion;
        std::string customIdentifier;
    };

    static constexpr size_t MAX_ENDPOINT_IDENTIFIER_LENGTH = 256;
    static constexpr size_t MAX_FRIENDLY_NAME_LENGTH = 128;
    static constexpr size_t MAX_MANUFACTURER_NAME_LENGTH = 128;
    static constexpr size_t MAX_DESCRIPTION_LENGTH = 128;
    static constexpr size_t MAX_ENDPOINT_ADDITIONAL_ATTRIBUTES_LENGTH = 256;
    static constexpr size_t MAX_CONNECTIONS_VALUE_LENGTH = 256;

    static constexpr size_t MAX_COOKIES_SIZE_BYTES = 5000;

    sdkInterfaces::endpoints::EndpointIdentifier endpointId;

    std::string friendlyName;

    std::string description;

    std::string manufacturerName;

    std::vector<std::string> displayCategories;

    utils::Optional<Registration> registration;

    utils::Optional<AdditionalAttributes> additionalAttributes;

    std::vector<std::map<std::string, std::string>> connections;

    std::map<std::string, std::string> cookies;
};

inline AVSDiscoveryEndpointAttributes::Registration::Registration(
    const std::string& productId,
    const std::string& serialNumber,
    const std::string& registrationKey,
    const std::string& productIdKey) :
        productId(productId),
        serialNumber(serialNumber),
        registrationKey(registrationKey),
        productIdKey(productIdKey) {
}

}  // namespace avs
}  // namespace avsCommon
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_AVS_INCLUDE_AVSCOMMON_AVS_AVSDISCOVERYENDPOINTATTRIBUTES_H_