ReportStateHandler.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_CAPABILITYAGENTS_SYSTEM_INCLUDE_SYSTEM_REPORTSTATEHANDLER_H_
#define ALEXA_CLIENT_SDK_CAPABILITYAGENTS_SYSTEM_INCLUDE_SYSTEM_REPORTSTATEHANDLER_H_

#include <memory>
#include <string>
#include <thread>

#include <AVSCommon/AVS/CapabilityAgent.h>
#include <AVSCommon/SDKInterfaces/AVSConnectionManagerInterface.h>
#include <AVSCommon/SDKInterfaces/MessageSenderInterface.h>
#include <AVSCommon/SDKInterfaces/Storage/MiscStorageInterface.h>
#include <AVSCommon/Utils/Threading/Executor.h>
#include <RegistrationManager/CustomerDataHandler.h>
#include <Settings/SettingEventSenderInterface.h>
#include <Settings/SettingConnectionObserver.h>

#include "System/StateReportGenerator.h"

namespace alexaClientSDK {
namespace capabilityAgents {
namespace system {

class ReportStateHandler
        : public avsCommon::avs::CapabilityAgent
        , public registrationManager::CustomerDataHandler {
public:
    static std::unique_ptr<ReportStateHandler> create(
        std::shared_ptr<registrationManager::CustomerDataManagerInterface> dataManager,
        std::shared_ptr<avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface> exceptionEncounteredSender,
        std::shared_ptr<avsCommon::sdkInterfaces::AVSConnectionManagerInterface> connectionManager,
        std::shared_ptr<avsCommon::sdkInterfaces::MessageSenderInterface> messageSender,
        std::shared_ptr<avsCommon::sdkInterfaces::storage::MiscStorageInterface> settingStorage,
        const std::vector<StateReportGenerator>& generators);

    avsCommon::avs::DirectiveHandlerConfiguration getConfiguration() const override;
    void handleDirectiveImmediately(std::shared_ptr<avsCommon::avs::AVSDirective> directive) override;
    void preHandleDirective(std::shared_ptr<avsCommon::avs::CapabilityAgent::DirectiveInfo> info) override;
    void handleDirective(std::shared_ptr<avsCommon::avs::CapabilityAgent::DirectiveInfo> info) override;
    void cancelDirective(std::shared_ptr<avsCommon::avs::CapabilityAgent::DirectiveInfo> info) override;

    void clearData() override;

    ~ReportStateHandler();

    void addStateReportGenerator(const StateReportGenerator& generator);

private:
    ReportStateHandler(
        std::shared_ptr<registrationManager::CustomerDataManagerInterface> dataManager,
        std::shared_ptr<avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface> exceptionEncounteredSender,
        std::shared_ptr<avsCommon::sdkInterfaces::AVSConnectionManagerInterface> connectionManager,
        std::shared_ptr<avsCommon::sdkInterfaces::storage::MiscStorageInterface> storage,
        std::unique_ptr<settings::SettingEventSenderInterface> eventSender,
        const std::vector<StateReportGenerator>& generators,
        bool pendingReport);

    bool handleReportState(const avsCommon::avs::AVSDirective& directive);

    void sendReportState();

    void initialize();

private:
    std::mutex m_stateMutex;

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

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

    std::shared_ptr<avsCommon::sdkInterfaces::storage::MiscStorageInterface> m_storage;

    std::vector<StateReportGenerator> m_generators;

    std::unique_ptr<settings::SettingEventSenderInterface> m_eventSender;

    std::shared_ptr<settings::SettingConnectionObserver> m_connectionObserver;

    bool m_pendingReport;
};

}  // namespace system
}  // namespace capabilityAgents
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_CAPABILITYAGENTS_SYSTEM_INCLUDE_SYSTEM_REPORTSTATEHANDLER_H_