EndpointRegistrationManagerInterface.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_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_ENDPOINTS_ENDPOINTREGISTRATIONMANAGERINTERFACE_H_
#define ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_ENDPOINTS_ENDPOINTREGISTRATIONMANAGERINTERFACE_H_

#include <future>
#include <list>
#include <memory>
#include <string>

#include "AVSCommon/SDKInterfaces/Endpoints/EndpointIdentifier.h"
#include "AVSCommon/SDKInterfaces/Endpoints/EndpointInterface.h"
#include "AVSCommon/SDKInterfaces/Endpoints/EndpointModificationData.h"
#include "AVSCommon/SDKInterfaces/Endpoints/EndpointRegistrationObserverInterface.h"

namespace alexaClientSDK {
namespace avsCommon {
namespace sdkInterfaces {
namespace endpoints {

class EndpointRegistrationManagerInterface {
public:
    using RegistrationResult = EndpointRegistrationObserverInterface::RegistrationResult;
    using DeregistrationResult = EndpointRegistrationObserverInterface::DeregistrationResult;
    using UpdateResult = EndpointRegistrationObserverInterface::UpdateResult;

    virtual ~EndpointRegistrationManagerInterface() = default;

    virtual std::future<RegistrationResult> registerEndpoint(std::shared_ptr<EndpointInterface> endpoint) = 0;

    virtual std::future<UpdateResult> updateEndpoint(
        const EndpointIdentifier& endpointId,
        const std::shared_ptr<EndpointModificationData>& endpointModificationData) = 0;

    virtual std::future<DeregistrationResult> deregisterEndpoint(const EndpointIdentifier& endpointId) = 0;

    virtual void addObserver(std::shared_ptr<EndpointRegistrationObserverInterface> observer) = 0;

    virtual void removeObserver(const std::shared_ptr<EndpointRegistrationObserverInterface>& observer) = 0;
};

}  // namespace endpoints
}  // namespace sdkInterfaces
}  // namespace avsCommon
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_ENDPOINTS_ENDPOINTREGISTRATIONMANAGERINTERFACE_H_