http::HttpResponse Class Reference

Represents an HTTP response to be sent to a client. More...

#include <HttpResponse.hpp>

Public Member Functions
	HttpResponse ()=default
	HttpResponse (HttpResponse &&other) noexcept
HttpResponse &	operator= (HttpResponse &&other) noexcept
	~HttpResponse ()
	HttpResponse (const HttpResponse &)=delete
HttpResponse &	operator= (const HttpResponse &)=delete
HttpResponse &	set_cookie (const Cookie &cookie)
	Adds a cookie to the response.
HttpResponse &	set_cookie (const std::string &name, const std::string &value)
	Adds a simple key-value cookie to the response.
void	set_body (const std::string &b, const std::string &content_type="text/plain")
	Sets the response body and its content type.
HttpResponse &	status (HttpStatus code) &
	Sets the HTTP status code of the response.
HttpResponse &&	status (HttpStatus code) &&
HttpResponse &	send (const std::string &b) &
	Sets the response body as plain text.
HttpResponse &&	send (const std::string &b) &&
HttpResponse &	json (const std::string &j) &
	Sets the response body as JSON from a string.
HttpResponse &&	json (const std::string &j) &&
HttpResponse &	json (const nlohmann::json &j) &
	Sets the response body as JSON from a nlohmann::json object.
HttpResponse &&	json (const nlohmann::json &j) &&
HttpResponse &	html (const std::string &h) &
	Sets the response body as HTML.
HttpResponse &&	html (const std::string &h) &&
void	render (const std::string &template_path, const nlohmann::json &data)
	Renders a template and sets it as the HTML response body.
void	send_file (const std::string &path, const std::string &content_type)
	Prepares a file to be sent using zero-copy (sendfile).
std::string	serialize () const
	Serializes the entire response (headers and body) to a string.
std::string	serialize_headers () const
	Serializes only the response headers to a string.

Public Attributes
std::vector< Cookie >	cookies
HttpStatus	status_code = HttpStatus::OK
std::unordered_map< std::string, std::string, utils::CaseInsensitiveHash, utils::CaseInsensitiveEqual >	headers
std::string	body
int	file_fd {-1}
off_t	file_size {0}

Detailed Description

Represents an HTTP response to be sent to a client.

Constructor & Destructor Documentation

HttpResponse() [1/3]

http::HttpResponse::HttpResponse ( )

default

HttpResponse() [2/3]

http::HttpResponse::HttpResponse ( HttpResponse &&  other )

noexcept

~HttpResponse()

http::HttpResponse::~HttpResponse

(

)

HttpResponse() [3/3]

http::HttpResponse::HttpResponse ( const HttpResponse &  )

delete

Member Function Documentation

html() [1/2]

HttpResponse & http::HttpResponse::html ( const std::string &  h ) &

inline

Sets the response body as HTML.

Parameters

h	The HTML string content.

html() [2/2]

HttpResponse && http::HttpResponse::html ( const std::string &  h ) &&

inline

json() [1/4]

HttpResponse & http::HttpResponse::json ( const nlohmann::json &  j ) &

inline

Sets the response body as JSON from a nlohmann::json object.

Parameters

j	The nlohmann::json object to send.

json() [2/4]

HttpResponse && http::HttpResponse::json ( const nlohmann::json &  j ) &&

inline

json() [3/4]

HttpResponse & http::HttpResponse::json ( const std::string &  j ) &

inline

Sets the response body as JSON from a string.

Parameters

j	The JSON string content.

json() [4/4]

HttpResponse && http::HttpResponse::json ( const std::string &  j ) &&

inline

operator=() [1/2]

HttpResponse & http::HttpResponse::operator= ( const HttpResponse &  )

delete

operator=() [2/2]

HttpResponse & http::HttpResponse::operator= ( HttpResponse &&  other )

noexcept

render()

void http::HttpResponse::render	(	const std::string &	template_path,
		const nlohmann::json &	data
	)

Renders a template and sets it as the HTML response body.

Parameters

template_path	The path to the template file.
data	The JSON data to inject into the template.

send() [1/2]

HttpResponse & http::HttpResponse::send ( const std::string &  b ) &

inline

Sets the response body as plain text.

Parameters

b	The text content to send.

send() [2/2]

HttpResponse && http::HttpResponse::send ( const std::string &  b ) &&

inline

send_file()

void http::HttpResponse::send_file	(	const std::string &	path,
		const std::string &	content_type
	)

Prepares a file to be sent using zero-copy (sendfile).

Parameters

path	The path to the file to send.
content_type	The MIME type of the file.

serialize()

std::string http::HttpResponse::serialize

(

)

const

Serializes the entire response (headers and body) to a string.

Returns

The serialized HTTP response string.

serialize_headers()

std::string http::HttpResponse::serialize_headers

(

)

const

Serializes only the response headers to a string.

Returns

The serialized HTTP response headers string.

set_body()

void http::HttpResponse::set_body	(	const std::string &	b,
		const std::string &	content_type = "text/plain"
	)

Sets the response body and its content type.

Parameters

b	The response body content.
content_type	The MIME type of the body (default: "text/plain").

set_cookie() [1/2]

HttpResponse & http::HttpResponse::set_cookie ( const Cookie &  cookie )

inline

Adds a cookie to the response.

Parameters

cookie

The Cookie object to add.

Returns

A reference to this HttpResponse for method chaining.

set_cookie() [2/2]

HttpResponse & http::HttpResponse::set_cookie ( const std::string &  name, const std::string &  value  )

inline

Adds a simple key-value cookie to the response.

Parameters

name	The name of the cookie.
value	The value of the cookie.

Returns

A reference to this HttpResponse for method chaining.

status() [1/2]

HttpResponse & http::HttpResponse::status ( HttpStatus  code ) &

inline

Sets the HTTP status code of the response.

Parameters

code	The HttpStatus code to set.

Returns

A reference to this HttpResponse for method chaining.

status() [2/2]

HttpResponse && http::HttpResponse::status ( HttpStatus  code ) &&

inline

Member Data Documentation

body

std::string http::HttpResponse::body

cookies

std::vector<Cookie> http::HttpResponse::cookies

file_fd

int http::HttpResponse::file_fd {-1}

file_size

off_t http::HttpResponse::file_size {0}

headers

std::unordered_map<std::string, std::string, utils::CaseInsensitiveHash, utils::CaseInsensitiveEqual> http::HttpResponse::headers

status_code

HttpStatus http::HttpResponse::status_code = HttpStatus::OK

---

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

• include/orbit/http/HttpResponse.hpp
• src/http/HttpResponse.cpp