NET_WebTypes.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        NET_WebTypes.h
 *
 * COMMENTS:
 *
 */

#ifndef __NET_WEBTYPES_H__
#define __NET_WEBTYPES_H__

#include "NET_API.h"

#include <UT/UT_ErrorCode.h>
#include <UT/UT_Map.h>
#include <UT/UT_StringHolder.h>

#include <utility>

/// We need a compare function that ignores case as it does not matter in the
/// world of http headers
struct NET_API NET_WebStringCompare
{
    bool operator()(const UT_StringHolder &lhs,
                    const UT_StringHolder &rhs) const
    {
        return lhs.equal(rhs, true /*ignore case*/);
    }
};

/// We need a custom hasher that doesnt take case into account.
struct NET_API NET_WebStringHash
{
    size_t operator()(const UT_StringHolder &str) const
    {
        return str.toLower().hash();
    }
};

/// Use this when storing a map for web uses
using NET_WebMap = UT_Map<UT_StringHolder,
                         UT_StringHolder,
                         NET_WebStringHash,
                         NET_WebStringCompare>;


using NET_RequestRange = std::pair<int64, int64>;
using NET_RequestRangeList = UT_Array<NET_RequestRange>;

enum class NET_HTTPMethod
{
    kGET,
    kHEAD,
    kPOST,
    kPUT,
    kDELETE,
    kCONNECT,
    kOPTIONS,
    kTRACE,
    kPATCH
};

enum NET_KnownHeaders
{
    ContentTypeHeader,
    ContentLengthHeader,
    LocationHeader,
    CookieHeader,
    SetCookieHeader,
    UserAgentHeader,
    ServerHeader,
    AcceptHeader
};

NET_API UT_StringHolder NETknownHeadersToString(NET_KnownHeaders header);

namespace NET
{
enum class HTTPError
{
    INTERNAL_ERROR = -1,
    OK = 0,
    MAX_RETRIES
};

NET_API const UT_ErrorCategory& GetHTTPErrorCategory();

inline UT_ErrorCode
make_error_code(NET::HTTPError e)
{
    return UT_ErrorCode{static_cast<int>(e), GetHTTPErrorCategory()};
}
}; // namespace NET

namespace std
{
template <>
struct is_error_code_enum<NET::HTTPError> : true_type
{
};
} // namespace std

#endif // __NET_WEBTYPES_H__