CapabilityTag.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_CAPABILITYTAG_H_
#define ALEXA_CLIENT_SDK_AVSCOMMON_AVS_INCLUDE_AVSCOMMON_AVS_CAPABILITYTAG_H_

#include <ostream>
#include <string>

#include <AVSCommon/Utils/Optional.h>

namespace alexaClientSDK {
namespace avsCommon {
namespace avs {

struct CapabilityTag {
    CapabilityTag(
        const std::string& nameSpace,
        const std::string& name,
        const std::string& endpointId,
        const utils::Optional<std::string>& instanceId = utils::Optional<std::string>());

    CapabilityTag(const CapabilityTag& other) = default;

    const std::string nameSpace;

    const std::string name;

    const std::string endpointId;

    const utils::Optional<std::string> instance;

    bool operator<(const CapabilityTag& rhs) const;
    bool operator==(const CapabilityTag& rhs) const;
    bool operator!=(const CapabilityTag& rhs) const;
};

inline std::ostream& operator<<(std::ostream& stream, const CapabilityTag& identifier) {
    stream << "{endpointId:" << identifier.endpointId << ",namespace:" << identifier.nameSpace
           << ",name:" << identifier.name;
    if (identifier.instance.hasValue()) {
        stream << ",instance:" << identifier.instance.value();
    }
    stream << "}";
    return stream;
}

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

namespace std {

template <>
struct hash<alexaClientSDK::avsCommon::avs::CapabilityTag> {
    size_t operator()(const alexaClientSDK::avsCommon::avs::CapabilityTag& in) const;
};

}  // namespace std

#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_AVS_INCLUDE_AVSCOMMON_AVS_CAPABILITYTAG_H_