CertifiedSender.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_CERTIFIEDSENDER_INCLUDE_CERTIFIEDSENDER_CERTIFIEDSENDER_H_
#define ALEXA_CLIENT_SDK_CERTIFIEDSENDER_INCLUDE_CERTIFIEDSENDER_CERTIFIEDSENDER_H_

#include "CertifiedSender/MessageStorageInterface.h"

#include <AVSCommon/AVS/MessageRequest.h>
#include <AVSCommon/SDKInterfaces/AVSConnectionManagerInterface.h>
#include <AVSCommon/SDKInterfaces/ConnectionStatusObserverInterface.h>
#include <AVSCommon/SDKInterfaces/MessageSenderInterface.h>
#include <AVSCommon/Utils/Power/PowerResource.h>
#include <AVSCommon/Utils/Threading/ConditionVariableWrapper.h>
#include <AVSCommon/Utils/RequiresShutdown.h>
#include <AVSCommon/Utils/RetryTimer.h>
#include <AVSCommon/Utils/Threading/Executor.h>
#include <RegistrationManager/CustomerDataHandler.h>
#include <RegistrationManager/CustomerDataManagerInterface.h>

#include <deque>
#include <memory>

namespace alexaClientSDK {
namespace certifiedSender {

static const int CERTIFIED_SENDER_QUEUE_SIZE_WARN_LIMIT = 25;
static const int CERTIFIED_SENDER_QUEUE_SIZE_HARD_LIMIT = 50;

class CertifiedSender
        : public avsCommon::utils::RequiresShutdown
        , public avsCommon::sdkInterfaces::ConnectionStatusObserverInterface
        , public std::enable_shared_from_this<CertifiedSender>
        , public registrationManager::CustomerDataHandler {
public:
    static std::shared_ptr<CertifiedSender> create(
        std::shared_ptr<avsCommon::sdkInterfaces::MessageSenderInterface> messageSender,
        std::shared_ptr<avsCommon::sdkInterfaces::AVSConnectionManagerInterface> connection,
        std::shared_ptr<MessageStorageInterface> storage,
        std::shared_ptr<registrationManager::CustomerDataManagerInterface> dataManager);

    virtual ~CertifiedSender();

    std::future<bool> sendJSONMessage(const std::string& jsonMessage, const std::string& uriPathExtension = "");

    void clearData() override;

private:
    class CertifiedMessageRequest : public avsCommon::avs::MessageRequest {
    public:
        CertifiedMessageRequest(const std::string& jsonContent, int dbId, const std::string& uriPathExtension = "");

        void exceptionReceived(const std::string& exceptionMessage) override;

        void sendCompleted(
            avsCommon::sdkInterfaces::MessageRequestObserverInterface::Status sendMessageStatus) override;

        avsCommon::sdkInterfaces::MessageRequestObserverInterface::Status waitForCompletion();

        int getDbId();

        void shutdown();

    private:
        avsCommon::sdkInterfaces::MessageRequestObserverInterface::Status m_sendMessageStatus;
        bool m_responseReceived;
        std::mutex m_requestMutex;
        avsCommon::utils::threading::ConditionVariableWrapper m_requestCv;
        int m_dbId;
        bool m_isRequestShuttingDown;
    };

    CertifiedSender(
        std::shared_ptr<avsCommon::sdkInterfaces::MessageSenderInterface> messageSender,
        std::shared_ptr<avsCommon::sdkInterfaces::AVSConnectionManagerInterface> connection,
        std::shared_ptr<MessageStorageInterface> storage,
        std::shared_ptr<registrationManager::CustomerDataManagerInterface> dataManager,
        int queueSizeWarnLimit = CERTIFIED_SENDER_QUEUE_SIZE_WARN_LIMIT,
        int queueSizeHardLimit = CERTIFIED_SENDER_QUEUE_SIZE_HARD_LIMIT);

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

    bool init();

    bool executeSendJSONMessage(std::string jsonMessage, const std::string& uriPathExtension);

    void doShutdown() override;

    void mainloop();

    int m_queueSizeWarnLimit;
    int m_queueSizeHardLimit;

    std::thread m_workerThread;

    bool m_isShuttingDown;

    std::mutex m_mutex;

    avsCommon::utils::threading::ConditionVariableWrapper m_workerThreadCV;

    bool m_isConnected;

    avsCommon::utils::RetryTimer m_retryTimer;

    std::deque<std::shared_ptr<CertifiedMessageRequest>> m_messagesToSend;

    std::shared_ptr<avsCommon::sdkInterfaces::MessageSenderInterface> m_messageSender;

    std::shared_ptr<CertifiedMessageRequest> m_currentMessage;

    // The connection object we are observing.
    std::shared_ptr<avsCommon::sdkInterfaces::AVSConnectionManagerInterface> m_connection;

    std::shared_ptr<MessageStorageInterface> m_storage;

    std::shared_ptr<avsCommon::utils::power::PowerResource> m_powerResource;

    avsCommon::utils::threading::Executor m_executor;

    // A condition variable for the main loop to wait for during back-off.
    avsCommon::utils::threading::ConditionVariableWrapper m_backoffWaitCV;
};

}  // namespace certifiedSender
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_CERTIFIEDSENDER_INCLUDE_CERTIFIEDSENDER_CERTIFIEDSENDER_H_