MessageRequest.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_AVS_INCLUDE_AVSCOMMON_AVS_MESSAGEREQUEST_H_
#define ALEXA_CLIENT_SDK_AVSCOMMON_AVS_INCLUDE_AVSCOMMON_AVS_MESSAGEREQUEST_H_

#include <cstdlib>
#include <functional>
#include <memory>
#include <mutex>
#include <string>
#include <unordered_set>
#include <vector>

#include "AVSCommon/AVS/Attachment/AttachmentReader.h"
#include <AVSCommon/SDKInterfaces/MessageRequestObserverInterface.h>

namespace alexaClientSDK {
namespace avsCommon {
namespace avs {

class EditableMessageRequest;

class MessageRequest {
public:
    struct NamedReader {
        NamedReader(const std::string& name, std::shared_ptr<avsCommon::avs::attachment::AttachmentReader> reader) :
                name{name},
                reader{reader} {
        }

        std::string name;

        std::shared_ptr<avsCommon::avs::attachment::AttachmentReader> reader;
    };

    struct EventHeaders {
        EventHeaders(const std::string& eventNamespace, const std::string& eventName) :
                eventNamespace{eventNamespace},
                eventName{eventName} {
        }

        EventHeaders() = default;

        std::string eventNamespace;

        std::string eventName;
    };

    using MessageRequestResolveFunction =
        std::function<bool(const std::shared_ptr<EditableMessageRequest>& req, const std::string& resolveKey)>;

    MessageRequest(
        const std::string& jsonContent,
        const std::string& uriPathExtension = "",
        const unsigned int threshold = 0,
        const std::string& streamMetricName = "");

    MessageRequest(const std::string& jsonContent, const unsigned int threshold, const std::string& streamMetricName);

    MessageRequest(
        const std::string& jsonContent,
        bool isSerialized,
        const std::string& uriPathExtension = "",
        std::vector<std::pair<std::string, std::string>> headers = {},
        MessageRequestResolveFunction resolver = nullptr,
        const unsigned int threshold = 0,
        const std::string& streamMetricName = "");

    MessageRequest(const MessageRequest& messageRequest);

    virtual ~MessageRequest();

    void addAttachmentReader(const std::string& name, std::shared_ptr<attachment::AttachmentReader> attachmentReader);

    std::string getJsonContent() const;

    bool getIsSerialized() const;

    std::string getUriPathExtension() const;

    int attachmentReadersCount() const;

    std::shared_ptr<NamedReader> getAttachmentReader(size_t index) const;

    virtual void responseStatusReceived(avsCommon::sdkInterfaces::MessageRequestObserverInterface::Status status);

    virtual void sendCompleted(avsCommon::sdkInterfaces::MessageRequestObserverInterface::Status status);

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

    void addObserver(std::shared_ptr<avsCommon::sdkInterfaces::MessageRequestObserverInterface> observer);

    void removeObserver(std::shared_ptr<avsCommon::sdkInterfaces::MessageRequestObserverInterface> observer);

    EventHeaders retrieveEventHeaders() const;

    const std::vector<std::pair<std::string, std::string>>& getHeaders() const;

    bool isResolved() const;

    std::shared_ptr<MessageRequest> resolveRequest(const std::string& resolveKey) const;

    unsigned int getStreamBytesThreshold() const;

    std::string getStreamMetricName() const;

protected:
    std::mutex m_observerMutex;

    std::unordered_set<std::shared_ptr<avsCommon::sdkInterfaces::MessageRequestObserverInterface>> m_observers;

    std::string m_jsonContent;

    bool m_isSerialized;

    std::string m_uriPathExtension;

    std::vector<std::shared_ptr<NamedReader>> m_readers;

    std::vector<std::pair<std::string, std::string>> m_headers;

    MessageRequestResolveFunction m_resolver;

    std::string m_streamMetricName;

    unsigned int m_streamBytesThreshold;
};

}  // namespace avs
}  // namespace avsCommon
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_AVS_INCLUDE_AVSCOMMON_AVS_MESSAGEREQUEST_H_