PostConnectVerifyGatewaySender.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_AVSGATEWAYMANAGER_INCLUDE_AVSGATEWAYMANAGER_POSTCONNECTVERIFYGATEWAYSENDER_H_
#define ALEXA_CLIENT_SDK_AVSGATEWAYMANAGER_INCLUDE_AVSGATEWAYMANAGER_POSTCONNECTVERIFYGATEWAYSENDER_H_

#include <memory>
#include <mutex>
#include <functional>

#include <AVSCommon/SDKInterfaces/PostConnectOperationInterface.h>
#include <AVSCommon/AVS/WaitableMessageRequest.h>
#include <AVSCommon/Utils/Metrics/MetricRecorderInterface.h>
#include <AVSCommon/Utils/WaitEvent.h>
#include <AVSGatewayManager/GatewayVerifyState.h>

namespace alexaClientSDK {
namespace avsGatewayManager {

class PostConnectVerifyGatewaySender
        : public avsCommon::sdkInterfaces::PostConnectOperationInterface
        , public std::enable_shared_from_this<PostConnectVerifyGatewaySender> {
public:
    static std::shared_ptr<PostConnectVerifyGatewaySender> create(
        std::function<void(const std::shared_ptr<PostConnectVerifyGatewaySender>&)> gatewayVerifiedCallback,
        std::shared_ptr<avsCommon::utils::metrics::MetricRecorderInterface> metricRecorder = nullptr);

    ~PostConnectVerifyGatewaySender();

    unsigned int getOperationPriority() override;
    bool performOperation(
        const std::shared_ptr<avsCommon::sdkInterfaces::MessageSenderInterface>& messageSender) override;
    void abortOperation() override;

    void wakeOperation();

private:
    enum class VerifyGatewayReturnCode {
        GATEWAY_VERIFIED,
        CHANGING_GATEWAY,
        FATAL_ERROR,
        RETRIABLE_ERROR
    };

    explicit PostConnectVerifyGatewaySender(
        std::function<void(const std::shared_ptr<PostConnectVerifyGatewaySender>&)> gatewayVerifiedCallback,
        std::shared_ptr<avsCommon::utils::metrics::MetricRecorderInterface> metricRecorder);

    VerifyGatewayReturnCode sendVerifyGateway(
        const std::shared_ptr<avsCommon::sdkInterfaces::MessageSenderInterface>& messageSender);

    bool isStopping();

    void wait(int retryAttempt);

    std::function<void(const std::shared_ptr<PostConnectVerifyGatewaySender>&)> m_gatewayVerifiedCallback;

    std::shared_ptr<avsCommon::utils::metrics::MetricRecorderInterface> m_metricRecorder;

    std::mutex m_mutex;

    bool m_isStopping;

    std::shared_ptr<avsCommon::avs::WaitableMessageRequest> m_postConnectRequest;

    avsCommon::utils::WaitEvent m_wakeEvent;
};

}  // namespace avsGatewayManager
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_AVSGATEWAYMANAGER_INCLUDE_AVSGATEWAYMANAGER_POSTCONNECTVERIFYGATEWAYSENDER_H_