CommunicationPropertiesHandlerInterface.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 ACSDKCOMMUNICATIONINTERFACES_COMMUNICATIONPROPERTIESHANDLERINTERFACE_H_
#define ACSDKCOMMUNICATIONINTERFACES_COMMUNICATIONPROPERTIESHANDLERINTERFACE_H_

#include <functional>

#include "CommunicationProperty.h"
#include "CommunicationPropertyChangeSubscriber.h"
#include "CommunicationPropertyValidatorInterface.h"

namespace alexaClientSDK {
namespace acsdkCommunicationInterfaces {

template <typename T>
class CommunicationPropertiesHandlerInterface {
public:
    virtual ~CommunicationPropertiesHandlerInterface() = default;

    virtual std::shared_ptr<CommunicationProperty<T>> registerProperty(
        const std::string& propertyName,
        T initValue,
        const std::shared_ptr<CommunicationPropertyValidatorInterface<T>>& writeValidator = nullptr) = 0;
    virtual void deregisterProperty(
        const std::string& propertyName,
        const std::shared_ptr<CommunicationProperty<T>>& property) = 0;
    virtual bool writeProperty(const std::string& propertyName, T newValue) = 0;
    virtual bool readProperty(const std::string& propertyName, T& value) = 0;
    virtual bool subscribeToPropertyChangeEvent(
        const std::string& propertyName,
        const std::weak_ptr<CommunicationPropertyChangeSubscriber<T>>& subscriber) = 0;
    virtual bool unsubscribeToPropertyChangeEvent(
        const std::string& propertyName,
        const std::shared_ptr<CommunicationPropertyChangeSubscriber<T>>& subscriber) = 0;
};

}  // namespace acsdkCommunicationInterfaces
}  // namespace alexaClientSDK

#endif  // ACSDKCOMMUNICATIONINTERFACES_COMMUNICATIONPROPERTIESHANDLERINTERFACE_H_