AlexaInterfaceCapabilityAgent.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_ALEXA_INCLUDE_ALEXA_ALEXAINTERFACECAPABILITYAGENT_H_
#define ALEXA_CLIENT_SDK_CAPABILITYAGENTS_ALEXA_INCLUDE_ALEXA_ALEXAINTERFACECAPABILITYAGENT_H_

#include <memory>
#include <mutex>
#include <set>

#include <acsdkAlexaEventProcessedNotifierInterfaces/AlexaEventProcessedNotifierInterface.h>
#include <acsdkManufactory/Annotated.h>
#include <Alexa/AlexaInterfaceMessageSenderInternalInterface.h>
#include <AVSCommon/AVS/CapabilityAgent.h>
#include <AVSCommon/AVS/CapabilityConfiguration.h>
#include <AVSCommon/SDKInterfaces/AlexaEventProcessedObserverInterface.h>
#include <AVSCommon/SDKInterfaces/Endpoints/EndpointBuilderInterface.h>
#include <AVSCommon/SDKInterfaces/Endpoints/EndpointCapabilitiesRegistrarInterface.h>
#include <AVSCommon/SDKInterfaces/Endpoints/EndpointIdentifier.h>
#include <AVSCommon/SDKInterfaces/Endpoints/DefaultEndpointAnnotation.h>
#include <AVSCommon/Utils/DeviceInfo.h>
#include <AVSCommon/Utils/Threading/Executor.h>

namespace alexaClientSDK {
namespace capabilityAgents {
namespace alexa {

class AlexaInterfaceCapabilityAgent : public avsCommon::avs::CapabilityAgent {
public:
    static std::shared_ptr<AlexaInterfaceCapabilityAgent> createDefaultAlexaInterfaceCapabilityAgent(
        const std::shared_ptr<avsCommon::utils::DeviceInfo>& deviceInfo,
        const std::shared_ptr<avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface>&
            exceptionEncounteredSender,
        const std::shared_ptr<AlexaInterfaceMessageSenderInternalInterface>& alexaMessageSender,
        const std::shared_ptr<acsdkAlexaEventProcessedNotifierInterfaces::AlexaEventProcessedNotifierInterface>&
            alexaEventProcessedNotifier,
        const acsdkManufactory::Annotated<
            avsCommon::sdkInterfaces::endpoints::DefaultEndpointAnnotation,
            avsCommon::sdkInterfaces::endpoints::EndpointCapabilitiesRegistrarInterface>&
            endpointCapabilitiesRegistrar);

    static std::shared_ptr<AlexaInterfaceCapabilityAgent> create(
        const std::shared_ptr<avsCommon::utils::DeviceInfo>& deviceInfo,
        const avsCommon::sdkInterfaces::endpoints::EndpointIdentifier& endpointId,
        const std::shared_ptr<avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface>&
            exceptionEncounteredSender,
        const std::shared_ptr<AlexaInterfaceMessageSenderInternalInterface>& alexaMessageSender);

    static std::shared_ptr<AlexaInterfaceCapabilityAgent> create(
        const avsCommon::utils::DeviceInfo& deviceInfo,
        const avsCommon::sdkInterfaces::endpoints::EndpointIdentifier& endpointId,
        std::shared_ptr<avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface> exceptionEncounteredSender,
        std::shared_ptr<AlexaInterfaceMessageSenderInternalInterface> alexaMessageSender);

    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;

    avsCommon::avs::CapabilityConfiguration getCapabilityConfiguration();

private:
    AlexaInterfaceCapabilityAgent(
        const std::shared_ptr<avsCommon::utils::DeviceInfo>& deviceInfo,
        const avsCommon::sdkInterfaces::endpoints::EndpointIdentifier& endpointId,
        std::shared_ptr<avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface> exceptionEncounteredSender,
        std::shared_ptr<AlexaInterfaceMessageSenderInternalInterface> alexaMessageSender,
        const std::shared_ptr<acsdkAlexaEventProcessedNotifierInterfaces::AlexaEventProcessedNotifierInterface>&
            alexaEventProcessedNotifier);

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

    void removeDirective(const std::shared_ptr<avsCommon::avs::CapabilityAgent::DirectiveInfo>& info);

    void executeSendExceptionEncounteredAndReportFailed(
        const std::shared_ptr<avsCommon::avs::CapabilityAgent::DirectiveInfo>& info,
        avsCommon::avs::ExceptionErrorType errorType,
        const std::string& errorMessage);

    void executeSendErrorResponse(
        const std::shared_ptr<avsCommon::avs::CapabilityAgent::DirectiveInfo>& info,
        avsCommon::sdkInterfaces::AlexaInterfaceMessageSenderInterface::ErrorResponseType errorType,
        const std::string& errorMessage);

    std::shared_ptr<avsCommon::utils::DeviceInfo> m_deviceInfo;

    avsCommon::sdkInterfaces::endpoints::EndpointIdentifier m_endpointId;

    std::shared_ptr<AlexaInterfaceMessageSenderInternalInterface> m_alexaMessageSender;

    std::shared_ptr<acsdkAlexaEventProcessedNotifierInterfaces::AlexaEventProcessedNotifierInterface>
        m_alexaEventProcessedNotifier;

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

}  // namespace alexa
}  // namespace capabilityAgents
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_CAPABILITYAGENTS_ALEXA_INCLUDE_ALEXA_ALEXAINTERFACECAPABILITYAGENT_H_