SharedAVSSettingProtocol.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_SHAREDAVSSETTINGPROTOCOL_H_
#define ALEXA_CLIENT_SDK_SETTINGS_INCLUDE_SETTINGS_SHAREDAVSSETTINGPROTOCOL_H_

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

#include <AVSCommon/SDKInterfaces/AVSConnectionManagerInterface.h>
#include <AVSCommon/Utils/Metrics/MetricRecorderInterface.h>
#include <AVSCommon/Utils/Threading/Executor.h>

#include "Settings/SetSettingResult.h"
#include "Settings/SettingConnectionObserver.h"
#include "Settings/SettingEventMetadata.h"
#include "Settings/SettingEventSenderInterface.h"
#include "Settings/SettingObserverInterface.h"
#include "Settings/SettingProtocolInterface.h"
#include "Settings/SettingStatus.h"
#include "Settings/Storage/DeviceSettingStorageInterface.h"

namespace alexaClientSDK {
namespace settings {

class SharedAVSSettingProtocol : public SettingProtocolInterface {
public:
    static std::unique_ptr<SharedAVSSettingProtocol> create(
        const SettingEventMetadata& metadata,
        std::shared_ptr<SettingEventSenderInterface> eventSender,
        std::shared_ptr<storage::DeviceSettingStorageInterface> settingStorage,
        std::shared_ptr<avsCommon::sdkInterfaces::AVSConnectionManagerInterface> connectionManager,
        const std::shared_ptr<avsCommon::utils::metrics::MetricRecorderInterface>& metricRecorder,
        bool isDefaultCloudAuthoritative = false);

    SetSettingResult localChange(
        ApplyChangeFunction applyChange,
        RevertChangeFunction revertChange,
        SettingNotificationFunction notifyObservers) override;

    bool avsChange(
        ApplyChangeFunction applyChange,
        RevertChangeFunction revertChange,
        SettingNotificationFunction notifyObservers) override;

    bool restoreValue(ApplyDbChangeFunction applyChange, SettingNotificationFunction notifyObservers) override;
    bool clearData() override;

    void connectionStatusChangeCallback(bool isConnected);

    ~SharedAVSSettingProtocol();

private:
    struct Request {
        Request(ApplyChangeFunction applyFn, RevertChangeFunction revertFn, SettingNotificationFunction notifyFn);

        ApplyChangeFunction applyChange;

        RevertChangeFunction revertChange;

        SettingNotificationFunction notifyObservers;
    };

    SharedAVSSettingProtocol(
        const std::string& settingKey,
        std::shared_ptr<SettingEventSenderInterface> eventSender,
        std::shared_ptr<storage::DeviceSettingStorageInterface> settingStorage,
        std::shared_ptr<avsCommon::sdkInterfaces::AVSConnectionManagerInterface> connectionManager,
        const std::shared_ptr<avsCommon::utils::metrics::MetricRecorderInterface>& metricRecorder,
        bool isDefaultCloudAuthoritative);

    void executeSynchronizeOnConnected();

    const std::string m_key;

    const bool m_isDefaultCloudAuthoritative;

    std::shared_ptr<SettingEventSenderInterface> m_eventSender;

    std::shared_ptr<storage::DeviceSettingStorageInterface> m_storage;

    std::shared_ptr<avsCommon::sdkInterfaces::AVSConnectionManagerInterface> m_connectionManager;

    std::shared_ptr<SettingConnectionObserver> m_connectionObserver;

    std::unique_ptr<Request> m_pendingRequest;

    std::shared_ptr<avsCommon::utils::metrics::MetricRecorderInterface> m_metricRecorder;

    std::mutex m_requestLock;

    avsCommon::utils::threading::Executor m_executor;
};

}  // namespace settings
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_SETTINGS_INCLUDE_SETTINGS_SHAREDAVSSETTINGPROTOCOL_H_