A parsed or generated HTTP response. More...

#include <NetworkProtocols.h>

Collaboration diagram for cmlabs::HTTPReply:

Public Member Functions
	HTTPReply (uint64 source=0)
	Construct an empty reply.
	HTTPReply (HTTPReply *reply)
	Deep-copy constructor.
virtual	~HTTPReply ()
bool	isWebsocketUpgrade ()
bool	processHeader (const char *buffer, uint32 size, bool &isInvalid)
	Parse the response header block from raw bytes.
bool	processContent (const char *buffer, uint32 size)
	Append body bytes after the header has been parsed.
bool	setDecodedContent (const char *buffer, uint32 size)
	Replace the body with already-decoded bytes (e.g.
const char *	getHeaderEntry (const char *entry)
	Look up a header field (case-insensitive).
const char *	getProtocol ()
const char *	getContent (uint32 &size)
	Get the (decoded) response body.
const char *	getRawContent (uint32 &size)
	Get the raw, untransformed body bytes.
bool	createPage (uint8 status, uint64 time, const char serverName, uint64 lastMod, bool keepAlive, bool cache, const char contentType, const char content, uint32 contentSize=0, const char additionalHeaderEntries=NULL)
	Build a complete response with headers and content.
bool	createFromFile (uint64 time, const char serverName, uint64 ifLastMod, bool keepAlive, bool cache, const char filename)
	Build a response by reading a file from disk (MIME type from extension).
bool	createOptionsResponse (uint8 status, uint64 time, const char serverName, bool keepAlive, const char origin, const char *operations)
	Build a CORS-preflight (OPTIONS) response.
bool	createErrorPage (uint8 status, uint64 time, const char *serverName, bool keepAlive)
	Build a canned error page for the given status.
bool	createAuthorizationReply (const char *realm)
	Build a 401 Basic-auth challenge.
bool	createWebsocketHTTPReply (const char key, const char version)
	Build the 101 WebSocket handshake completion in-place.
uint32	getSize ()

Static Public Member Functions
static HTTPReply *	CreateErrorReply (uint8 type)
	Build a canned error reply.
static HTTPReply *	CreateAuthorizationReply (const char *realm)
	Build a 401 reply requesting Basic authentication.
static HTTPReply *	CreateWebsocketHTTPReply (const char key, const char version)
	Build the "101 Switching Protocols" reply for a WebSocket handshake.

Public Attributes
uint8	type
	HTTP_* status id of this reply.
uint64	time
	Timestamp of creation/receipt (ms epoch).
uint64	source
	Packed uint64 endpoint of the sender (0 if local).
uint32	headerLength
	Header block length within ::data, in bytes.
uint32	contentLength
	Body length in bytes.
bool	keepAlive
	Whether the connection stays open after this reply.
bool	chunked
	Body uses HTTP/1.1 chunked transfer encoding.
char *	data
	Owned raw reply bytes (header followed by body).
std::map< std::string, std::string >	entries
	Parsed header fields (name to value).
std::map< std::string, std::string >	params
	Auxiliary parsed parameters.

Detailed Description

A parsed or generated HTTP response.

Counterpart to HTTPRequest: on the client side it is filled from socket bytes (processHeader()/processContent()); on the server side it is built with createPage(), createFromFile(), createErrorPage() and friends, then serialised from the owned ::data buffer. Also carries the "101 Switching Protocols" reply that completes a WebSocket handshake.

Note: Not thread-safe; owned by one connection thread.

Definition at line 680 of file NetworkProtocols.h.

Constructor & Destructor Documentation

◆ HTTPReply() [1/2]

cmlabs::HTTPReply::HTTPReply ( uint64 source = 0 )

Construct an empty reply.

Parameters

source Packed uint64 endpoint of the sender.

Definition at line 1422 of file NetworkProtocols.cpp.

References chunked, contentLength, data, cmlabs::GetTimeNow(), headerLength, keepAlive, source, time, and type.

Referenced by CreateAuthorizationReply(), CreateErrorReply(), CreateWebsocketHTTPReply(), and HTTPReply().

◆ HTTPReply() [2/2]

cmlabs::HTTPReply::HTTPReply ( HTTPReply * reply )

Deep-copy constructor.

Parameters

reply Reply to copy (not modified).

Definition at line 1432 of file NetworkProtocols.cpp.

References chunked, contentLength, data, entries, headerLength, HTTPReply(), keepAlive, params, source, time, and type.

◆ ~HTTPReply()

cmlabs::HTTPReply::~HTTPReply ( )

virtual

Definition at line 1449 of file NetworkProtocols.cpp.

References data.

Member Function Documentation

◆ CreateAuthorizationReply()

HTTPReply * cmlabs::HTTPReply::CreateAuthorizationReply ( const char * realm )

static

Build a 401 reply requesting Basic authentication.

Parameters

realm Realm name shown by the browser.

Returns: New reply owned by the caller.

Definition at line 1409 of file NetworkProtocols.cpp.

References createAuthorizationReply(), and HTTPReply().

Referenced by cmlabs::RequestGateway::callInternalAPI().

◆ createAuthorizationReply()

bool cmlabs::HTTPReply::createAuthorizationReply ( const char * realm )

Build a 401 Basic-auth challenge.

Parameters

realm Realm name.

Returns: true on success.

Definition at line 1524 of file NetworkProtocols.cpp.

References contentLength, data, cmlabs::GetHTTPTime(), headerLength, cmlabs::HTTP_Status, HTTP_UNAUTHORIZED, and time.

Referenced by CreateAuthorizationReply().

◆ createErrorPage()

bool cmlabs::HTTPReply::createErrorPage	(	uint8	status,
		uint64	time,
		const char *	serverName,
		bool	keepAlive )

Build a canned error page for the given status.

Parameters

status	HTTP_* status id.
time	Current time.
serverName	Server header.
keepAlive	Keep the connection open.

Returns: true on success.

Definition at line 1503 of file NetworkProtocols.cpp.

References contentLength, data, cmlabs::GetHTTPTime(), headerLength, cmlabs::HTTP_Status, keepAlive, and time.

Referenced by createFromFile(), and cmlabs::RequestGateway::replyToClient().

◆ CreateErrorReply()

HTTPReply * cmlabs::HTTPReply::CreateErrorReply ( uint8 type )

static

Build a canned error reply.

Parameters

type	One of the HTTP_* status ids.

Returns: New reply owned by the caller.

Definition at line 1403 of file NetworkProtocols.cpp.

References HTTPReply(), and type.

Referenced by cmlabs::NetworkChannel::HTTPServerRun(), cmlabs::NetworkManager::makeHTTPRequest(), cmlabs::NetworkManager::makeHTTPRequest(), cmlabs::NetworkManager::makeHTTPRequest(), cmlabs::NetworkManager::makeHTTPRequest(), cmlabs::HTTPProtocol::ReceiveHTTPReply(), and cmlabs::NetworkChannel::sendReceiveHTTPRequest().

◆ createFromFile()

bool cmlabs::HTTPReply::createFromFile	(	uint64	time,
		const char *	serverName,
		uint64	ifLastMod,
		bool	keepAlive,
		bool	cache,
		const char *	filename )

Build a response by reading a file from disk (MIME type from extension).

Replies 304 Use-Local-Copy when the file is unchanged since ifLastMod.

Parameters

time	Current time (ms epoch).
serverName	Server header value.
ifLastMod	Client's If-Modified-Since timestamp (0 = none).
keepAlive	Keep the connection open.
cache	Allow client caching.
filename	Path of the file to serve.

Returns: true when the reply was assembled (404 error page when missing).

Definition at line 1612 of file NetworkProtocols.cpp.

References createErrorPage(), createPage(), cmlabs::utils::FileDetails::doesExist, cmlabs::utils::GetFileDetails(), cmlabs::html::GetMimeType(), cmlabs::GetTimeNow(), HTTP_FILE_NOT_FOUND, HTTP_OK, HTTP_USE_LOCAL_COPY, cmlabs::utils::FileDetails::isDirectory, keepAlive, cmlabs::utils::FileDetails::lastModifyTime, cmlabs::utils::ReadAFile(), cmlabs::utils::ReadAFileString(), cmlabs::utils::StringFormat(), and time.

Referenced by cmlabs::RequestGateway::callInternalAPI(), and cmlabs::RequestGateway::receiveHTTPRequest().

◆ createOptionsResponse()

bool cmlabs::HTTPReply::createOptionsResponse	(	uint8	status,
		uint64	time,
		const char *	serverName,
		bool	keepAlive,
		const char *	origin,
		const char *	operations )

Build a CORS-preflight (OPTIONS) response.

Parameters

status	HTTP_* status id.
time	Current time.
serverName	Server header.
keepAlive	Keep the connection open.
origin	Access-Control-Allow-Origin value.
operations	Access-Control-Allow-Methods value.

Returns: true on success.

Definition at line 1457 of file NetworkProtocols.cpp.

References contentLength, data, cmlabs::GetHTTPTime(), headerLength, keepAlive, and time.

Referenced by cmlabs::RequestGateway::replyToClient().

◆ createPage()

bool cmlabs::HTTPReply::createPage	(	uint8	status,
		uint64	time,
		const char *	serverName,
		uint64	lastMod,
		bool	keepAlive,
		bool	cache,
		const char *	contentType,
		const char *	content,
		uint32	contentSize = 0,
		const char *	additionalHeaderEntries = NULL )

Build a complete response with headers and content.

Parameters

status	HTTP_* status id.
time	Current time (ms epoch) for the Date header.
serverName	Server header value.
lastMod	Last-Modified timestamp (0 = omit).
keepAlive	Keep the connection open after sending.
cache	Allow client caching (otherwise Cache-Control: No-Cache).
contentType	MIME type of `content`.
content	Body bytes (copied).
contentSize	Body size (strlen when 0 and text).
additionalHeaderEntries	Optional extra raw header lines.