SettingObserverInterface.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_SETTINGOBSERVERINTERFACE_H_
#define ALEXA_CLIENT_SDK_SETTINGS_INCLUDE_SETTINGS_SETTINGOBSERVERINTERFACE_H_

#include <functional>
#include <memory>
#include <ostream>

namespace alexaClientSDK {
namespace settings {

enum class SettingNotifications {
    LOCAL_CHANGE_IN_PROGRESS,
    AVS_CHANGE_IN_PROGRESS,
    LOCAL_CHANGE,
    AVS_CHANGE,
    LOCAL_CHANGE_FAILED,
    AVS_CHANGE_FAILED,
    LOCAL_CHANGE_CANCELLED,
    AVS_CHANGE_CANCELLED
};

inline std::ostream& operator<<(std::ostream& stream, const SettingNotifications& value) {
    switch (value) {
        case SettingNotifications::LOCAL_CHANGE_IN_PROGRESS:
            stream << "LOCAL_CHANGE_IN_PROGRESS";
            return stream;
        case SettingNotifications::AVS_CHANGE_IN_PROGRESS:
            stream << "AVS_CHANGE_IN_PROGRESS";
            return stream;
        case SettingNotifications::LOCAL_CHANGE:
            stream << "LOCAL_CHANGE";
            return stream;
        case SettingNotifications::AVS_CHANGE:
            stream << "AVS_CHANGE";
            return stream;
        case SettingNotifications::LOCAL_CHANGE_FAILED:
            stream << "LOCAL_CHANGE_FAILED";
            return stream;
        case SettingNotifications::AVS_CHANGE_FAILED:
            stream << "AVS_CHANGE_FAILED";
            return stream;
        case SettingNotifications::LOCAL_CHANGE_CANCELLED:
            stream << "LOCAL_CHANGE_CANCELLED";
            return stream;
        case SettingNotifications::AVS_CHANGE_CANCELLED:
            stream << "AVS_CHANGE_CANCELLED";
            return stream;
    }

    stream.setstate(std::ios_base::failbit);
    return stream;
}

template <typename SettingT>
class SettingObserverInterface {
public:
    virtual ~SettingObserverInterface() = default;

    virtual void onSettingNotification(
        const typename SettingT::ValueType& value,
        SettingNotifications notification) = 0;

    friend SettingT;
};

}  // namespace settings
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_SETTINGS_INCLUDE_SETTINGS_SETTINGOBSERVERINTERFACE_H_