DirectiveRouter.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_DIRECTIVEROUTER_H_
#define ALEXA_CLIENT_SDK_ADSL_INCLUDE_ADSL_DIRECTIVEROUTER_H_

#include <map>
#include <set>
#include <unordered_map>

#include <AVSCommon/AVS/CapabilityTag.h>
#include <AVSCommon/AVS/DirectiveHandlerConfiguration.h>
#include <AVSCommon/AVS/HandlerAndPolicy.h>
#include <AVSCommon/Utils/RequiresShutdown.h>
#include <AVSCommon/Utils/Metrics/MetricEventBuilder.h>
#include <AVSCommon/Utils/Metrics/MetricRecorderInterface.h>

namespace alexaClientSDK {
namespace adsl {
class DirectiveRouter : public avsCommon::utils::RequiresShutdown {
public:
    DirectiveRouter(std::shared_ptr<avsCommon::utils::metrics::MetricRecorderInterface> metricRecorder = nullptr);

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

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

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

    bool preHandleDirective(
        std::shared_ptr<avsCommon::avs::AVSDirective> directive,
        std::unique_ptr<avsCommon::sdkInterfaces::DirectiveHandlerResultInterface> result);

    bool handleDirective(const std::shared_ptr<avsCommon::avs::AVSDirective>& directive);

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

    avsCommon::avs::BlockingPolicy getPolicy(const std::shared_ptr<avsCommon::avs::AVSDirective>& directive);

private:
    void doShutdown() override;

    class HandlerCallScope {
    public:
        HandlerCallScope(
            std::unique_lock<std::mutex>& lock,
            DirectiveRouter* router,
            std::shared_ptr<avsCommon::sdkInterfaces::DirectiveHandlerInterface> handler);

        ~HandlerCallScope();

    private:
        std::unique_lock<std::mutex>& m_lock;

        DirectiveRouter* m_router;

        std::shared_ptr<avsCommon::sdkInterfaces::DirectiveHandlerInterface> m_handler;
    };

    avsCommon::avs::HandlerAndPolicy getHandlerAndPolicyLocked(
        const std::shared_ptr<avsCommon::avs::AVSDirective>& directive);

    std::shared_ptr<avsCommon::sdkInterfaces::DirectiveHandlerInterface> getHandlerLocked(
        std::shared_ptr<avsCommon::avs::AVSDirective> directive);

    void incrementHandlerReferenceCountLocked(
        std::shared_ptr<avsCommon::sdkInterfaces::DirectiveHandlerInterface> handler);

    void decrementHandlerReferenceCountLocked(
        std::unique_lock<std::mutex>& lock,
        std::shared_ptr<avsCommon::sdkInterfaces::DirectiveHandlerInterface> handler);

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

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

    std::mutex m_mutex;

    std::unordered_map<avsCommon::avs::CapabilityTag, avsCommon::avs::HandlerAndPolicy> m_configuration;

    std::unordered_map<std::shared_ptr<avsCommon::sdkInterfaces::DirectiveHandlerInterface>, int>
        m_handlerReferenceCounts;

    void submitMetric(
        avsCommon::utils::metrics::MetricEventBuilder& metricEventBuilder,
        const std::shared_ptr<avsCommon::avs::AVSDirective>& directive);
};

}  // namespace adsl
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_ADSL_INCLUDE_ADSL_DIRECTIVEROUTER_H_