Endpoint.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_ENDPOINTS_INCLUDE_ENDPOINTS_ENDPOINT_H_
#define ALEXA_CLIENT_SDK_ENDPOINTS_INCLUDE_ENDPOINTS_ENDPOINT_H_

#include <list>
#include <mutex>
#include <set>
#include <unordered_map>

#include <AVSCommon/AVS/AVSDiscoveryEndpointAttributes.h>
#include <AVSCommon/AVS/CapabilityConfiguration.h>
#include <AVSCommon/SDKInterfaces/DirectiveHandlerInterface.h>
#include <AVSCommon/SDKInterfaces/Endpoints/EndpointIdentifier.h>
#include <AVSCommon/SDKInterfaces/Endpoints/EndpointInterface.h>
#include <AVSCommon/Utils/RequiresShutdown.h>

namespace alexaClientSDK {
namespace endpoints {

class Endpoint : public avsCommon::sdkInterfaces::endpoints::EndpointInterface {
public:
    using EndpointIdentifier = avsCommon::sdkInterfaces::endpoints::EndpointIdentifier;
    using EndpointAttributes = avsCommon::avs::AVSDiscoveryEndpointAttributes;

    Endpoint(const EndpointAttributes& attributes);

    ~Endpoint();

    EndpointIdentifier getEndpointId() const override;
    EndpointAttributes getAttributes() const override;
    std::vector<avsCommon::avs::CapabilityConfiguration> getCapabilityConfigurations() const override;
    std::unordered_map<
        avsCommon::avs::CapabilityConfiguration,
        std::shared_ptr<avsCommon::sdkInterfaces::DirectiveHandlerInterface>>
    getCapabilities() const override;
    bool update(const std::shared_ptr<avsCommon::sdkInterfaces::endpoints::EndpointModificationData>&
                    endpointModificationData) override;

    bool addCapability(
        const avsCommon::avs::CapabilityConfiguration& capabilityConfiguration,
        std::shared_ptr<avsCommon::sdkInterfaces::DirectiveHandlerInterface> directiveHandler);

    bool removeCapability(const avsCommon::avs::CapabilityConfiguration& capabilityConfiguration);

    bool addCapabilityConfiguration(const avsCommon::avs::CapabilityConfiguration& capabilityConfiguration);

    bool validateEndpointAttributes(const EndpointAttributes& updatedAttributes);

    void addRequireShutdownObjects(
        const std::list<std::shared_ptr<avsCommon::utils::RequiresShutdown>>& requireShutdownObjects);

private:
    mutable std::mutex m_mutex;

    EndpointAttributes m_attributes;

    std::unordered_map<
        avsCommon::avs::CapabilityConfiguration,
        std::shared_ptr<avsCommon::sdkInterfaces::DirectiveHandlerInterface>>
        m_capabilities;

    std::set<std::shared_ptr<avsCommon::utils::RequiresShutdown>> m_requireShutdownObjects;
};

}  // namespace endpoints
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_ENDPOINTS_INCLUDE_ENDPOINTS_ENDPOINT_H_