SettingEventSender.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_SETTINGS_INCLUDE_SETTINGS_SETTINGEVENTSENDER_H_
#define ALEXA_CLIENT_SDK_SETTINGS_INCLUDE_SETTINGS_SETTINGEVENTSENDER_H_

#include <condition_variable>
#include <memory>
#include <mutex>
#include <string>
#include <vector>

#include <AVSCommon/Utils/JSON/JSONGenerator.h>
#include <AVSCommon/AVS/EventBuilder.h>
#include <AVSCommon/SDKInterfaces/MessageSenderInterface.h>
#include <AVSCommon/SDKInterfaces/MessageRequestObserverInterface.h>
#include <AVSCommon/Utils/RetryTimer.h>
#include <AVSCommon/Utils/WaitEvent.h>
#include <Settings/SettingEventMetadata.h>
#include <Settings/SettingEventSenderInterface.h>

namespace alexaClientSDK {
namespace settings {

class SettingEventSender : public SettingEventSenderInterface {
public:
    static std::unique_ptr<SettingEventSender> create(
        const SettingEventMetadata& metadata,
        std::shared_ptr<avsCommon::sdkInterfaces::MessageSenderInterface> messageSender,
        const std::vector<int>& retryTable = getDefaultRetryTable());

    ~SettingEventSender();

    std::shared_future<bool> sendChangedEvent(const std::string& value) override;
    std::shared_future<bool> sendReportEvent(const std::string& value) override;
    std::shared_future<bool> sendStateReportEvent(const std::string& payload) override;
    void cancel() override;

private:
    /*
     * Constructor.
     *
     * @param messageSender The delivery service for the AVS events.
     * @param retryTable A list of back-off times in milliseconds used in resending events.
     */
    SettingEventSender(
        const SettingEventMetadata& metadata,
        std::shared_ptr<avsCommon::sdkInterfaces::MessageSenderInterface> messageSender,
        const std::vector<int>& retryTable);

    /*
     * Helper function to send the changed and report events.
     *
     * @param eventJson The event json to be sent.
     * @return A future expressing if the event has been sent to AVS.
     */
    std::shared_future<bool> sendEvent(const std::string& eventJson);

    std::string buildEventJson(const std::string& eventName, const std::string& value) const;

    static const std::vector<int>& getDefaultRetryTable();

    const SettingEventMetadata m_metadata;

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

    std::mutex m_sendMutex;

    avsCommon::utils::WaitEvent m_waitCancelEvent;

    avsCommon::utils::RetryTimer m_retryTimer;

    const std::size_t m_maxRetries;
};

}  // namespace settings
}  // namespace alexaClientSDK
#endif  // ALEXA_CLIENT_SDK_SETTINGS_INCLUDE_SETTINGS_SETTINGEVENTSENDER_H_