PostConnectOperationInterface.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_POSTCONNECTOPERATIONINTERFACE_H_
#define ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_POSTCONNECTOPERATIONINTERFACE_H_

#include <memory>

#include <AVSCommon/SDKInterfaces/MessageSenderInterface.h>

namespace alexaClientSDK {
namespace avsCommon {
namespace sdkInterfaces {

/*
 * Interface to be implemented by post connect actions that will be executed in sequence by the @c PostConnectSequencer.
 */
class PostConnectOperationInterface {
public:
    static constexpr unsigned int VERIFY_GATEWAY_PRIORITY = 50;

    static constexpr unsigned int ENDPOINT_DISCOVERY_PRIORITY = 100;

    static constexpr unsigned int SYNCHRONIZE_STATE_PRIORITY = 150;

    virtual ~PostConnectOperationInterface() = default;

    virtual unsigned int getOperationPriority() = 0;

    virtual bool performOperation(
        const std::shared_ptr<avsCommon::sdkInterfaces::MessageSenderInterface>& messageSender) = 0;

    virtual void abortOperation() = 0;
};

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

#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_POSTCONNECTOPERATIONINTERFACE_H_