DirectiveSequencer.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_ADSL_INCLUDE_ADSL_DIRECTIVESEQUENCER_H_
#define ALEXA_CLIENT_SDK_ADSL_INCLUDE_ADSL_DIRECTIVESEQUENCER_H_

#include <condition_variable>
#include <deque>
#include <memory>
#include <mutex>
#include <thread>

#include <acsdkShutdownManagerInterfaces/ShutdownNotifierInterface.h>
#include <AVSCommon/SDKInterfaces/ExceptionEncounteredSenderInterface.h>
#include <AVSCommon/SDKInterfaces/DirectiveSequencerInterface.h>
#include <AVSCommon/Utils/Metrics/MetricRecorderInterface.h>
#include <AVSCommon/Utils/Threading/ConditionVariableWrapper.h>

#include "ADSL/DirectiveProcessor.h"
#include "ADSL/DirectiveRouter.h"

namespace alexaClientSDK {
namespace adsl {

class DirectiveSequencer : public avsCommon::sdkInterfaces::DirectiveSequencerInterface {
public:
    static std::shared_ptr<DirectiveSequencerInterface> createDirectiveSequencerInterface(
        std::shared_ptr<avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface> exceptionSender,
        std::shared_ptr<acsdkShutdownManagerInterfaces::ShutdownNotifierInterface> shutdownNotifier,
        std::shared_ptr<avsCommon::utils::metrics::MetricRecorderInterface> metricRecorder);

    static std::unique_ptr<DirectiveSequencerInterface> create(
        std::shared_ptr<avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface> exceptionSender,
        std::shared_ptr<avsCommon::utils::metrics::MetricRecorderInterface> metricRecorder = nullptr);

    bool addDirectiveHandler(std::shared_ptr<avsCommon::sdkInterfaces::DirectiveHandlerInterface> handler) override;

    bool removeDirectiveHandler(std::shared_ptr<avsCommon::sdkInterfaces::DirectiveHandlerInterface> handler) override;

    void setDialogRequestId(const std::string& dialogRequestId) override;

    std::string getDialogRequestId() override;

    bool onDirective(std::shared_ptr<avsCommon::avs::AVSDirective> directive) override;

    void disable() override;

    void enable() override;

private:
    DirectiveSequencer(
        std::shared_ptr<avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface> exceptionSender,
        std::shared_ptr<avsCommon::utils::metrics::MetricRecorderInterface> metricRecorder);

    void doShutdown() override;

    void receivingLoop();

    void receiveDirectiveLocked(std::unique_lock<std::mutex>& lock);

    std::mutex m_mutex;

    std::shared_ptr<avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface> m_exceptionSender;

    bool m_isShuttingDown;

    bool m_isEnabled;

    DirectiveRouter m_directiveRouter;

    std::shared_ptr<DirectiveProcessor> m_directiveProcessor;

    std::deque<std::shared_ptr<avsCommon::avs::AVSDirective>> m_receivingQueue;

    avsCommon::utils::threading::ConditionVariableWrapper m_wakeReceivingLoop;

    std::shared_ptr<avsCommon::utils::power::PowerResource> m_powerResource;

    std::thread m_receivingThread;
};

}  // namespace adsl
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_ADSL_INCLUDE_ADSL_DIRECTIVESEQUENCER_H_