AlertScheduler.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_ACSDKALERTS_INCLUDE_ACSDKALERTS_ALERTSCHEDULER_H_
#define ALEXA_CLIENT_SDK_ACSDKALERTS_INCLUDE_ACSDKALERTS_ALERTSCHEDULER_H_

#include "acsdkAlerts/Storage/AlertStorageInterface.h"

#include <AVSCommon/AVS/FocusState.h>
#include <AVSCommon/AVS/MixingBehavior.h>
#include <AVSCommon/Utils/Metrics/MetricRecorderInterface.h>
#include <Settings/DeviceSettingsManager.h>
#include <acsdkAlertsInterfaces/AlertObserverInterface.h>

#include <list>
#include <set>
#include <string>

namespace alexaClientSDK {
namespace acsdkAlerts {

class AlertScheduler : public acsdkAlertsInterfaces::AlertObserverInterface {
public:
    struct AlertsContextInfo {
        std::vector<Alert::ContextInfo> scheduledAlerts;
        std::vector<Alert::ContextInfo> activeAlerts;
    };

    AlertScheduler(
        std::shared_ptr<storage::AlertStorageInterface> alertStorage,
        std::shared_ptr<renderer::RendererInterface> alertRenderer,
        std::chrono::seconds alertPastDueTimeLimitSeconds,
        std::shared_ptr<avsCommon::utils::metrics::MetricRecorderInterface> metricRecorder = nullptr);

    void onAlertStateChange(const AlertInfo& alertInfo) override;

    bool initialize(
        const std::shared_ptr<acsdkAlertsInterfaces::AlertObserverInterface>& observer,
        const std::shared_ptr<settings::DeviceSettingsManager>& settingsManager,
        bool startAlertSchedulingOnInitialization = true);

    bool scheduleAlert(std::shared_ptr<Alert> alert);

    bool saveOfflineStoppedAlert(
        const std::string& alertToken,
        const std::string& scheduledTime,
        const std::string& eventTime);

    bool getOfflineStoppedAlerts(rapidjson::Value* alertContainer, rapidjson::Document::AllocatorType& allocator);

    bool reloadAlertsFromDatabase(
        std::shared_ptr<settings::DeviceSettingsManager> settingsManager,
        bool shouldScheduleAlerts);

    bool snoozeAlert(const std::string& alertToken, const std::string& updatedTime_ISO_8601);

    bool deleteAlert(const std::string& alertToken);

    bool deleteAlerts(const std::list<std::string>& tokenList);

    void deleteOfflineStoppedAlert(const std::string& token, int id);

    bool isAlertActive(std::shared_ptr<Alert> alert);

    std::shared_ptr<Alert> getActiveAlert();

    void updateFocus(avsCommon::avs::FocusState focusState, avsCommon::avs::MixingBehavior behavior);

    avsCommon::avs::FocusState getFocusState();

    AlertScheduler::AlertsContextInfo getContextInfo();

    void onLocalStop();

    void clearData(Alert::StopReason reason = Alert::StopReason::SHUTDOWN);

    void shutdown();

    std::list<std::shared_ptr<Alert>> getAllAlerts();

private:
    void executeOnAlertStateChange(const AlertInfo& alertInfo);

    bool updateAlert(
        const std::shared_ptr<Alert>& alert,
        const std::string& newScheduledTime,
        const Alert::AssetConfiguration& newAssetConfiguration);

    void notifyObserver(const acsdkAlertsInterfaces::AlertObserverInterface::AlertInfo& alertInfo);

    void executeNotifyObserver(const acsdkAlertsInterfaces::AlertObserverInterface::AlertInfo& alertInfo);

    void setTimerForNextAlertLocked();

    void setTimerForNextAlert();

    void activateNextAlertLocked();

    void onAlertReady(const acsdkAlertsInterfaces::AlertObserverInterface::AlertInfo& alertInfo);

    bool isAlertActiveLocked(std::shared_ptr<Alert> alert) const;

    std::shared_ptr<Alert> getAlertLocked(const std::string& token) const;

    std::shared_ptr<Alert> getActiveAlertLocked() const;

    void deactivateActiveAlertHelperLocked(Alert::StopReason reason);

    void eraseAlert(std::shared_ptr<Alert> alert);

    avsCommon::utils::timing::TimeUtils m_timeUtils;

    std::shared_ptr<acsdkAlertsInterfaces::AlertObserverInterface> m_observer;

    std::shared_ptr<settings::DeviceSettingsManager> m_settingsManager;

    std::mutex m_mutex;

    std::shared_ptr<storage::AlertStorageInterface> m_alertStorage;
    std::shared_ptr<renderer::RendererInterface> m_alertRenderer;

    std::chrono::seconds m_alertPastDueTimeLimit;
    avsCommon::avs::FocusState m_focusState;
    avsCommon::avs::MixingBehavior m_mixingBehavior;
    std::shared_ptr<Alert> m_activeAlert;
    std::set<std::shared_ptr<Alert>, acsdkAlerts::TimeComparator> m_scheduledAlerts;

    avsCommon::utils::timing::Timer m_scheduledAlertTimer;

    bool m_shouldScheduleAlerts;

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

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

}  // namespace acsdkAlerts
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_ACSDKALERTS_INCLUDE_ACSDKALERTS_ALERTSCHEDULER_H_