AVSConnectionManagerInterface.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_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_AVSCONNECTIONMANAGERINTERFACE_H_
#define ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_AVSCONNECTIONMANAGERINTERFACE_H_

#include <memory>

#include "AVSCommon/SDKInterfaces/AVSGatewayAssignerInterface.h"
#include "AVSCommon/SDKInterfaces/ConnectionStatusObserverInterface.h"
#include "AVSCommon/SDKInterfaces/MessageObserverInterface.h"
#include "AVSCommon/SDKInterfaces/MessageSenderInterface.h"

namespace alexaClientSDK {
namespace avsCommon {
namespace sdkInterfaces {

class AVSConnectionManagerInterface
        : public MessageSenderInterface
        , public AVSGatewayAssignerInterface {
public:
    using ConnectionStatusObserverInterface = avsCommon::sdkInterfaces::ConnectionStatusObserverInterface;
    virtual ~AVSConnectionManagerInterface() = default;

    virtual void enable() = 0;

    virtual void disable() = 0;

    virtual bool isEnabled() = 0;

    virtual void reconnect() = 0;

    virtual bool isConnected() const = 0;

    virtual void onWakeConnectionRetry() = 0;

    virtual void addMessageObserver(std::shared_ptr<avsCommon::sdkInterfaces::MessageObserverInterface> observer) = 0;

    virtual void removeMessageObserver(
        std::shared_ptr<avsCommon::sdkInterfaces::MessageObserverInterface> observer) = 0;

    virtual void addConnectionStatusObserver(std::shared_ptr<ConnectionStatusObserverInterface> observer) = 0;

    virtual void removeConnectionStatusObserver(std::shared_ptr<ConnectionStatusObserverInterface> observer) = 0;
};

}  // namespace sdkInterfaces
}  // namespace avsCommon
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_AVSCONNECTIONMANAGERINTERFACE_H_