HttpResponse Class Reference

Represents an HTTP response object. More...

#include <HttpResponse.h>

Collaboration diagram for HttpResponse:

Public Member Functions
	HttpResponse ()=default
	HttpResponse (Tcp *tcp)
	Construct a new HttpResponse object with a socket.
Tcp *	getTcp () const
HttpResponse &	status (int code)
	Set the HTTP status code.
HttpResponse &	setStatus (int code)
	Alias for status().
HttpResponse &	setBody (const std::string &body)
	Set the body of the response (string).
HttpResponse &	setContentType (const std::string &content_type)
	Set the Content-Type header.
std::string	getContentType () const
	Get the current Content-Type header value.
HttpResponse &	set (const std::string &field, const std::string &value)
	Set a generic header field.
HttpResponse &	setHeader (const std::string &key, const std::string &value)
	Alias for set() for custom headers.
HttpResponse &	setAuthorization (const std::string &jwtToken)
	Set an Authorization header with a JWT token.
bool	isHeaderSent () const
	Check if the headers have already been sent.
HttpResponse &	setCookie (const std::string &name, const std::string &value, const std::string &options)
	Set a cookie to be sent with the response.
HttpResponse &	clearCookie (const std::string &name, const std::string &options)
	Clear a cookie by setting Max-Age=0.
void	send (const std::string &body)
	Send a full response including headers and body.
void	send ()
void	send (std::nullptr_t)=delete
void	send (const FrameworkView &view)
void	send (const std::string &body, const std::string &contentType)
void	send (const FrameworkView &view, const std::map< std::string, std::string > &context)
void	sendHeaders ()
	Send only the headers (for chunked/streaming responses).
void	start (int code, size_t contentLength, const std::string &contentType="application/octet-stream", const std::string &contentEncoding="")
	Begin a streaming response by sending headers.
void	writeChunk (const char *data, size_t length)
	Send a chunk of the response body.
void	finish ()
	Finish the response (placeholder for potential finalization).
bool	ok () const
	Check if the response status code indicates success.
int	getSocket () const
	Return the raw socket descriptor.
void	sendUnauthorized ()
	Send a 401 Unauthorized JSON response.
void	sendNotFound ()
	Send a 404 Not Found JSON response.
void	endServerError (const std::string &msg)
	Send a 500 Internal Server Error response.
HttpResponse &	json (const std::string &jsonString)
	Send a JSON string/object with correct content type.
HttpResponse &	json (const nlohmann::json &jsonObj)
HttpResponse &	jsonFormatted (const nlohmann::json &jsonObj)
HttpResponse &	text (const std::string &textString)
	Send a plain text string with correct content type.
HttpResponse &	redirect (const std::string &url, int statusCode)
	Redirect the client to another URL.
bool	sendFile (const std::string &path)
	Sends the specified file from mounted storage to the client.
std::string	renderTemplate (const std::string &tpl, const std::map< std::string, std::string > &context)
	Apply basic variable substitution in a template.
int	getStatusCode () const
	Get the response status code.
std::string	getHeader (const std::string &key) const
	Get the value of a specific response header.
const std::map< std::string, std::string > &	getHeaders () const
	Get all response headers.
const std::string &	getBody () const
	Get the response body.
void	reset ()
	Clear the response status, headers, and body.
bool	isBodyTruncated () const
	Check if the response body was truncated.
void	markBodyTruncated ()
	Mark the response body as truncated.
HttpResponse &	sendSuccess (const nlohmann::json &data={}, const std::string &message="")
HttpResponse &	sendCreated (const nlohmann::json &data={}, const std::string &message="")
HttpResponse &	sendMessage (const std::string &message)
HttpResponse &	sendNoContent ()
HttpResponse &	sendError (int statusCode, const std::string &code, const std::string &message)
HttpResponse &	sendError (int statusCode, const std::string &message)
HttpResponse &	toFile (const std::string &path, StorageManager *storage)

Private Member Functions
std::string	getStatusMessage (int code)
	Convert an HTTP status code to its standard message.

Private Attributes
Tcp *	tcp
	Pointer to the Tcp object for socket operations.
int	status_code = 200
	HTTP status code.
bool	headerSent = false
	Tracks whether headers have already been sent.
bool	bodyTruncated = false
std::map< std::string, std::string >	headers
	Response headers (server+client)
std::vector< std::string >	cookies
	Set-Cookie headers (server only)
std::string	body
	Full response body (client-side or buffered server content)

Detailed Description

Used by the server to construct and send headers, content, and cookies in response to an incoming HTTP request.

Examples

/home/runner/work/pico-framework-docs/pico-framework-docs/pico-framework/framework/include/http/Middleware.h.

Definition at line 36 of file HttpResponse.h.

Constructor & Destructor Documentation

HttpResponse() [1/2]

HttpResponse::HttpResponse ( )

default

HttpResponse() [2/2]

HttpResponse::HttpResponse

(

Tcp *

tcp

)

Construct a new HttpResponse object.

Parameters

sock	The socket file descriptor.
sock	Socket descriptor for the client connection.

Definition at line 39 of file HttpResponse.cpp.

    : tcp(tcp), status_code(200), headerSent(false)
{
}

Member Function Documentation

clearCookie()

HttpResponse & HttpResponse::clearCookie	(	const std::string &	name,
		const std::string &	options
	)

Clear a cookie by setting Max-Age=0.

Parameters

name	Cookie name.
options	Optional options to include in the Set-Cookie header.

Returns

Reference to this HttpResponse object.

Parameters

name	Cookie name.
options	Optional options to include in the Set-Cookie header.

Returns

Reference to this HttpResponse object.

Definition at line 174 of file HttpResponse.cpp.

{
    std::ostringstream cookie;
    cookie << name << "=; Max-Age=0";
    if (!options.empty())
    {
        cookie << "; " << options;
    }
    cookies.push_back(cookie.str());
    return *this;
}

References cookies.

endServerError()

void HttpResponse::endServerError

(

const std::string &

message

)

Send a 500 Internal Server Error response.

Parameters

msg	Error message to include.

Parameters

msg	Error message to include.

Definition at line 342 of file HttpResponse.cpp.

{
    return status(500)
        .setContentType("application/json")
        .send("{\"error\": \"" + message + "\"}");
}

References send(), setContentType(), and status().

Here is the call graph for this function:

finish()

void HttpResponse::finish

(

)

Finish the response (placeholder for potential finalization).

Definition at line 310 of file HttpResponse.cpp.

{
    // Placeholder for future expansion (e.g., chunked transfer end).
}

Referenced by FileHandler::serveFile().

Here is the caller graph for this function:

getBody()

const std::string & HttpResponse::getBody ( ) const

inline

Returns

Response body string

Definition at line 304 of file HttpResponse.h.

    {
        return body;
    }

References body.

Referenced by TimeManager::fetchAndApplyTimezoneFromOpenMeteo(), and TimeManager::getLocationFromIp().

Here is the caller graph for this function:

getContentType()

std::string HttpResponse::getContentType

(

)

const

Get the current Content-Type header value.

Returns

MIME type string.

Returns

MIME type string.

Definition at line 108 of file HttpResponse.cpp.

{
    auto it = headers.find("Content-Type");
    return (it != headers.end()) ? it->second : "text/html";
}

References headers.

getHeader()

std::string HttpResponse::getHeader ( const std::string &  key ) const

inline

Parameters

key	Header name

Returns

Header value (empty string if not found)

Definition at line 285 of file HttpResponse.h.

    {
        auto it = headers.find(key);
        return (it != headers.end()) ? it->second : "";
    }

References headers.

getHeaders()

const std::map< std::string, std::string > & HttpResponse::getHeaders ( ) const

inline

Returns

Map of header key/value pairs

Definition at line 295 of file HttpResponse.h.

    {
        return headers;
    }

References headers.

getSocket()

int HttpResponse::getSocket

(

)

const

Return the raw socket descriptor.

Definition at line 125 of file HttpResponse.cpp.

{
    return tcp->getSocketFd();
}

References Tcp::getSocketFd(), and tcp.

Here is the call graph for this function:

getStatusCode()

int HttpResponse::getStatusCode ( ) const

inline

Returns

Status code (e.g., 200)

Definition at line 275 of file HttpResponse.h.

    {
        return status_code;
    }

References status_code.

Referenced by TimeManager::fetchAndApplyTimezoneFromOpenMeteo().

Here is the caller graph for this function:

getStatusMessage()

std::string HttpResponse::getStatusMessage ( int  code )

private

Return the standard HTTP status message for a code.

Parameters

code	HTTP status code.

Returns

Corresponding message (e.g., "OK").

Parameters

code	HTTP status code.

Returns

Corresponding status message.

Definition at line 135 of file HttpResponse.cpp.

{
    switch (code)
    {
    case 200:
        return "OK";
    case 401:
        return "Unauthorized";
    case 404:
        return "Not Found";
    case 500:
        return "Internal Server Error";
    default:
        return "";
    }
}

Referenced by send(), sendHeaders(), and start().

Here is the caller graph for this function:

getTcp()

Tcp * HttpResponse::getTcp ( ) const

inline

Definition at line 48 of file HttpResponse.h.

{ return tcp; }

References tcp.

isBodyTruncated()

bool HttpResponse::isBodyTruncated ( ) const

inline

Returns

True if the body was truncated, false otherwise.

Definition at line 318 of file HttpResponse.h.

{ return bodyTruncated; }

References bodyTruncated.

isHeaderSent()

bool HttpResponse::isHeaderSent

(

)

const

Check if the headers have already been sent.

Returns

True if headers have been sent, false otherwise.

Returns

True if headers have been sent, false otherwise.

Definition at line 117 of file HttpResponse.cpp.

{
    return headerSent;
}

References headerSent.

json() [1/2]

HttpResponse & HttpResponse::json

(

const nlohmann::json &

jsonObj

)

Definition at line 359 of file HttpResponse.cpp.

{
    return json(jsonObj.dump()); // dump() creates a compact string
}

json() [2/2]

HttpResponse & HttpResponse::json

(

const std::string &

body

)

Send a JSON string/object with correct content type.

Parameters

jsonString

Valid JSON content.

Returns

Reference to this HttpResponse object.

Parameters

jsonString

Valid JSON content.

Returns

Reference to this HttpResponse object.

Definition at line 352 of file HttpResponse.cpp.

{
    this->set("Content-Type", "application/json")
        .send(body);
    return *this;
}

References send(), and set().

Referenced by DashboardController::getLedState(), GpioController::getState(), DashboardController::getTemperature(), GpioController::handleGetMultipleGpios(), App::initRoutes(), JsonResponse::sendCreated(), JsonResponse::sendError(), JsonResponse::sendJson(), JsonResponse::sendMessage(), JsonResponse::sendSuccess(), DashboardController::setLedState(), and GpioController::setState().

Here is the call graph for this function:

Here is the caller graph for this function:

jsonFormatted()

HttpResponse & HttpResponse::jsonFormatted

(

const nlohmann::json &

jsonObj

)

Definition at line 364 of file HttpResponse.cpp.

{
    return json(jsonObj.dump(2)); // dump() creates a compact string
}

markBodyTruncated()

void HttpResponse::markBodyTruncated ( )

inline

This is used when the body exceeds the maximum allowed size.

Definition at line 324 of file HttpResponse.h.

{ bodyTruncated = true; }

References bodyTruncated.

ok()

bool HttpResponse::ok ( ) const

inline

Returns

True if status code is 2xx, false otherwise.

Definition at line 192 of file HttpResponse.h.

    {
        return status_code >= 200 && status_code < 300;
    }

References status_code.

redirect()

HttpResponse & HttpResponse::redirect	(	const std::string &	url,
		int	statusCode
	)

Parameters

url	Target URL.
statusCode	HTTP status code (e.g. 302).

Returns

Reference to this HttpResponse object.

Definition at line 379 of file HttpResponse.cpp.

{
    this->status(code)
        .set("Location", url)
        .send("");
    return *this;
}

References send(), set(), and status().

Here is the call graph for this function:

renderTemplate()

std::string HttpResponse::renderTemplate	(	const std::string &	tpl,
		const std::map< std::string, std::string > &	context
	)

Apply basic variable substitution in a template.

Parameters

tpl	Input template with {{placeholders}}.
context	Key-value map for substitution.

Returns

Final rendered template string.

Parameters

tpl	Input template with {{placeholders}}.
context	Key-value map for substitution.

Returns

Final rendered template string.

Definition at line 390 of file HttpResponse.cpp.

{
    std::string result = tpl;
    for (const auto &[key, value] : context)
    {
        std::string placeholder = "{{" + key + "}}";
        size_t pos = 0;
        while ((pos = result.find(placeholder, pos)) != std::string::npos)
        {
            result.replace(pos, placeholder.length(), value);
            pos += value.length();
        }
    }
    return result;
}

reset()

void HttpResponse::reset

(

)

Definition at line 434 of file HttpResponse.cpp.

                         {
    status_code = 0;
    headers.clear();
    body.clear();
}

References body, headers, and status_code.

send() [1/6]

void HttpResponse::send ( )

inline

Definition at line 142 of file HttpResponse.h.

               {
        send("");  // delegate to the existing one-arg version with empty body
    }

References send().

Referenced by send(), send(), send(), and send().

Here is the call graph for this function:

Here is the caller graph for this function:

send() [2/6]

void HttpResponse::send ( const FrameworkView &  view )

inline

Definition at line 148 of file HttpResponse.h.

                                         {
        send(view, {});  // delegate to the existing two-arg version with empty context
    }

References send().

Here is the call graph for this function:

send() [3/6]

void HttpResponse::send	(	const FrameworkView &	view,
		const std::map< std::string, std::string > &	context
	)

Definition at line 419 of file HttpResponse.cpp.

                                                                     {
    view.applyHeaders(*this);
    setContentType(view.getContentType());
    std::string body = view.render(context);
    send(body);
}

References FrameworkView::applyHeaders(), body, FrameworkView::getContentType(), FrameworkView::render(), send(), and setContentType().

Here is the call graph for this function:

send() [4/6]

void HttpResponse::send

(

const std::string &

body

)

Parameters

body	HttpResponse body as a string.

Definition at line 193 of file HttpResponse.cpp.

{
    TRACE("HttpResponse::send()\n");
    if (!headerSent)
    {
        if (headers.find("Content-Length") == headers.end())
        {
            headers["Content-Length"] = std::to_string(body.size());
        }
        if (headers.find("Content-Type") == headers.end())
        {
            headers["Content-Type"] = "text/html";
        }
 
        std::ostringstream resp;
        resp << "HTTP/1.1 " << status_code << " " << getStatusMessage(status_code) << "\r\n";
        for (auto &h : headers)
        {
            resp << h.first << ": " << h.second << "\r\n";
        }
        for (const auto &cookie : cookies)
        {
            resp << "Set-Cookie: " << cookie << "\r\n";
        }
        resp << "\r\n";
 
        std::string header_str = resp.str();
        tcp->send(header_str.c_str(), header_str.size());
        headerSent = true;
    }
 
    tcp->send(body.data(), body.size());
    TRACE("HttpResponse::send() completed\n");
}

References body, cookies, getStatusMessage(), headers, headerSent, Tcp::send(), status_code, tcp, and TRACE.

Referenced by endServerError(), MultipartParser::handleMultipart(), App::initRoutes(), DashboardController::initRoutes(), json(), redirect(), HtmlTemplateView::render(), JsonResponse::sendNoContent(), sendNotFound(), sendUnauthorized(), and text().

Here is the call graph for this function:

Here is the caller graph for this function:

send() [5/6]

void HttpResponse::send	(	const std::string &	body,
		const std::string &	contentType
	)

Definition at line 412 of file HttpResponse.cpp.

                                                                           {
    setHeader("Content-Type", contentType);
    send(body);
}

References body, send(), and setHeader().

Here is the call graph for this function:

send() [6/6]

void HttpResponse::send ( std::nullptr_t  )

delete

sendCreated()

HttpResponse & HttpResponse::sendCreated	(	const nlohmann::json &	data = {},
		const std::string &	message = ""
	)

Definition at line 69 of file JsonResponse.cpp.

                                                                                          {
    JsonResponse::sendCreated(*this, data, message);
    return *this;
}

References JsonResponse::sendCreated().

Here is the call graph for this function:

sendError() [1/2]

HttpResponse & HttpResponse::sendError	(	int	statusCode,
		const std::string &	code,
		const std::string &	message
	)

Definition at line 84 of file JsonResponse.cpp.

                                                                                                     {
    JsonResponse::sendError(*this, statusCode, code, message);
    return *this;
}

References JsonResponse::sendError().

Referenced by DashboardController::deleteFile(), and HttpFileserver::handle_list_directory().

Here is the call graph for this function:

Here is the caller graph for this function:

sendError() [2/2]

HttpResponse & HttpResponse::sendError	(	int	statusCode,
		const std::string &	message
	)

Definition at line 446 of file HttpResponse.cpp.

                                                                              {
    JsonResponse::sendError(*this, statusCode, "error", message);
    return *this;
}

References JsonResponse::sendError().

Here is the call graph for this function:

sendFile()

bool HttpResponse::sendFile

(

const std::string &

path

)

Parameters

path	Relative path to the file (e.g. "/index.html").

Returns

true if the file was successfully sent.

false if the file was not found or an error occurred.

Definition at line 440 of file HttpResponse.cpp.

{
    FileHandler fileHandler;
    return fileHandler.serveFile(*this, path.c_str());
}

References FileHandler::serveFile().

Referenced by DashboardController::initRoutes().

Here is the call graph for this function:

Here is the caller graph for this function:

sendHeaders()

void HttpResponse::sendHeaders

(

)

Send only the headers (for chunked/streaming responses).

Definition at line 231 of file HttpResponse.cpp.

{
    if (!headerSent)
    {
        std::ostringstream resp;
        resp << "HTTP/1.1 " << status_code << " " << getStatusMessage(status_code) << "\r\n";
 
        for (auto &h : headers)
        {
            resp << h.first << ": " << h.second << "\r\n";
        }
        for (const auto &cookie : cookies)
        {
            resp << "Set-Cookie: " << cookie << "\r\n";
        }
        if (headers.find("Connection") == headers.end())
        {
            resp << "Connection: close\r\n";
        }
        resp << "\r\n";
 
        std::string header_str = resp.str();
        tcp->send(header_str.c_str(), header_str.size()); 
        headerSent = true;
    }
}

References cookies, getStatusMessage(), headers, headerSent, Tcp::send(), status_code, and tcp.

Here is the call graph for this function:

sendMessage()

HttpResponse & HttpResponse::sendMessage

(

const std::string &

message

)

Definition at line 74 of file JsonResponse.cpp.

                                                                {
    JsonResponse::sendMessage(*this, message);
    return *this;
}

References JsonResponse::sendMessage().

Here is the call graph for this function:

sendNoContent()

HttpResponse & HttpResponse::sendNoContent

(

)

Definition at line 79 of file JsonResponse.cpp.

                                          {
    JsonResponse::sendNoContent(*this);
    return *this;
}

References JsonResponse::sendNoContent().

Here is the call graph for this function:

sendNotFound()

void HttpResponse::sendNotFound

(

)

Send a 404 Not Found JSON response.

Definition at line 332 of file HttpResponse.cpp.

{
    return status(404)
        .setContentType("application/json")
        .send(R"({"error": "Not Found"})");
}

References send(), setContentType(), and status().

Here is the call graph for this function:

sendSuccess()

HttpResponse & HttpResponse::sendSuccess	(	const nlohmann::json &	data = {},
		const std::string &	message = ""
	)

Definition at line 64 of file JsonResponse.cpp.

                                                                                          {
    JsonResponse::sendSuccess(*this, data, message);
    return *this;
}

References JsonResponse::sendSuccess().

Referenced by DashboardController::deleteFile(), and HttpFileserver::handle_list_directory().

Here is the call graph for this function:

Here is the caller graph for this function:

sendUnauthorized()

void HttpResponse::sendUnauthorized

(

)

Send a 401 Unauthorized JSON response.

Definition at line 322 of file HttpResponse.cpp.

{
    this->status(401)
        .set("Content-Type", "application/json")
        .send("{\"error\": \"Unauthorized\"}");
}

References send(), set(), and status().

Here is the call graph for this function:

set()

HttpResponse & HttpResponse::set	(	const std::string &	field,
		const std::string &	value
	)

Set a generic header field.

Parameters

field	Header name.
value	Header value.

Returns

Reference to this HttpResponse object.

Parameters

field	Header name.
value	Header value.

Returns

Reference to this HttpResponse object.

Definition at line 69 of file HttpResponse.cpp.

{
    headers[field] = value;
    return *this;
}

References headers.

Referenced by json(), redirect(), sendUnauthorized(), FileHandler::serveFile(), and text().

Here is the caller graph for this function:

setAuthorization()

HttpResponse & HttpResponse::setAuthorization

(

const std::string &

jwtToken

)

Set an Authorization header with a JWT token.

Parameters

jwtToken

The JWT string.

Returns

Reference to this HttpResponse object.

Parameters

jwtToken

The JWT string.

Returns

Reference to this HttpResponse object.

Definition at line 96 of file HttpResponse.cpp.

{
    if (!jwtToken.empty())
    {
        headers["Authorization"] = "Bearer " + jwtToken;
    }
    return *this;
}

References headers.

setBody()

HttpResponse & HttpResponse::setBody

(

const std::string &

body

)

Parameters

body	Response body content

Definition at line 429 of file HttpResponse.cpp.

                                                         {
    this->body = body;
    return *this;
}

References body.

setContentType()

HttpResponse & HttpResponse::setContentType

(

const std::string &

ct

)

Set the Content-Type header.

Parameters

content_type

MIME type string.

Returns

Reference to this HttpResponse object.

Parameters

content_type

MIME type string.

Returns

Reference to this HttpResponse object.

Definition at line 87 of file HttpResponse.cpp.

{
    headers["Content-Type"] = ct;
    return *this;
}

References headers.

Referenced by endServerError(), DashboardController::initRoutes(), HtmlTemplateView::render(), send(), and sendNotFound().

Here is the caller graph for this function:

setCookie()

HttpResponse & HttpResponse::setCookie	(	const std::string &	name,
		const std::string &	value,
		const std::string &	options
	)

Set a cookie to be sent with the response.

Parameters

name	Cookie name.
value	Cookie value.
options	Additional options (e.g., Path, HttpOnly).

Returns

Reference to this HttpResponse object.

Parameters

name	Cookie name.
value	Cookie value.
options	Additional options (e.g., Path, HttpOnly).

Returns

Reference to this HttpResponse object.

Definition at line 159 of file HttpResponse.cpp.

{
    std::ostringstream cookie;
    cookie << name << "=" << value;
    if (!options.empty())
    {
        cookie << "; " << options;
    }
    cookies.push_back(cookie.str());
    return *this;
}

References cookies.

setHeader()

HttpResponse & HttpResponse::setHeader	(	const std::string &	key,
		const std::string &	value
	)

Alias for set() for custom headers.

Definition at line 78 of file HttpResponse.cpp.

{
    headers[key] = value;
    return *this;
}

References headers.

Referenced by HttpServer::handleClient(), and send().

Here is the caller graph for this function:

setStatus()

HttpResponse & HttpResponse::setStatus

(

int

code

)

Alias for status().

Definition at line 60 of file HttpResponse.cpp.

{
    status_code = code;
    return *this;
}

References status_code.

start()

void HttpResponse::start	(	int	code,
		size_t	contentLength,
		const std::string &	contentType = "application/octet-stream",
		const std::string &	contentEncoding = ""
	)

Begin a streaming response by sending headers.

Parameters

code	HTTP status code.
contentLength	Total length of body.
contentType	MIME type.

Parameters

code	HTTP status code.
contentLength	Total length of body.
contentType	MIME type.

Definition at line 261 of file HttpResponse.cpp.

{
    status_code = code;
    headers["Content-Length"] = std::to_string(contentLength);
    headers["Content-Type"] = contentType;
    if (!contentEncoding.empty())
    {
        headers["Content-Encoding"] = contentEncoding;
    }
 
    std::ostringstream resp;
    resp << "HTTP/1.1 " << status_code << " " << getStatusMessage(status_code) << "\r\n";
    for (auto &h : headers)
    {
        resp << h.first << ": " << h.second << "\r\n";
    }
    for (const auto &cookie : cookies)
    {
        resp << "Set-Cookie: " << cookie << "\r\n";
    }
    resp << "\r\n";
 
    std::string header_str = resp.str();
    tcp->send(header_str.c_str(), header_str.size());
    headerSent = true;
}

References cookies, getStatusMessage(), headers, headerSent, Tcp::send(), status_code, and tcp.

Referenced by FileHandler::serveFile().

Here is the call graph for this function:

Here is the caller graph for this function:

status()

HttpResponse & HttpResponse::status

(

int

code

)

Set the HTTP status code.

Parameters

code	Status code (e.g., 200, 404).

Returns

Reference to this HttpResponse object.

Parameters

code	Status code (e.g., 200, 404).

Returns

Reference to this HttpResponse object.

Definition at line 51 of file HttpResponse.cpp.

{
    status_code = code;
    return *this;
}

References status_code.

Referenced by endServerError(), MultipartParser::handleMultipart(), redirect(), JsonResponse::sendCreated(), JsonResponse::sendError(), JsonResponse::sendJson(), JsonResponse::sendMessage(), JsonResponse::sendNoContent(), sendNotFound(), JsonResponse::sendSuccess(), and sendUnauthorized().

Here is the caller graph for this function:

text()

HttpResponse & HttpResponse::text

(

const std::string &

body

)

Send a plain text string with correct content type.

Parameters

textString

Text content.

Returns

Reference to this HttpResponse object.

Parameters

textString

Text content.

Returns

Reference to this HttpResponse object.

Definition at line 372 of file HttpResponse.cpp.

{
    this->set("Content-Type", "text/plain")
        .send(body);
    return *this;
}

References send(), and set().

Here is the call graph for this function:

toFile()

HttpResponse & HttpResponse::toFile	(	const std::string &	path,
		StorageManager *	storage
	)

Definition at line 452 of file HttpResponse.cpp.

{
    if (!storage || body.empty())
        return *this;
 
    storage->writeFile(path,
                reinterpret_cast<const unsigned char*>(body.data()),
                body.size());
                return *this;
}

References body, and StorageManager::writeFile().

Here is the call graph for this function:

writeChunk()

void HttpResponse::writeChunk	(	const char *	data,
		size_t	length
	)

Send a chunk of the response body.

Parameters

data	Pointer to data buffer.
length	Size of the data.

Parameters

data	Pointer to data buffer.
length	Size of the data.

Definition at line 291 of file HttpResponse.cpp.

{
    if (!headerSent)
    {
        printf("Error: writeChunk called before start()\n");
        return;
    }
 
    int err = tcp->send(data, length); 
    if (err < 0)
    {
        printf("Error sending chunk: %zu\n", err);
        printf("Error: %s\n", strerror(errno));
    }
}

References headerSent, Tcp::send(), and tcp.

Referenced by FileHandler::serveFile().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

body

std::string HttpResponse::body

private

Definition at line 354 of file HttpResponse.h.

Referenced by getBody(), reset(), send(), send(), send(), setBody(), and toFile().

bodyTruncated

bool HttpResponse::bodyTruncated = false

private

Definition at line 349 of file HttpResponse.h.

Referenced by isBodyTruncated(), and markBodyTruncated().

cookies

std::vector<std::string> HttpResponse::cookies

private

Definition at line 352 of file HttpResponse.h.

Referenced by clearCookie(), send(), sendHeaders(), setCookie(), and start().

headers

std::map<std::string, std::string> HttpResponse::headers

private

Definition at line 351 of file HttpResponse.h.

Referenced by getContentType(), getHeader(), getHeaders(), reset(), send(), sendHeaders(), set(), setAuthorization(), setContentType(), setHeader(), and start().

headerSent

bool HttpResponse::headerSent = false

private

Definition at line 348 of file HttpResponse.h.

Referenced by isHeaderSent(), send(), sendHeaders(), start(), and writeChunk().

status_code

int HttpResponse::status_code = 200

private

Definition at line 347 of file HttpResponse.h.

Referenced by getStatusCode(), ok(), reset(), send(), sendHeaders(), setStatus(), start(), and status().

tcp

Tcp* HttpResponse::tcp

private

Definition at line 346 of file HttpResponse.h.

Referenced by getSocket(), getTcp(), send(), sendHeaders(), start(), and writeChunk().

---

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

• HttpResponse.h
• HttpResponse.cpp
• JsonResponse.cpp