CapabilityAgent.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_AVSCOMMON_AVS_INCLUDE_AVSCOMMON_AVS_CAPABILITYAGENT_H_
#define ALEXA_CLIENT_SDK_AVSCOMMON_AVS_INCLUDE_AVSCOMMON_AVS_CAPABILITYAGENT_H_

#include <atomic>
#include <unordered_map>
#include <string>
#include <memory>

#include "AVSCommon/AVS/NamespaceAndName.h"
#include "AVSCommon/SDKInterfaces/ExceptionEncounteredSenderInterface.h"
#include "AVSCommon/SDKInterfaces/ChannelObserverInterface.h"
#include "AVSCommon/SDKInterfaces/ContextRequesterInterface.h"
#include "AVSCommon/SDKInterfaces/StateProviderInterface.h"
#include "AVSCommon/SDKInterfaces/DirectiveHandlerInterface.h"
#include "AVSCommon/SDKInterfaces/DirectiveHandlerResultInterface.h"

namespace alexaClientSDK {
namespace avsCommon {
namespace avs {

class CapabilityAgent
        : public sdkInterfaces::DirectiveHandlerInterface
        , public sdkInterfaces::ChannelObserverInterface
        , public sdkInterfaces::StateProviderInterface
        , public sdkInterfaces::ContextRequesterInterface {
public:
    virtual ~CapabilityAgent() = default;

    /*
     * DirectiveHandlerInterface functions.
     *
     * The following four functions implement the @c DirectiveHandlerInterface. Only the message Id is passed to the
     * @c handleDirective and @c cancelDirective functions, so we need to maintain a mapping of the message Id to the
     * @c AVSDirective and @c DirectiveHandlerResultInterface, i.e., @c DirectiveAndResultInterface. The
     * @c DirectiveHandlerInterface functions call the functions of the same name with the
     * @c DirectiveAndResultInterface as the argument.
     */
    void preHandleDirective(
        std::shared_ptr<AVSDirective> directive,
        std::unique_ptr<sdkInterfaces::DirectiveHandlerResultInterface> result) override final;

    bool handleDirective(const std::string& messageId) override final;

    void cancelDirective(const std::string& messageId) override final;

    void onDeregistered() override;

    void onFocusChanged(FocusState newFocus, MixingBehavior behavior) override;

protected:
    CapabilityAgent(
        const std::string& nameSpace,
        std::shared_ptr<sdkInterfaces::ExceptionEncounteredSenderInterface> exceptionEncounteredSender);

    class DirectiveInfo {
    public:
        DirectiveInfo(
            std::shared_ptr<AVSDirective> directiveIn,
            std::unique_ptr<sdkInterfaces::DirectiveHandlerResultInterface> resultIn);

        virtual ~DirectiveInfo() = default;

        std::shared_ptr<AVSDirective> directive;

        std::shared_ptr<sdkInterfaces::DirectiveHandlerResultInterface> result;

        std::atomic<bool> isCancelled;
    };

    virtual std::shared_ptr<DirectiveInfo> createDirectiveInfo(
        std::shared_ptr<AVSDirective> directive,
        std::unique_ptr<sdkInterfaces::DirectiveHandlerResultInterface> result);

    virtual void preHandleDirective(std::shared_ptr<DirectiveInfo> info) = 0;

    virtual void handleDirective(std::shared_ptr<DirectiveInfo> info) = 0;

    virtual void cancelDirective(std::shared_ptr<DirectiveInfo> info) = 0;

    void removeDirective(const std::string& messageId);

    void sendExceptionEncounteredAndReportFailed(
        std::shared_ptr<DirectiveInfo> info,
        const std::string& message,
        avsCommon::avs::ExceptionErrorType type = avsCommon::avs::ExceptionErrorType::INTERNAL_ERROR);

    const std::pair<std::string, std::string> buildJsonEventString(
        const std::string& eventName,
        const std::string& dialogRequestIdString = "",
        const std::string& payload = "{}",
        const std::string& context = "") const;

    const std::string m_namespace;

    std::shared_ptr<sdkInterfaces::ExceptionEncounteredSenderInterface> m_exceptionEncounteredSender;

private:
    std::shared_ptr<DirectiveInfo> getDirectiveInfo(const std::string& messageId);

    std::unordered_map<std::string, std::shared_ptr<DirectiveInfo>> m_directiveInfoMap;

    std::mutex m_mutex;
};

}  // namespace avs
}  // namespace avsCommon
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_AVS_INCLUDE_AVSCOMMON_AVS_CAPABILITYAGENT_H_