LocaleWakeWordsSetting.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_TYPES_LOCALEWAKEWORDSSETTING_H_
#define ALEXA_CLIENT_SDK_SETTINGS_INCLUDE_SETTINGS_TYPES_LOCALEWAKEWORDSSETTING_H_

#include <memory>
#include <mutex>

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

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

namespace alexaClientSDK {
namespace settings {
namespace types {

class LocaleWakeWordsSetting
        : public LocalesSetting
        , public WakeWordsSetting
        , public avsCommon::sdkInterfaces::ConnectionStatusObserverInterface {
public:
    using RequestId = unsigned int;

    enum class RequestType : uint8_t {
        LOCAL,
        AVS,
        NONE
    };

    static std::shared_ptr<LocaleWakeWordsSetting> create(
        std::shared_ptr<SettingEventSenderInterface> localeEventSender,
        std::shared_ptr<SettingEventSenderInterface> wakeWordsEventSender,
        std::shared_ptr<storage::DeviceSettingStorageInterface> settingStorage,
        std::shared_ptr<avsCommon::sdkInterfaces::LocaleAssetsManagerInterface> assetsManager);

    SetSettingResult setLocalChange(const DeviceLocales& locale) override;
    bool setAvsChange(const DeviceLocales& locale) override;
    bool clearData(const DeviceLocales& locale) override;

    SetSettingResult setLocalChange(const WakeWords& wakeWords) override;
    bool setAvsChange(const WakeWords& WakeWords) override;
    bool clearData(const WakeWords& WakeWords) override;

    void onConnectionStatusChanged(const Status status, const ChangedReason reason) override;

    ~LocaleWakeWordsSetting();

private:
    struct RequestParameters {
        const RequestId id;

        const RequestType localeRequestType;

        const DeviceLocales locales;

        const RequestType wakeWordsRequestType;

        const WakeWords wakeWords;

        RequestParameters(
            const RequestType localeRequestType,
            const DeviceLocales& locales,
            const RequestType wakeWordsRequestType,
            const WakeWords& wakeWords);
    };

    LocaleWakeWordsSetting(
        std::shared_ptr<SettingEventSenderInterface> localeEventSender,
        std::shared_ptr<SettingEventSenderInterface> wakeWordsEventSender,
        std::shared_ptr<storage::DeviceSettingStorageInterface> settingStorage,
        std::shared_ptr<avsCommon::sdkInterfaces::LocaleAssetsManagerInterface> assetsManager);

    SetSettingResult setLocales(const DeviceLocales& locale, RequestType requestType);

    SetSettingResult setWakeWords(const WakeWords& wakeWords, RequestType requestType);

    void synchronize(const RequestParameters& request);

    void synchronizeWakeWords(const RequestParameters& request);

    void synchronizeLocale(const RequestParameters& request);

    void handleFailure(const RequestParameters& request);

    bool storeValues(const RequestParameters& request);

    void executeChangeValue(const RequestParameters& request);

    void notifyObserversOfCancellationLocked(const RequestParameters& request);
    void notifyObserversOfFailure(const RequestParameters& request);
    void notifyObserversOfSuccess(const RequestParameters& request);
    void notifyObserversOfChangeInProgress(const RequestParameters& request);

    inline bool isLatestRequestLocked(const RequestParameters& request) const;

    void restoreInitialValue();

    void clearPendingRequest(const RequestParameters& request);

    std::pair<bool, WakeWords> supportedWakeWords(const DeviceLocales& locale, const WakeWords& wakeWords);

    std::shared_ptr<SettingEventSenderInterface> m_localeEventSender;

    std::shared_ptr<SettingEventSenderInterface> m_wakeWordsEventSender;

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

    std::mutex m_mutex;

    std::unique_ptr<RequestParameters> m_pendingRequest;

    SettingStatus m_localeStatus;

    SettingStatus m_wakeWordsStatus;

    std::shared_ptr<avsCommon::sdkInterfaces::LocaleAssetsManagerInterface> m_assetsManager;

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

}  // namespace types
}  // namespace settings
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_SETTINGS_INCLUDE_SETTINGS_TYPES_LOCALEWAKEWORDSSETTING_H_