DevicePropertyAggregator.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_DIAGNOSTICS_INCLUDE_DIAGNOSTICS_DEVICEPROPERTYAGGREGATOR_H_
#define ALEXA_CLIENT_SDK_DIAGNOSTICS_INCLUDE_DIAGNOSTICS_DEVICEPROPERTYAGGREGATOR_H_

#include <condition_variable>
#include <memory>
#include <mutex>
#include <string>
#include <unordered_map>

#include <AVSCommon/SDKInterfaces/Diagnostics/DevicePropertyAggregatorInterface.h>
#include <AVSCommon/Utils/Optional.h>
#include <AVSCommon/Utils/Threading/Executor.h>
#include <Settings/SettingCallbacks.h>

namespace alexaClientSDK {
namespace diagnostics {

class DevicePropertyAggregator
        : public avsCommon::sdkInterfaces::diagnostics::DevicePropertyAggregatorInterface
        , public std::enable_shared_from_this<DevicePropertyAggregator> {
public:
    static std::shared_ptr<DevicePropertyAggregator> create();

    avsCommon::utils::Optional<std::string> getDeviceProperty(const std::string& propertyKey) override;
    std::unordered_map<std::string, std::string> getAllDeviceProperties() override;
    void setContextManager(std::shared_ptr<avsCommon::sdkInterfaces::ContextManagerInterface> contextManager) override;
    void setDeviceSettingsManager(std::shared_ptr<settings::DeviceSettingsManager> settingManager) override;
    void initializeVolume(std::shared_ptr<avsCommon::sdkInterfaces::SpeakerManagerInterface> speakerManager) override;

    void onAlertStateChange(const AlertObserverInterface::AlertInfo& alertInfo) override;

    virtual void onAuthStateChange(AuthObserverInterface::State newState, AuthObserverInterface::Error error) override;

    void onPlayerActivityChanged(avsCommon::avs::PlayerActivity state, const Context& context) override;

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

    void onContextAvailable(const std::string& jsonContext) override;
    void onContextFailure(const avsCommon::sdkInterfaces::ContextRequestError error) override;

    void onSetIndicator(avsCommon::avs::IndicatorState state) override;
    void onNotificationReceived() override;

    void onSpeakerSettingsChanged(
        const Source& source,
        const avsCommon::sdkInterfaces::ChannelVolumeInterface::Type& type,
        const avsCommon::sdkInterfaces::SpeakerInterface::SpeakerSettings& settings) override;

    void onDialogUXStateChanged(DialogUXState newState) override;

    void onRangeChanged(
        const avsCommon::sdkInterfaces::rangeController::RangeControllerObserverInterface::RangeState& rangeState,
        avsCommon::sdkInterfaces::AlexaStateChangeCauseType cause) override;

    void onPowerStateChanged(
        const avsCommon::sdkInterfaces::powerController::PowerControllerObserverInterface::PowerState& powerState,
        avsCommon::sdkInterfaces::AlexaStateChangeCauseType cause) override;

private:
    DevicePropertyAggregator();

    avsCommon::utils::Optional<std::string> getDeviceContextJson();
    avsCommon::utils::Optional<std::string> getDeviceSetting(const std::string& propertyKey);
    std::unordered_map<std::string, std::string> getSyncDeviceProperties();

    void initializeAsyncPropertyMap();

    void updateSpeakerSettingsInPropertyMap(
        const avsCommon::sdkInterfaces::ChannelVolumeInterface::Type& type,
        const avsCommon::sdkInterfaces::SpeakerInterface::SpeakerSettings& settings);

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

    std::unordered_map<std::string, std::string> m_asyncPropertyMap;

    std::mutex m_deviceContextMutex;

    avsCommon::utils::Optional<std::string> m_deviceContext;

    std::condition_variable m_contextWakeTrigger;

    std::shared_ptr<avsCommon::sdkInterfaces::ContextManagerInterface> m_contextManager;

    std::shared_ptr<settings::DeviceSettingsManager> m_deviceSettingsManager;
};

}  // namespace diagnostics
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_DIAGNOSTICS_INCLUDE_DIAGNOSTICS_DEVICEPROPERTYAGGREGATOR_H_