MessageRouter.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_ACL_INCLUDE_ACL_TRANSPORT_MESSAGEROUTER_H_
#define ALEXA_CLIENT_SDK_ACL_INCLUDE_ACL_TRANSPORT_MESSAGEROUTER_H_

#include <memory>
#include <mutex>
#include <string>
#include <vector>

#include <acsdkShutdownManagerInterfaces/ShutdownNotifierInterface.h>
#include <AVSCommon/AVS/Attachment/AttachmentManagerInterface.h>
#include <AVSCommon/AVS/MessageRequest.h>
#include <AVSCommon/SDKInterfaces/AuthDelegateInterface.h>
#include <AVSCommon/Utils/Threading/Executor.h>
#include <AVSCommon/Utils/Timing/Timer.h>

#include "ACL/Transport/MessageConsumerInterface.h"
#include "ACL/Transport/MessageRouterInterface.h"
#include "ACL/Transport/MessageRouterObserverInterface.h"
#include "ACL/Transport/TransportFactoryInterface.h"
#include "ACL/Transport/TransportInterface.h"
#include "ACL/Transport/TransportObserverInterface.h"
#include "ACL/Transport/SynchronizedMessageRequestQueue.h"

namespace alexaClientSDK {
namespace acl {

class MessageRouter
        : public MessageRouterInterface
        , public TransportObserverInterface
        , public MessageConsumerInterface
        , public std::enable_shared_from_this<MessageRouter> {
public:
    static const std::chrono::milliseconds DEFAULT_SERVER_SIDE_DISCONNECT_GRACE_PERIOD;

    static std::shared_ptr<MessageRouterInterface> createMessageRouterInterface(
        const std::shared_ptr<acsdkShutdownManagerInterfaces::ShutdownNotifierInterface>& shutdownNotifier,
        const std::shared_ptr<avsCommon::sdkInterfaces::AuthDelegateInterface>& authDelegate,
        const std::shared_ptr<avsCommon::avs::attachment::AttachmentManagerInterface>& attachmentManager,
        const std::shared_ptr<TransportFactoryInterface>& transportFactory);

    MessageRouter(
        std::shared_ptr<avsCommon::sdkInterfaces::AuthDelegateInterface> authDelegate,
        std::shared_ptr<avsCommon::avs::attachment::AttachmentManagerInterface> attachmentManager,
        std::shared_ptr<TransportFactoryInterface> transportFactory,
        const std::string& avsGateway = "",
        int engineType = avsCommon::sdkInterfaces::ENGINE_TYPE_ALEXA_VOICE_SERVICES,
        std::chrono::milliseconds serverSideDisconnectGracePeriod = DEFAULT_SERVER_SIDE_DISCONNECT_GRACE_PERIOD);

    void enable() override;
    void disable() override;
    ConnectionStatus getConnectionStatus() override;
    void sendMessage(std::shared_ptr<avsCommon::avs::MessageRequest> request) override;
    void setAVSGateway(const std::string& avsGateway) override;
    std::string getAVSGateway() override;
    void onWakeConnectionRetry() override;
    void onWakeVerifyConnectivity() override;
    void setObserver(std::shared_ptr<MessageRouterObserverInterface> observer) override;

    void onConnected(std::shared_ptr<TransportInterface> transport) override;

    void onDisconnected(
        std::shared_ptr<TransportInterface> transport,
        avsCommon::sdkInterfaces::ConnectionStatusObserverInterface::ChangedReason reason) override;

    void onServerSideDisconnect(std::shared_ptr<TransportInterface> transport) override;

    void consumeMessage(const std::string& contextId, const std::string& message) override;

    void doShutdown() override;

private:
    void setConnectionStatusLocked(
        const avsCommon::sdkInterfaces::ConnectionStatusObserverInterface::Status status,
        const avsCommon::sdkInterfaces::ConnectionStatusObserverInterface::ChangedReason reason);

    void notifyObserverOnConnectionStatusChanged(
        const avsCommon::sdkInterfaces::ConnectionStatusObserverInterface::Status status,
        const avsCommon::sdkInterfaces::ConnectionStatusObserverInterface::ChangedReason reason);

    void handleNotifyObserverOnConnectionStatusChanged(
        const avsCommon::sdkInterfaces::ConnectionStatusObserverInterface::Status status,
        const avsCommon::sdkInterfaces::ConnectionStatusObserverInterface::ChangedReason reason);

    void notifyObserverOnReceive(const std::string& contextId, const std::string& message);

    void createActiveTransportLocked();

    void disconnectAllTransportsLocked(
        std::unique_lock<std::mutex>& lock,
        const avsCommon::sdkInterfaces::ConnectionStatusObserverInterface::ChangedReason reason);

    std::shared_ptr<MessageRouterObserverInterface> getObserver();

    void safelyResetActiveTransportLocked();

    void safelyReleaseTransport(std::shared_ptr<TransportInterface> transport);

    std::shared_ptr<MessageRouterObserverInterface> m_observer;

    std::string m_avsGateway;

    std::shared_ptr<avsCommon::sdkInterfaces::AuthDelegateInterface> m_authDelegate;

    std::mutex m_connectionMutex;

    avsCommon::sdkInterfaces::ConnectionStatusObserverInterface::Status m_connectionStatus;

    avsCommon::sdkInterfaces::ConnectionStatusObserverInterface::ChangedReason m_connectionReason;

    int m_engineType;

    bool m_isEnabled;

    std::vector<std::shared_ptr<TransportInterface>> m_transports;

    std::shared_ptr<TransportInterface> m_activeTransport;

    std::shared_ptr<avsCommon::avs::attachment::AttachmentManagerInterface> m_attachmentManager;

    std::shared_ptr<TransportFactoryInterface> m_transportFactory;

    std::shared_ptr<SynchronizedMessageRequestQueue> m_requestQueue;

    avsCommon::utils::timing::Timer m_serverSideDisconnectTimer;

    bool m_serverSideDisconnectNotificationPending;

    avsCommon::sdkInterfaces::ConnectionStatusObserverInterface::Status m_lastReportedConnectionStatus;

    const std::chrono::milliseconds m_serverSideReconnectGracePeriod;

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

}  // namespace acl
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_ACL_INCLUDE_ACL_TRANSPORT_MESSAGEROUTER_H_