HTTP2RequestConfig.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_UTILS_INCLUDE_AVSCOMMON_UTILS_HTTP2_HTTP2REQUESTCONFIG_H_
#define ALEXA_CLIENT_SDK_AVSCOMMON_UTILS_INCLUDE_AVSCOMMON_UTILS_HTTP2_HTTP2REQUESTCONFIG_H_

#include <atomic>
#include <chrono>
#include <cstdint>
#include <memory>
#include <string>

#include "HTTP2RequestType.h"
#include "HTTP2RequestSourceInterface.h"
#include "HTTP2ResponseSinkInterface.h"
#include "HTTP2RequestType.h"

#ifdef ACSDK_EMIT_SENSITIVE_LOGS
#define ACSDK_EMIT_CURL_LOGS
#endif

namespace alexaClientSDK {
namespace avsCommon {
namespace utils {
namespace http2 {

class HTTP2RequestConfig {
public:
    HTTP2RequestConfig(HTTP2RequestType type, const std::string& url, const std::string& idPrefix);

    void setConnectionTimeout(std::chrono::milliseconds timeout);

    void setTransferTimeout(std::chrono::milliseconds timeout);

    void setActivityTimeout(std::chrono::milliseconds timeout);

    void setPriority(uint8_t priority);

    void setRequestSource(std::shared_ptr<HTTP2RequestSourceInterface> source);

    void setResponseSink(std::shared_ptr<HTTP2ResponseSinkInterface> sink);

    void setIntermittentTransferExpected();

    void setLogicalStreamIdPrefix(std::string logicalStreamIdPrefix);

    HTTP2RequestType getRequestType() const;

    std::string getUrl() const;

    std::chrono::milliseconds getConnectionTimeout() const;

    std::chrono::milliseconds getTransferTimeout() const;

    std::chrono::milliseconds getActivityTimeout() const;

    uint8_t getPriority() const;

    std::shared_ptr<HTTP2RequestSourceInterface> getSource() const;

    std::shared_ptr<HTTP2ResponseSinkInterface> getSink() const;

    bool isIntermittentTransferExpected() const;

    std::string getId() const;

private:
    const HTTP2RequestType m_type;

    const std::string m_url;

    static const uint8_t DEFAULT_PRIORITY = 16;

    std::chrono::milliseconds m_connectionTimeout;

    std::chrono::milliseconds m_transferTimeout;

    std::chrono::milliseconds m_activityTimeout;

    uint8_t m_priority;

    std::shared_ptr<HTTP2RequestSourceInterface> m_source;

    std::shared_ptr<HTTP2ResponseSinkInterface> m_sink;

    bool m_isIntermittentTransferExpected;


    std::string m_id;
};

inline HTTP2RequestConfig::HTTP2RequestConfig(
    HTTP2RequestType type,
    const std::string& url,
    const std::string& idPrefix) :
        m_type(type),
        m_url(url),
        m_connectionTimeout{std::chrono::milliseconds::zero()},
        m_transferTimeout{std::chrono::milliseconds::zero()},
        m_activityTimeout{std::chrono::milliseconds::zero()},
        m_priority{DEFAULT_PRIORITY},
        m_isIntermittentTransferExpected{false} {
    static std::atomic<uint64_t> nextId{1};
    m_id = idPrefix + std::to_string(std::atomic_fetch_add(&nextId, uint64_t{2}));
};

inline void HTTP2RequestConfig::setConnectionTimeout(std::chrono::milliseconds timeout) {
    m_connectionTimeout = timeout;
}

inline void HTTP2RequestConfig::setTransferTimeout(std::chrono::milliseconds timeout) {
    m_transferTimeout = timeout;
}

inline void HTTP2RequestConfig::setActivityTimeout(std::chrono::milliseconds timeout) {
    m_activityTimeout = timeout;
}

inline void HTTP2RequestConfig::setPriority(uint8_t priority) {
    m_priority = priority;
}

inline void HTTP2RequestConfig::setRequestSource(std::shared_ptr<HTTP2RequestSourceInterface> source) {
    m_source = std::move(source);
}

inline void HTTP2RequestConfig::setResponseSink(std::shared_ptr<HTTP2ResponseSinkInterface> sink) {
    m_sink = std::move(sink);
}

inline void HTTP2RequestConfig::setIntermittentTransferExpected() {
    m_isIntermittentTransferExpected = true;
}

inline std::string HTTP2RequestConfig::getId() const {
    return m_id;
}

inline HTTP2RequestType HTTP2RequestConfig::getRequestType() const {
    return m_type;
}

inline std::string HTTP2RequestConfig::getUrl() const {
    return m_url;
};

inline std::chrono::milliseconds HTTP2RequestConfig::getConnectionTimeout() const {
    return m_connectionTimeout;
}

inline std::chrono::milliseconds HTTP2RequestConfig::getTransferTimeout() const {
    return m_transferTimeout;
}

inline std::chrono::milliseconds HTTP2RequestConfig::getActivityTimeout() const {
    return m_activityTimeout;
}

inline uint8_t HTTP2RequestConfig::getPriority() const {
    return m_priority;
}

inline std::shared_ptr<HTTP2RequestSourceInterface> HTTP2RequestConfig::getSource() const {
    return m_source;
}

inline std::shared_ptr<HTTP2ResponseSinkInterface> HTTP2RequestConfig::getSink() const {
    return m_sink;
}

inline bool HTTP2RequestConfig::isIntermittentTransferExpected() const {
    return m_isIntermittentTransferExpected;
}

}  // namespace http2
}  // namespace utils
}  // namespace avsCommon
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_UTILS_INCLUDE_AVSCOMMON_UTILS_HTTP2_HTTP2REQUESTCONFIG_H_