HttpRequest.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------+
|
|   Supplied under applicable software license agreement.
|
|   Copyright (c) 2018 Bentley Systems, Incorporated. All rights reserved.
|
+---------------------------------------------------------------------------------------*/
#pragma once

#include <Bentley/WString.h>
#include <functional>

#include <BeHttp/Http.h>
#include <Bentley/Tasks/AsyncTask.h>
#include <Bentley/Tasks/CancellationToken.h>
#include <BeHttp/HttpResponse.h>
#include <BeHttp/IHttpHandler.h>
#include <folly/futures/Future.h>

BEGIN_BENTLEY_HTTP_NAMESPACE


//=======================================================================================
// @bsiclass                                                     Bentley Systems
//=======================================================================================
struct Request
    {
    enum class RetryOption
        {
        DontRetry,
        ResetTransfer,
        ResumeTransfer 
        };

    typedef std::function<void (double bytesTransfered, double bytesTotal)> ProgressCallback;
    typedef const ProgressCallback& ProgressCallbackCR;

private:
    Utf8String m_url;
    Utf8String m_method;
    Utf8String m_proxyUrl;
    bool m_validateCertificate = false;
    HttpRequestHeaders m_requestHeaders;
    HttpBodyPtr m_requestBody;
    HttpBodyPtr m_responseBody;
    Tasks::ICancellationTokenPtr m_cancellationToken;
    ProgressCallback m_uploadProgressCallback;
    ProgressCallback m_downloadProgressCallback;
    unsigned m_connectionTimeoutSeconds = 60;
    unsigned m_transferTimeoutSeconds = 60;
    RetryOption m_retryOption = RetryOption::DontRetry;
    unsigned m_retriesMax = 0;
    bool m_followRedirects = true;
    bool m_useNewConnection = false;
    IHttpHandlerPtr m_httpHandler;

public:
    BEHTTP_EXPORT Utf8String EscapeUnsafeSymbolsInUrl(Utf8StringCR url);

    BEHTTP_EXPORT Request(Utf8StringCR url, Utf8StringCR method = "GET");

    HttpRequestHeadersR  GetHeaders(){return m_requestHeaders;}
    HttpRequestHeadersCR GetHeaders() const {return m_requestHeaders;}

    Utf8StringCR GetUrl() const {return m_url;}
    Utf8StringCR GetMethod() const {return m_method;}

    void SetValidateCertificate(bool validate) {m_validateCertificate = validate;}
    bool GetValidateCertificate() const {return m_validateCertificate;}

    // Set proxy for request. Pass empty string to not use proxy
    void SetProxy(Utf8StringCR proxyUrl) {m_proxyUrl = EscapeUnsafeSymbolsInUrl(proxyUrl);}
    Utf8StringCR GetProxy() const {return m_proxyUrl;}

    // Request body to send, default is no body
    void SetRequestBody(HttpBodyPtr body) {m_requestBody = body;}
    HttpBodyPtr GetRequestBody() const {return m_requestBody;}

    // Response body to write received data to
    void SetResponseBody(HttpBodyPtr body) {m_responseBody = body;}
    HttpBodyPtr GetResponseBody() const {return m_responseBody;}

    void SetTimeoutSeconds(unsigned connectionAndTransferTimeout) {m_connectionTimeoutSeconds = connectionAndTransferTimeout; m_transferTimeoutSeconds = connectionAndTransferTimeout;}

    void SetConnectionTimeoutSeconds(unsigned connectionTimeout){m_connectionTimeoutSeconds = connectionTimeout;}
    unsigned GetConnectionTimeoutSeconds() const {return m_connectionTimeoutSeconds;}

    void SetTransferTimeoutSeconds(unsigned transferTimeout) {m_transferTimeoutSeconds = transferTimeout;}
    unsigned GetTransferTimeoutSeconds() const {return m_transferTimeoutSeconds;}

    void SetFollowRedirects(bool follow){m_followRedirects = follow;}
    bool GetFollowRedirects() const {return m_followRedirects;}

    // Used to workaround a CURL bug:
    // https://sourceforge.net/p/curl/bugs/1275/
    void SetUseNewConnection(bool useNewConnection) {m_useNewConnection = useNewConnection;}
    bool GetUseNewConnection() const {return m_useNewConnection;}

    // Use this if you want to specify settings for poor conectivity. Useful for downloads.
    // Retries if connection lost happen for maximumRetries or indefinetely if maximumRetries = 0
    // Default - RetryOption::DontRetry
    void SetRetryOptions(RetryOption option, unsigned maximumRetries = 1) {m_retryOption = option;m_retriesMax = maximumRetries;}
    RetryOption const& GetRetryOption() const {return m_retryOption;}

    unsigned GetMaxRetries() const {return m_retriesMax;}

    void SetCancellationToken(Tasks::ICancellationTokenPtr token) {m_cancellationToken = token;}
    Tasks::ICancellationTokenPtr GetCancellationToken() const {return m_cancellationToken;}

    void SetDownloadProgressCallback(ProgressCallbackCR onProgress) {m_downloadProgressCallback = onProgress;}
    ProgressCallbackCR GetDownloadProgressCallback() const {return m_downloadProgressCallback;}

    void SetUploadProgressCallback(ProgressCallbackCR onProgress) {m_uploadProgressCallback = onProgress;}
    ProgressCallbackCR GetUploadProgressCallback() const {return m_uploadProgressCallback;}

    // Execute request asynchronously
    BEHTTP_EXPORT folly::Future<Response> Perform();

    // DEPRECATED: Use Perform.
    Tasks::AsyncTaskPtr<Response> PerformAsync() {return m_httpHandler->_PerformRequest(*this);}
    };

END_BENTLEY_HTTP_NAMESPACE