AVSConnectionManager.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_AVSCONNECTIONMANAGER_H_
#define ALEXA_CLIENT_SDK_ACL_INCLUDE_ACL_AVSCONNECTIONMANAGER_H_

#include <atomic>
#include <memory>
#include <mutex>
#include <string>
#include <unordered_set>

#include <acsdkShutdownManagerInterfaces/ShutdownNotifierInterface.h>
#include <AVSCommon/AVS/AbstractAVSConnectionManager.h>
#include <AVSCommon/AVS/MessageRequest.h>
#include <AVSCommon/SDKInterfaces/ConnectionStatusObserverInterface.h>
#include <AVSCommon/SDKInterfaces/InternetConnectionMonitorInterface.h>
#include <AVSCommon/SDKInterfaces/MessageObserverInterface.h>
#include <AVSCommon/Utils/RequiresShutdown.h>

#include "ACL/Transport/MessageRouterInterface.h"
#include "ACL/Transport/MessageRouterObserverInterface.h"

namespace alexaClientSDK {
namespace acl {

class AVSConnectionManager
        : public avsCommon::avs::AbstractAVSConnectionManager
        , public MessageRouterObserverInterface
        , public avsCommon::sdkInterfaces::InternetConnectionObserverInterface
        , public avsCommon::utils::RequiresShutdown
        , public std::enable_shared_from_this<AVSConnectionManager> {
public:
    static std::shared_ptr<MessageSenderInterface> createMessageSenderInterface(
        const std::shared_ptr<AVSConnectionManagerInterface>& connectionManager);

    static std::shared_ptr<AVSConnectionManagerInterface> createAVSConnectionManagerInterface(
        const std::shared_ptr<acsdkShutdownManagerInterfaces::ShutdownNotifierInterface>& shutdownNotifier,
        const std::shared_ptr<MessageRouterInterface>& messageRouter,
        const std::shared_ptr<avsCommon::sdkInterfaces::InternetConnectionMonitorInterface>& internetConnectionMonitor);

    static std::shared_ptr<AVSConnectionManager> create(
        std::shared_ptr<MessageRouterInterface> messageRouter,
        bool isEnabled = true,
        std::unordered_set<std::shared_ptr<avsCommon::sdkInterfaces::ConnectionStatusObserverInterface>>
            connectionStatusObservers =
                std::unordered_set<std::shared_ptr<avsCommon::sdkInterfaces::ConnectionStatusObserverInterface>>(),
        std::unordered_set<std::shared_ptr<avsCommon::sdkInterfaces::MessageObserverInterface>> messageObservers =
            std::unordered_set<std::shared_ptr<avsCommon::sdkInterfaces::MessageObserverInterface>>(),
        std::shared_ptr<avsCommon::sdkInterfaces::InternetConnectionMonitorInterface> internetConnectionMonitor =
            nullptr);

    void enable() override;
    void disable() override;
    bool isEnabled() override;
    void reconnect() override;
    bool isConnected() const override;
    void onWakeConnectionRetry() override;
    void addMessageObserver(std::shared_ptr<avsCommon::sdkInterfaces::MessageObserverInterface> observer) override;
    void removeMessageObserver(std::shared_ptr<avsCommon::sdkInterfaces::MessageObserverInterface> observer) override;

    void sendMessage(std::shared_ptr<avsCommon::avs::MessageRequest> request) override;

    void setAVSGateway(const std::string& avsGateway) override;
    std::string getAVSGateway() const override;

    void onConnectionStatusChanged(bool connected) override;

private:
    AVSConnectionManager(
        std::shared_ptr<MessageRouterInterface> messageRouter,
        std::unordered_set<std::shared_ptr<avsCommon::sdkInterfaces::ConnectionStatusObserverInterface>>
            connectionStatusObservers =
                std::unordered_set<std::shared_ptr<avsCommon::sdkInterfaces::ConnectionStatusObserverInterface>>(),
        std::unordered_set<std::shared_ptr<avsCommon::sdkInterfaces::MessageObserverInterface>> messageObserver =
            std::unordered_set<std::shared_ptr<avsCommon::sdkInterfaces::MessageObserverInterface>>(),
        std::shared_ptr<avsCommon::sdkInterfaces::InternetConnectionMonitorInterface> internetConnectionMonitor =
            nullptr);

    void doShutdown() override;

    void onConnectionStatusChanged(
        const ConnectionStatusObserverInterface::Status status,
        const std::vector<ConnectionStatusObserverInterface::EngineConnectionStatus>& engineConnectionStatuses)
        override;

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

    std::shared_ptr<MessageRouterInterface> getMessageRouter() const;

    std::mutex m_isEnabledMutex;

    mutable std::mutex m_messageRouterMutex;

    bool m_isEnabled;

    std::unordered_set<std::shared_ptr<avsCommon::sdkInterfaces::MessageObserverInterface>> m_messageObservers;

    std::mutex m_messageObserverMutex;

    std::shared_ptr<MessageRouterInterface> m_messageRouter;

    std::shared_ptr<avsCommon::sdkInterfaces::InternetConnectionMonitorInterface> m_internetConnectionMonitor;
};

}  // namespace acl
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_ACL_INCLUDE_ACL_AVSCONNECTIONMANAGER_H_