DiscoveryEventSender.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_CAPABILITIESDELEGATE_INCLUDE_CAPABILITIESDELEGATE_DISCOVERYEVENTSENDER_H_
#define ALEXA_CLIENT_SDK_CAPABILITIESDELEGATE_INCLUDE_CAPABILITIESDELEGATE_DISCOVERYEVENTSENDER_H_

#include <memory>
#include <mutex>
#include <string>
#include <unordered_map>

#include <AVSCommon/AVS/WaitableMessageRequest.h>
#include <AVSCommon/SDKInterfaces/AlexaEventProcessedObserverInterface.h>
#include <AVSCommon/SDKInterfaces/AuthDelegateInterface.h>
#include <AVSCommon/SDKInterfaces/AuthObserverInterface.h>
#include <AVSCommon/SDKInterfaces/MessageSenderInterface.h>
#include <AVSCommon/Utils/Metrics/MetricRecorderInterface.h>
#include <AVSCommon/Utils/Threading/ConditionVariableWrapper.h>
#include <AVSCommon/Utils/WaitEvent.h>

#include "DiscoveryEventSenderInterface.h"
#include "DiscoveryStatusObserverInterface.h"

namespace alexaClientSDK {
namespace capabilitiesDelegate {

class DiscoveryEventSender
        : public DiscoveryEventSenderInterface
        , public std::enable_shared_from_this<DiscoveryEventSender> {
public:
    static std::shared_ptr<DiscoveryEventSender> create(
        const std::unordered_map<std::string, std::string>& addOrUpdateReportEndpoints,
        const std::unordered_map<std::string, std::string>& deleteReportEndpoints,
        const std::shared_ptr<avsCommon::sdkInterfaces::AuthDelegateInterface>& authDelegate,
        bool waitForEventProcessed = true,
        const std::shared_ptr<avsCommon::utils::metrics::MetricRecorderInterface>& metricRecorder = nullptr,
        bool postConnect = false);

    ~DiscoveryEventSender();

    bool sendDiscoveryEvents(
        const std::shared_ptr<avsCommon::sdkInterfaces::MessageSenderInterface>& messageSender) override;
    void stop() override;
    void addDiscoveryStatusObserver(const std::shared_ptr<DiscoveryStatusObserverInterface>& observer) override;
    void removeDiscoveryStatusObserver(const std::shared_ptr<DiscoveryStatusObserverInterface>& observer) override;

    void onAlexaEventProcessedReceived(const std::string& eventCorrelationToken) override;

    void onAuthStateChange(AuthObserverInterface::State newState, AuthObserverInterface::Error newError) override;
private:
    DiscoveryEventSender(
        const std::unordered_map<std::string, std::string>& addOrUpdateReportEndpoints,
        const std::unordered_map<std::string, std::string>& deleteReportEndpoints,
        const std::shared_ptr<avsCommon::sdkInterfaces::AuthDelegateInterface>& authDelegate,
        bool waitForEventProcessed,
        const std::shared_ptr<avsCommon::utils::metrics::MetricRecorderInterface>& metricRecorder,
        bool postConnect);

    bool sendDiscoveryEventWithRetries(
        const std::shared_ptr<avsCommon::sdkInterfaces::MessageSenderInterface>& messageSender,
        const std::vector<std::string>& endpointConfigurations,
        bool isAddOrUpdateReportEvent = true);

    avsCommon::sdkInterfaces::MessageRequestObserverInterface::Status sendDiscoveryEvent(
        const std::shared_ptr<avsCommon::sdkInterfaces::MessageSenderInterface>& messageSender,
        const std::string& eventString,
        bool waitForEventProcessed = true);

    bool sendAddOrUpdateReportEvents(
        const std::shared_ptr<avsCommon::sdkInterfaces::MessageSenderInterface>& messageSender);

    bool sendDeleteReportEvents(const std::shared_ptr<avsCommon::sdkInterfaces::MessageSenderInterface>& messageSender);

    bool sendDiscoveryEvents(
        const std::vector<std::string>& endpointConfigurations,
        const std::shared_ptr<avsCommon::sdkInterfaces::MessageSenderInterface>& messageSender,
        bool isAddOrUpdateReportEvent = true);

    void reportDiscoveryStatus(avsCommon::sdkInterfaces::MessageRequestObserverInterface::Status status);

    std::string getAuthToken();

    bool isStopping();

    std::unordered_map<std::string, std::string> m_addOrUpdateReportEndpoints;

    std::unordered_map<std::string, std::string> m_deleteReportEndpoints;

    std::shared_ptr<avsCommon::sdkInterfaces::AuthDelegateInterface> m_authDelegate;

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

    AuthObserverInterface::State m_currentAuthState;

    std::mutex m_authStatusMutex;

    avsCommon::utils::threading::ConditionVariableWrapper m_authStatusReady;

    std::string m_currentEventCorrelationToken;

    bool m_isStopping;

    avsCommon::utils::WaitEvent m_eventProcessedWaitEvent;

    avsCommon::utils::WaitEvent m_retryWait;

    std::mutex m_mutex;

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

    std::mutex m_observerMutex;

    std::shared_ptr<DiscoveryStatusObserverInterface> m_observer;

    std::mutex m_isSendDiscoveryEventsInvokedMutex;

    bool m_isSendDiscoveryEventsInvoked;

    const bool m_waitForEventProcessed;

    const bool m_postConnect;
};

}  // namespace capabilitiesDelegate
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_CAPABILITIESDELEGATE_INCLUDE_CAPABILITIESDELEGATE_DISCOVERYEVENTSENDER_H_