AlexaInterfaceMessageSender.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_ALEXAINTERFACEMESSAGESENDER_H_
#define ALEXA_CLIENT_SDK_CAPABILITYAGENTS_ALEXA_INCLUDE_ALEXA_ALEXAINTERFACEMESSAGESENDER_H_

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

#include <acsdkShutdownManagerInterfaces/ShutdownNotifierInterface.h>
#include <Alexa/AlexaInterfaceMessageSenderInternalInterface.h>
#include <AVSCommon/SDKInterfaces/ContextManagerInterface.h>
#include <AVSCommon/SDKInterfaces/ContextRequesterInterface.h>
#include <AVSCommon/SDKInterfaces/MessageRequestObserverInterface.h>
#include <AVSCommon/SDKInterfaces/MessageSenderInterface.h>
#include <AVSCommon/Utils/RequiresShutdown.h>
#include <AVSCommon/Utils/Threading/Executor.h>

namespace alexaClientSDK {
namespace capabilityAgents {
namespace alexa {

class AlexaInterfaceMessageSender
        : public AlexaInterfaceMessageSenderInternalInterface
        , public avsCommon::sdkInterfaces::ContextManagerObserverInterface
        , public avsCommon::sdkInterfaces::ContextRequesterInterface
        , public avsCommon::sdkInterfaces::MessageRequestObserverInterface
        , public avsCommon::utils::RequiresShutdown
        , public std::enable_shared_from_this<AlexaInterfaceMessageSender> {
public:
    ~AlexaInterfaceMessageSender();

    static std::shared_ptr<AlexaInterfaceMessageSender> createAlexaInterfaceMessageSender(
        const std::shared_ptr<avsCommon::sdkInterfaces::ContextManagerInterface>& contextManager,
        const std::shared_ptr<avsCommon::sdkInterfaces::MessageSenderInterface>& messageSender,
        const std::shared_ptr<acsdkShutdownManagerInterfaces::ShutdownNotifierInterface>& shutdownNotifier);

    static std::shared_ptr<AlexaInterfaceMessageSenderInternalInterface>
    createAlexaInterfaceMessageSenderInternalInterface(
        const std::shared_ptr<AlexaInterfaceMessageSender>& messageSender);

    static std::shared_ptr<AlexaInterfaceMessageSender> create(
        std::shared_ptr<avsCommon::sdkInterfaces::ContextManagerInterface> contextManager,
        std::shared_ptr<avsCommon::sdkInterfaces::MessageSenderInterface> messageSender);

    void onStateChanged(
        const avsCommon::avs::CapabilityTag& identifier,
        const avsCommon::avs::CapabilityState& state,
        const avsCommon::sdkInterfaces::AlexaStateChangeCauseType cause) override;

    void onContextAvailable(
        const std::string& endpointId,
        const avsCommon::avs::AVSContext& endpointContext,
        avsCommon::sdkInterfaces::ContextRequestToken token) override;
    void onContextFailure(
        const avsCommon::sdkInterfaces::ContextRequestError error,
        avsCommon::sdkInterfaces::ContextRequestToken token) override;

    void onSendCompleted(avsCommon::sdkInterfaces::MessageRequestObserverInterface::Status status) override;
    void onExceptionReceived(const std::string& exceptionMessage) override;

    virtual bool sendStateReportEvent(
        const std::string& instance,
        const std::string& correlationToken,
        const avsCommon::avs::AVSMessageEndpoint& endpoint) override;
    virtual bool sendResponseEvent(
        const std::string& instance,
        const std::string& correlationToken,
        const avsCommon::avs::AVSMessageEndpoint& endpoint,
        const std::string& jsonPayload = "{}") override;
    virtual bool sendResponseEvent(
        const std::string& instance,
        const std::string& correlationToken,
        const avsCommon::avs::AVSMessageEndpoint& endpoint,
        const std::string& responseNamespace,
        const std::string& responseName,
        const std::string& jsonPayload = "{}") override;
    virtual bool sendErrorResponseEvent(
        const std::string& instance,
        const std::string& correlationToken,
        const avsCommon::avs::AVSMessageEndpoint& endpoint,
        const ErrorResponseType errorType,
        const std::string& errorMessage = "") override;
    bool sendErrorResponseEvent(
        const std::string& instance,
        const std::string& correlationToken,
        const avsCommon::avs::AVSMessageEndpoint& endpoint,
        const std::string& responseNamespace,
        const std::string& jsonPayload = "{}") override;
    virtual bool sendDeferredResponseEvent(
        const std::string& instance,
        const std::string& correlationToken,
        const int estimatedDeferralInSeconds = 0) override;

private:
    // Hold Alexa.Response event details until we have context.
    struct ResponseData {
        ResponseData(
            const std::string& type,
            const std::string& instance,
            const std::string& correlationToken,
            const avsCommon::avs::AVSMessageEndpoint& endpoint,
            const std::string& jsonPayload,
            const std::string& responseNamespace);

        const std::string type;

        const std::string instance;

        const std::string correlationToken;

        const avsCommon::avs::AVSMessageEndpoint endpoint;

        const std::string jsonPayload;

        const std::string responseNamespace;
    };

    // Hold Alexa.ChangeReport event details until we have context.
    struct ChangeReportData {
        ChangeReportData(
            const avsCommon::avs::CapabilityTag& tag,
            const avsCommon::avs::CapabilityState& state,
            const avsCommon::sdkInterfaces::AlexaStateChangeCauseType& cause);

        const avsCommon::avs::CapabilityTag tag;

        const avsCommon::avs::CapabilityState state;

        const avsCommon::sdkInterfaces::AlexaStateChangeCauseType cause;
    };

    AlexaInterfaceMessageSender(
        std::shared_ptr<avsCommon::sdkInterfaces::ContextManagerInterface> contextManager,
        std::shared_ptr<avsCommon::sdkInterfaces::MessageSenderInterface> messageSender);

    bool initialize();

    // @name RequiresShutdown method
    void doShutdown() override;

    bool sendCommonResponseEvent(
        const std::string& type,
        const std::string& instance,
        const std::string& correlationToken,
        const avsCommon::avs::AVSMessageEndpoint& endpoint,
        const std::string& jsonPayload = "{}",
        const std::string& responseNamespace = "");

    void completeResponseEvent(
        const std::shared_ptr<ResponseData>& event,
        const avsCommon::utils::Optional<avsCommon::avs::AVSContext>& context =
            avsCommon::utils::Optional<avsCommon::avs::AVSContext>());

    void completeChangeReportEvent(
        const std::shared_ptr<ChangeReportData>& event,
        const avsCommon::avs::AVSContext& context);

    void sendEvent(const std::string& eventJson);

    std::shared_ptr<avsCommon::sdkInterfaces::ContextManagerInterface> m_contextManager;

    std::shared_ptr<avsCommon::sdkInterfaces::MessageSenderInterface> m_messageSender;

    std::map<avsCommon::sdkInterfaces::ContextRequestToken, std::shared_ptr<ResponseData>> m_pendingResponses;

    std::map<avsCommon::sdkInterfaces::ContextRequestToken, std::shared_ptr<ChangeReportData>> m_pendingChangeReports;

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

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

#endif  // ALEXA_CLIENT_SDK_CAPABILITYAGENTS_ALEXA_INCLUDE_ALEXA_ALEXAINTERFACEMESSAGESENDER_H_