RemoteViz::Rendering::HTTPResponse Class Reference

More...

#include <RemoteViz/Rendering/HTTPResponse.h>

Public Types
enum	HTTPStatus {   UNKNOWN = 0 ,   CONTINUE = 100 ,   SWITCHING_PROTOCOLS = 101 ,   PROCESSING = 102 ,   EARLY_HINTS = 103 ,   OK = 200 ,   CREATED = 201 ,   ACCEPTED = 202 ,   NON_AUTHORITATIVE_INFORMATION = 203 ,   NO_CONTENT = 204 ,   RESET_CONTENT = 205 ,   PARTIAL_CONTENT = 206 ,   MULTI_STATUS = 207 ,   ALREADY_REPORTED = 208 ,   IM_USED = 226 ,   MULTIPLE_CHOICES = 300 ,   MOVED_PERMANENTLY = 301 ,   FOUND = 302 ,   SEE_OTHER = 303 ,   NOT_MODIFIED = 304 ,   USE_PROXY = 305 ,   TEMPORARY_REDIRECT = 307 ,   PERMANENT_REDIRECT = 308 ,   BAD_REQUEST = 400 ,   UNAUTHORIZED = 401 ,   PAYMENT_REQUIRED = 402 ,   FORBIDDEN = 403 ,   NOT_FOUND = 404 ,   METHOD_NOT_ALLOWED = 405 ,   NOT_ACCEPTABLE = 406 ,   PROXY_AUTHENTICATION_REQUIRED = 407 ,   REQUEST_TIMEOUT = 408 ,   CONFLICT = 409 ,   GONE = 410 ,   LENGTH_REQUIRED = 411 ,   PRECONDITION_FAILED = 412 ,   PAYLOAD_TOO_LARGE = 413 ,   URI_TOO_LONG = 414 ,   UNSUPPORTED_MEDIA_TYPE = 415 ,   RANGE_NOT_SATISFIABLE = 416 ,   EXPECTATION_FAILED = 417 ,   MISDIRECTED_REQUEST = 421 ,   UNPROCESSABLE_ENTITY = 422 ,   LOCKED = 423 ,   FAILED_DEPENDENCY = 424 ,   UPGRADE_REQUIRED = 426 ,   PRECONDITION_REQUIRED = 428 ,   TOO_MANY_REQUESTS = 429 ,   REQUEST_HEADER_FIELDS_TOO_LARGE = 431 ,   CONNECTION_CLOSED_WITHOUT_RESPONSE = 444 ,   UNAVAILABLE_FOR_LEGAL_REASONS = 451 ,   CLIENT_CLOSED_REQUEST = 499 ,   INTERNAL_SERVER_ERROR = 500 ,   NOT_IMPLEMENTED = 501 ,   BAD_GATEWAY = 502 ,   SERVICE_UNAVAILABLE = 503 ,   GATEWAY_TIMEOUT = 504 ,   HTTP_VERSION_NOT_SUPPORTED = 505 ,   VARIANT_ALSO_NEGOTIATES = 506 ,   INSUFFICIENT_STORAGE = 507 ,   LOOP_DETECTED = 508 ,   NOT_EXTENDED = 510 ,   NETWORK_AUTHENTICATION_REQUIRED = 511 ,   NETWORK_CONNECT_TIMEOUT_ERROR = 599 }
	Enum for the HTTP status codes. More...

Public Member Functions
	HTTPResponse ()
	Creates a HTTP/1.1 response with "200 OK" status.
	HTTPResponse (HTTPStatus statusCode)
	Creates a HTTP/1.1 response with the given status and a standard reason phrase.
	HTTPResponse (HTTPStatus statusCode, const std::string &reason)
	Creates a HTTP/1.1 response with the given status and reason phrase.
	HTTPResponse (HTTPStatus statusCode, const std::string &reason, const std::string &body)
	Creates a HTTP/1.1 response with the given status, reason phrase and message body data.
	HTTPResponse (HTTPStatus statusCode, const std::string &reason, const std::string &body, int versionMajor, int versionMinor, const HTTPHeaders &headers)
	Creates a HTTP response with the given status, reason phrase, message body data, version and headers.
	HTTPResponse (const HTTPResponse &obj)
	Copy constructor.
HTTPResponse &	operator= (const HTTPResponse &obj)
	Copy assignment operator.
	~HTTPResponse ()
	Destructor.
HTTPStatus	getStatusCode () const
	Returns the HTTP status.
const std::string &	getReason () const
	Returns the HTTP reason phrase.
const std::string &	getBody () const
	Returns the HTTP message body data (optional).
int64_t	getContentLength () const
	Returns the size of the body, in bytes (Content-Length entity header)
const HTTPHeaders &	getHeaders () const
	Returns HTTP headers.
const std::string &	getVersion () const
	Returns the HTTP version for incoming request (example "HTTP/1.1").
int	getVersionMajor () const
	HTTP uses a "major.minor" numbering scheme to indicate versions of the protocol.
int	getVersionMinor () const
	HTTP uses a "major.minor" numbering scheme to indicate versions of the protocol.

Static Public Member Functions
static std::string	getReasonPhrase (HTTPStatus status)
	Returns the standard HTTP reason phrase for a HTTP status code.

Detailed Description

This class encapsulates an HTTP response message.

Used in the ServiceListener onHTTPRequest() method.

Definition at line 49 of file HTTPResponse.h.

Member Enumeration Documentation

HTTPStatus

enum RemoteViz::Rendering::HTTPResponse::HTTPStatus

Enum for the HTTP status codes.

Enumerator
UNKNOWN
CONTINUE
SWITCHING_PROTOCOLS
PROCESSING
EARLY_HINTS
OK
CREATED
ACCEPTED
NON_AUTHORITATIVE_INFORMATION
NO_CONTENT
RESET_CONTENT
PARTIAL_CONTENT
MULTI_STATUS
ALREADY_REPORTED
IM_USED
MULTIPLE_CHOICES
MOVED_PERMANENTLY
FOUND
SEE_OTHER
NOT_MODIFIED
USE_PROXY
TEMPORARY_REDIRECT
PERMANENT_REDIRECT
BAD_REQUEST
UNAUTHORIZED
PAYMENT_REQUIRED
FORBIDDEN
NOT_FOUND
METHOD_NOT_ALLOWED
NOT_ACCEPTABLE
PROXY_AUTHENTICATION_REQUIRED
REQUEST_TIMEOUT
CONFLICT
GONE
LENGTH_REQUIRED
PRECONDITION_FAILED
PAYLOAD_TOO_LARGE
URI_TOO_LONG
UNSUPPORTED_MEDIA_TYPE
RANGE_NOT_SATISFIABLE
EXPECTATION_FAILED
MISDIRECTED_REQUEST
UNPROCESSABLE_ENTITY
LOCKED
FAILED_DEPENDENCY
UPGRADE_REQUIRED
PRECONDITION_REQUIRED
TOO_MANY_REQUESTS
REQUEST_HEADER_FIELDS_TOO_LARGE
CONNECTION_CLOSED_WITHOUT_RESPONSE
UNAVAILABLE_FOR_LEGAL_REASONS
CLIENT_CLOSED_REQUEST
INTERNAL_SERVER_ERROR
NOT_IMPLEMENTED
BAD_GATEWAY
SERVICE_UNAVAILABLE
GATEWAY_TIMEOUT
HTTP_VERSION_NOT_SUPPORTED
VARIANT_ALSO_NEGOTIATES
INSUFFICIENT_STORAGE
LOOP_DETECTED
NOT_EXTENDED
NETWORK_AUTHENTICATION_REQUIRED
NETWORK_CONNECT_TIMEOUT_ERROR

Definition at line 56 of file HTTPResponse.h.

Constructor & Destructor Documentation

HTTPResponse() [1/6]

RemoteViz::Rendering::HTTPResponse::HTTPResponse

(

)

Creates a HTTP/1.1 response with "200 OK" status.

HTTPResponse() [2/6]

RemoteViz::Rendering::HTTPResponse::HTTPResponse

(

HTTPStatus

statusCode

)

Creates a HTTP/1.1 response with the given status and a standard reason phrase.

HTTPResponse() [3/6]

RemoteViz::Rendering::HTTPResponse::HTTPResponse	(	HTTPStatus	statusCode,
		const std::string &	reason )

Creates a HTTP/1.1 response with the given status and reason phrase.

HTTPResponse() [4/6]

RemoteViz::Rendering::HTTPResponse::HTTPResponse	(	HTTPStatus	statusCode,
		const std::string &	reason,
		const std::string &	body )

Creates a HTTP/1.1 response with the given status, reason phrase and message body data.

HTTPResponse() [5/6]

RemoteViz::Rendering::HTTPResponse::HTTPResponse	(	HTTPStatus	statusCode,
		const std::string &	reason,
		const std::string &	body,
		int	versionMajor,
		int	versionMinor,
		const HTTPHeaders &	headers )

Creates a HTTP response with the given status, reason phrase, message body data, version and headers.

HTTPResponse() [6/6]

RemoteViz::Rendering::HTTPResponse::HTTPResponse

(

const HTTPResponse &

obj

)

Copy constructor.

~HTTPResponse()

RemoteViz::Rendering::HTTPResponse::~HTTPResponse

(

)

Destructor.

Member Function Documentation

getBody()

const std::string & RemoteViz::Rendering::HTTPResponse::getBody

(

)

const

Returns the HTTP message body data (optional).

Returns an empty string if the response does not have a body message.

getContentLength()

int64_t RemoteViz::Rendering::HTTPResponse::getContentLength

(

)

const

Returns the size of the body, in bytes (Content-Length entity header)

getHeaders()

const HTTPHeaders & RemoteViz::Rendering::HTTPResponse::getHeaders

(

)

const

Returns HTTP headers.

getReason()

const std::string & RemoteViz::Rendering::HTTPResponse::getReason

(

)

const

Returns the HTTP reason phrase.

getReasonPhrase()

static std::string RemoteViz::Rendering::HTTPResponse::getReasonPhrase ( HTTPStatus status )

static

Returns the standard HTTP reason phrase for a HTTP status code.

getStatusCode()

HTTPStatus RemoteViz::Rendering::HTTPResponse::getStatusCode

(

)

const

Returns the HTTP status.

getVersion()

const std::string & RemoteViz::Rendering::HTTPResponse::getVersion

(

)

const

Returns the HTTP version for incoming request (example "HTTP/1.1").

getVersionMajor()

int RemoteViz::Rendering::HTTPResponse::getVersionMajor

(

)

const

HTTP uses a "major.minor" numbering scheme to indicate versions of the protocol.

Returns the version major.

getVersionMinor()

int RemoteViz::Rendering::HTTPResponse::getVersionMinor

(

)

const

HTTP uses a "major.minor" numbering scheme to indicate versions of the protocol.

Returns the version minor.

operator=()

HTTPResponse & RemoteViz::Rendering::HTTPResponse::operator=

(

const HTTPResponse &

obj

)

Copy assignment operator.

---

The documentation for this class was generated from the following file:

• RemoteViz/Rendering/HTTPResponse.h