SettingProtocolInterface.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_SETTINGS_INCLUDE_SETTINGS_SETTINGPROTOCOLINTERFACE_H_
#define ALEXA_CLIENT_SDK_SETTINGS_INCLUDE_SETTINGS_SETTINGPROTOCOLINTERFACE_H_

#include <functional>
#include <memory>
#include <string>
#include <utility>

#include <AVSCommon/Utils/Threading/Executor.h>

#include "Settings/SetSettingResult.h"
#include "Settings/SettingObserverInterface.h"

namespace alexaClientSDK {
namespace settings {

class SettingProtocolInterface {
public:
    using ApplyChangeFunction = std::function<std::pair<bool, std::string>()>;

    using ApplyDbChangeFunction = std::function<std::pair<bool, std::string>(const std::string& dbValue)>;

    using SettingNotificationFunction = std::function<void(SettingNotifications notification)>;

    using RevertChangeFunction = std::function<std::string()>;

    virtual SetSettingResult localChange(
        ApplyChangeFunction applyChange,
        RevertChangeFunction revertChange,
        SettingNotificationFunction notifyObservers) = 0;

    virtual bool avsChange(
        ApplyChangeFunction applyChange,
        RevertChangeFunction revertChange,
        SettingNotificationFunction notifyObservers) = 0;

    virtual bool restoreValue(ApplyDbChangeFunction applyChange, SettingNotificationFunction notifyObservers) = 0;

    virtual bool clearData() = 0;

    virtual ~SettingProtocolInterface() = default;
};

}  // namespace settings
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_SETTINGS_INCLUDE_SETTINGS_SETTINGPROTOCOLINTERFACE_H_