NET_WebResponse.h File Reference

#include "NET_API.h"
#include "NET_HTTPDefines.h"
#include "NET_Time.h"
#include "NET_WebTypes.h"
#include <UT/UT_Array.h>
#include <UT/UT_ArrayStringMap.h>
#include <UT/UT_Assert.h>
#include <UT/UT_Debug.h>
#include <UT/UT_ErrorCode.h>
#include <UT/UT_Optional.h>
#include <UT/UT_SharedPtr.h>
#include <UT/UT_StringArray.h>
#include <UT/UT_StringHolder.h>
#include <SYS/SYS_Types.h>
#include <time.h>

Include dependency graph for NET_WebResponse.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	NET_BaseWebResponse
struct	std::is_error_code_enum< NET::CurlError >
class	NET_HTTPResponse
	Response object used by a client from a response by a server. More...
struct	NET_HTTPResponse::Error
class	NET_WebResponse
	Response object used for responding to request in the server. More...

Namespaces
	NET
	std

Typedefs
using	NET_WebResponseSPtr = UT_SharedPtr< NET_WebResponse >

Enumerations
enum	NET_HTTPStatusCode {   NET_HTTPNone = 0, NET_HTTPContinue = 100, NET_HTTPSwitchProtocol = 101, NET_HTTPOk = 200,   NET_HTTPCreated = 201, NET_HTTPAccepted = 202, NET_HTTPNonAuthoritativeInfo = 203, NET_HTTPNoContent = 204,   NET_HTTPResetContent = 205, NET_HTTPPartialContent = 206, NET_HTTPMultipleChoice = 300, NET_HTTPMovedPerm = 301,   NET_HTTPFound = 302, NET_HTTPSeeOther = 303, NET_HTTPNotModified = 304, NET_HTTPTempRedirect = 307,   NET_HTTPPermRedirect = 308, NET_HTTPBadRequest = 400, NET_HTTPUnauthorized = 401, NET_HTTPPaymentRequired = 402,   NET_HTTPForbidden = 403, NET_HTTPNotFound = 404, NET_HTTPMethodNotAllowed = 405, NET_HTTPNotAcceptable = 406,   NET_HTTPProxyAuthRequired = 407, NET_HTTPRequestTimeout = 408, NET_HTTPConflict = 409, NET_HTTPGone = 410,   NET_HTTPLengthRequired = 411, NET_HTTPPreconditionFailed = 412, NET_HTTPPayloadLarge = 413, NET_HTTPURITooLong = 414,   NET_HTTPUnsupportedMedia = 415, NET_HTTPRangeNotSatisfiable = 416, NET_HTTPExpectationFailed = 417, NET_HTTPUnprocessableEntity = 422,   NET_HTTPTooEarly = 425, NET_HTTPUpgradeRequired = 426, NET_HTTPPreconditionRequired = 428, NET_HTTPTooManyRequests = 429,   NET_HTTPHeadersFieldsTooLarge = 431, NET_HTTPLegalReasons = 451, NET_HTTPInternalServerError = 500, NET_HTTPNotImplemented = 501,   NET_HTTPBadGateway = 502, NET_HTTPServiceUnavailable = 503, NET_HTTPGatewayTimeout = 504, NET_HTTPVersionNotSupported = 505,   NET_HTTPNetworkAuthRequired = 511 }
enum	NET::CurlError {   NET::CurlError::INTERNAL_ERROR = -1, NET::CurlError::OK = 0, NET::CurlError::UNSUPPORTED_PROTOCOL, NET::CurlError::FAILED_INIT,   NET::CurlError::URL_MALFORMAT, NET::CurlError::NOT_BUILT_IN, NET::CurlError::COULDNT_RESOLVE_PROXY, NET::CurlError::COULDNT_RESOLVE_HOST,   NET::CurlError::COULDNT_CONNECT, NET::CurlError::WEIRD_SERVER_REPLY, NET::CurlError::REMOTE_ACCESS_DENIED, NET::CurlError::FTP_ACCEPT_FAILED,   NET::CurlError::FTP_WEIRD_PASS_REPLY, NET::CurlError::FTP_ACCEPT_TIMEOUT, NET::CurlError::FTP_WEIRD_PASV_REPLY, NET::CurlError::FTP_WEIRD_227_FORMAT,   NET::CurlError::FTP_CANT_GET_HOST, NET::CurlError::HTTP2_PROBLEM, NET::CurlError::FTP_COULDNT_SET_TYPE, NET::CurlError::PARTIAL_FILE,   NET::CurlError::FTP_COULDNT_RETR_FILE, NET::CurlError::QUOTE_ERROR, NET::CurlError::HTTP_RETURNED_ERROR, NET::CurlError::WRITE_ERROR,   NET::CurlError::UPLOAD_FAILED, NET::CurlError::READ_ERROR, NET::CurlError::OUT_OF_MEMORY, NET::CurlError::OPERATION_TIMEDOUT,   NET::CurlError::FTP_PORT_FAILED, NET::CurlError::FTP_COULDNT_USE_REST, NET::CurlError::RANGE_ERROR, NET::CurlError::HTTP_POST_ERROR,   NET::CurlError::SSL_CONNECT_ERROR, NET::CurlError::BAD_DOWNLOAD_RESUME, NET::CurlError::FILE_COULDNT_READ_FILE, NET::CurlError::LDAP_CANNOT_BIND,   NET::CurlError::LDAP_SEARCH_FAILED, NET::CurlError::FUNCTION_NOT_FOUND, NET::CurlError::ABORTED_BY_CALLBACK, NET::CurlError::BAD_FUNCTION_ARGUMENT,   NET::CurlError::INTERFACE_FAILED, NET::CurlError::TOO_MANY_REDIRECTS, NET::CurlError::UNKNOWN_OPTION, NET::CurlError::TELNET_OPTION_SYNTAX,   NET::CurlError::GOT_NOTHING, NET::CurlError::SSL_ENGINE_NOTFOUND, NET::CurlError::SSL_ENGINE_SETFAILED, NET::CurlError::SEND_ERROR,   NET::CurlError::RECV_ERROR, NET::CurlError::SSL_CERTPROBLEM, NET::CurlError::SSL_CIPHER, NET::CurlError::PEER_FAILED_VERIFICATION,   NET::CurlError::BAD_CONTENT_ENCODING, NET::CurlError::LDAP_INVALID_URL, NET::CurlError::FILESIZE_EXCEEDED, NET::CurlError::USE_SSL_FAILED,   NET::CurlError::SEND_FAIL_REWIND, NET::CurlError::SSL_ENGINE_INITFAILED, NET::CurlError::LOGIN_DENIED, NET::CurlError::TFTP_NOTFOUND,   NET::CurlError::REMOTE_DISK_FULL, NET::CurlError::TFTP_ILLEGAL, NET::CurlError::TFTP_UNKNOWNID, NET::CurlError::REMOTE_FILE_EXISTS,   NET::CurlError::TFTP_NOSUCHUSER, NET::CurlError::CONV_FAILED, NET::CurlError::CONV_REQD, NET::CurlError::SSL_CACERT_BADFILE,   NET::CurlError::REMOTE_FILE_NOT_FOUND, NET::CurlError::SSH_ERROR, NET::CurlError::SSL_SHUTDOWN_FAILED, NET::CurlError::AGAIN_ERROR,   NET::CurlError::SSL_CRL_BADFILE, NET::CurlError::SSL_ISSUER_ERROR, NET::CurlError::FTP_PRET_FAILED, NET::CurlError::RTSP_CSEQ_ERROR,   NET::CurlError::RTSP_SESSION_ERROR, NET::CurlError::FTP_BAD_FILE_LIST, NET::CurlError::CHUNK_FAILED, NET::CurlError::NO_CONNECTION_AVAILABLE,   NET::CurlError::SSL_PINNEDPUBKEYNOMATCH, NET::CurlError::SSL_INVALIDCERTSTATUS, NET::CurlError::HTTP2_STREAM, NET::CurlError::RECURSIVE_API_CALL,   NET::CurlError::AUTH_ERROR, NET::CurlError::HTTP3_ERROR, NET::CurlError::QUIC_CONNECT_ERROR, NET::CurlError::OBSOLETE }

Functions
NET_API const UT_ErrorCategory &	NET::GetCurlErrorCategory ()
UT_ErrorCode	NET::make_error_code (NET::CurlError e)
NET_API UT_StringHolder	NETextraDetails (const UT_ErrorCode &ec)

Typedef Documentation

using NET_WebResponseSPtr = UT_SharedPtr<NET_WebResponse>

Definition at line 566 of file NET_WebResponse.h.

Enumeration Type Documentation

enum NET_HTTPStatusCode

Enumerator
NET_HTTPNone
NET_HTTPContinue
NET_HTTPSwitchProtocol
NET_HTTPOk
NET_HTTPCreated
NET_HTTPAccepted
NET_HTTPNonAuthoritativeInfo
NET_HTTPNoContent
NET_HTTPResetContent
NET_HTTPPartialContent
NET_HTTPMultipleChoice
NET_HTTPMovedPerm
NET_HTTPFound
NET_HTTPSeeOther
NET_HTTPNotModified
NET_HTTPTempRedirect
NET_HTTPPermRedirect
NET_HTTPBadRequest
NET_HTTPUnauthorized
NET_HTTPPaymentRequired
NET_HTTPForbidden
NET_HTTPNotFound
NET_HTTPMethodNotAllowed
NET_HTTPNotAcceptable
NET_HTTPProxyAuthRequired
NET_HTTPRequestTimeout
NET_HTTPConflict
NET_HTTPGone
NET_HTTPLengthRequired
NET_HTTPPreconditionFailed
NET_HTTPPayloadLarge
NET_HTTPURITooLong
NET_HTTPUnsupportedMedia
NET_HTTPRangeNotSatisfiable
NET_HTTPExpectationFailed
NET_HTTPUnprocessableEntity
NET_HTTPTooEarly
NET_HTTPUpgradeRequired
NET_HTTPPreconditionRequired
NET_HTTPTooManyRequests
NET_HTTPHeadersFieldsTooLarge
NET_HTTPLegalReasons
NET_HTTPInternalServerError
NET_HTTPNotImplemented
NET_HTTPBadGateway
NET_HTTPServiceUnavailable
NET_HTTPGatewayTimeout
NET_HTTPVersionNotSupported
NET_HTTPNetworkAuthRequired

Definition at line 38 of file NET_WebResponse.h.

Function Documentation

NET_API UT_StringHolder NETextraDetails

(

const UT_ErrorCode &

ec

)

Contains extra information that might be useful. Note this only contains extra details for the NET::CurlError