HttpHandler.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 <DgnPlatform/DgnCore.h>

BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE

struct HttpHandler;

//=======================================================================================
// @bsiclass                                                     Bentley Systems
//=======================================================================================
enum class HttpRequestStatus
    {
    UnknownError,
    NoConnection,
    CouldNotResolveHost,
    CouldNotResolveProxy,
    Aborted,
    Success,
    };

//=======================================================================================
// @bsiclass                                                     Bentley Systems
//=======================================================================================
enum class HttpResponseStatus : long
    {
    Unknown = -1,

    // Successful
    Success = 200,
    Created = 201,
    Accepted = 202,
    NonAuthoritativeInformation = 203,
    NoContent = 204,
    ResetContent = 205,
    PartialContent = 206,

    // Redirection
    MultipleChoices = 300,
    MovedPermanently = 301,
    Found = 302,
    SeeOther = 303,
    NotModified = 304,
    UseProxy = 305,
    TemporaryRedirect = 307,

    // Client error
    BadRequest = 400,
    Unauthorized = 401,
    PaymentRequired = 402,
    Forbidden = 403,
    NotFound = 404,
    MethodNotAllowed = 405,
    NotAcceptable = 406,
    ProxyAuthenticationRequired = 407,
    RequestTimeout = 408,
    Conflict = 409,
    Gone = 410,
    LengthRequired = 411,
    PreconditionFailed = 412,
    RequestEntityTooLarge = 413,
    RequestUriTooLong = 414,
    UnsupportedMediaType = 415,
    RequestedRangeNotSatisfyable = 416,
    ExpectationFailed = 417,

    // Server error
    InternalServerError = 500,
    NotImplemented = 501,
    BadGateway = 502,
    ServiceUnavailable = 503,
    GatewayTimeout = 504,
    HttpVersionNotSupported = 505,
    };

//=======================================================================================
// @bsiclass                                                     Bentley Systems
//=======================================================================================
struct HttpRequest
{
private:
    Utf8String m_url;
    Utf8String m_authentication;
    bmap<Utf8String, Utf8String> m_header;
public:
    HttpRequest(Utf8CP url, bmap<Utf8String, Utf8String> const& header) : m_url(url), m_header(header), m_authentication ("") {}
    Utf8String GetUrl() const {return m_url.c_str();}
    Utf8String GetAuthentication() const {return m_authentication.c_str();}
    void SetUrl(Utf8StringCR url) {m_url = url;}
    void SetAuthentication (Utf8StringCR authentication) {m_authentication = authentication;}
    bmap<Utf8String, Utf8String> const& GetHeader() const {return m_header;}
    void SetHeader(bmap<Utf8String, Utf8String> const& header) {m_header = header;}
};

//=======================================================================================
//  @remark Required library : DgnPlatform<ApiNumber>.lib  i.e. DgnPlatform5.lib
// @bsiclass                                                     Bentley Systems
//=======================================================================================
struct HttpResponse : RefCountedBase
{
private:
    virtual void MakeClassAbstract() = 0;
public:
public:
    DGNPLATFORM_EXPORT HttpResponseStatus GetStatus() const;
    DGNPLATFORM_EXPORT bmap<Utf8String, Utf8String> const& GetHeader() const;
    DGNPLATFORM_EXPORT bvector<Byte> const& GetBody() const;
};
typedef RefCountedPtr<HttpResponse> HttpResponsePtr;

//=======================================================================================
//  @remark Required library : DgnPlatform<ApiNumber>.lib  i.e. DgnPlatform5.lib
// @bsiclass                                                     Bentley Systems
//=======================================================================================
struct IHttpRequestCancellationToken
{
friend struct HttpHandler;
protected:
    virtual ~IHttpRequestCancellationToken() {}
    virtual bool _ShouldCancelHttpRequest() const = 0;
    virtual void _UpdateProgressInfo (int64_t dltotal, int64_t dlnow, int64_t ultotal, int64_t ulnow) {};
};

//=======================================================================================
//  @remark Required library : DgnPlatform<ApiNumber>.lib  i.e. DgnPlatform5.lib
// @bsiclass                                                     Bentley Systems
//=======================================================================================
struct HttpHandler : NonCopyableClass
{
private:
    virtual void MakeClassAbstract() = 0;
public:
public:
    DGNPLATFORM_EXPORT static HttpHandler& Instance();
    DGNPLATFORM_EXPORT HttpRequestStatus Request(HttpResponsePtr& response, HttpRequest const& request, IHttpRequestCancellationToken const* cancellationToken = nullptr);
};

END_BENTLEY_DGNPLATFORM_NAMESPACE