HTTPRequest Class Reference

#include <httpserver.h>

Collaboration diagram for HTTPRequest:

Public Types
enum class	State {   Init , NeedsHeaders , NeedsBody , Complete ,   Error }

Public Member Functions
	HTTPRequest (const std::shared_ptr< HTTPRemoteClient > &client)
	HTTPRequest ()
	Construct with a null client for unit tests.
State	Load (util::LineReader &reader)
	Try to read an HTTP request or part of it.
void	WriteReply (HTTPStatusCode status, std::span< const std::byte > reply_body={})
void	WriteReply (HTTPStatusCode status, std::string_view reply_body_view)
const HTTPVersion &	GetVersion () const LIFETIMEBOUND
std::shared_ptr< HTTPRemoteClient >	GetClient () const
std::string	GetURI () const
CService	GetPeer () const
HTTPRequestMethod	GetRequestMethod () const
std::optional< std::string >	GetQueryParameter (std::string_view key) const
std::optional< std::string >	GetHeader (std::string_view hdr) const
std::string	ReadBody () const
void	WriteHeader (std::string &&hdr, std::string &&value)
std::optional< uint64_t >	GetChunkSize () const
uint64_t	GetChunkProgress () const
State	GetState () const

Private Member Functions
Request parsers
Methods that attempt to parse HTTP request fields line-by-line from a receive buffer. Returns true If the request field was parsed. false If there was not enough data in the buffer to complete the field. Exceptions std::runtime_error if data is invalid.
bool	LoadControlData (util::LineReader &reader)
bool	LoadHeaders (util::LineReader &reader)
bool	LoadBody (util::LineReader &reader)

Private Attributes
HTTPRequestMethod	m_method
std::string	m_target
HTTPVersion	m_version
HTTPHeaders	m_headers
std::string	m_body
std::weak_ptr< HTTPRemoteClient >	m_client
	Pointer to the client that made the request so we know who to respond to.
HTTPHeaders	m_response_headers
	Response headers may be set in advance before response body is known.
std::optional< uint64_t >	m_chunk_size
uint64_t	m_chunk_read {0}
State	m_state = State::Init

Detailed Description

Definition at line 155 of file httpserver.h.

Member Enumeration Documentation

State

enum class HTTPRequest::State

strong

Enumerator
Init
NeedsHeaders
NeedsBody
Complete
Error

Definition at line 158 of file httpserver.h.

Constructor & Destructor Documentation

HTTPRequest() [1/2]

HTTPRequest::HTTPRequest ( const std::shared_ptr< HTTPRemoteClient > &  client )

inlineexplicit

Definition at line 166 of file httpserver.h.

HTTPRequest() [2/2]

HTTPRequest::HTTPRequest ( )

inlineexplicit

Construct with a null client for unit tests.

Definition at line 168 of file httpserver.h.

Member Function Documentation

GetChunkProgress()

uint64_t HTTPRequest::GetChunkProgress ( ) const

inline

Definition at line 197 of file httpserver.h.

GetChunkSize()

std::optional< uint64_t > HTTPRequest::GetChunkSize ( ) const

inline

Definition at line 196 of file httpserver.h.

GetClient()

std::shared_ptr< HTTPRemoteClient > HTTPRequest::GetClient ( ) const

inline

Definition at line 185 of file httpserver.h.

GetHeader()

std::optional< std::string > HTTPRequest::GetHeader

(

std::string_view

hdr

)

const

Definition at line 697 of file httpserver.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

GetPeer()

CService HTTPRequest::GetPeer

(

)

const

Definition at line 656 of file httpserver.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

GetQueryParameter()

std::optional< std::string > HTTPRequest::GetQueryParameter

(

std::string_view

key

)

const

Definition at line 665 of file httpserver.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

GetRequestMethod()

HTTPRequestMethod HTTPRequest::GetRequestMethod ( ) const

inline

Definition at line 191 of file httpserver.h.

Here is the caller graph for this function:

GetState()

State HTTPRequest::GetState ( ) const

inline

Definition at line 199 of file httpserver.h.

GetURI()

std::string HTTPRequest::GetURI ( ) const

inline

Definition at line 189 of file httpserver.h.

Here is the caller graph for this function:

GetVersion()

const HTTPVersion & HTTPRequest::GetVersion ( ) const

inline

Definition at line 184 of file httpserver.h.

Here is the caller graph for this function:

Load()

HTTPRequest::State HTTPRequest::Load

(

util::LineReader &

reader

)

Try to read an HTTP request or part of it.

Parameters

[in]

reader

Source of client request data.

Returns

The updated state describing which part(s) remain.

Exceptions

std::runtime_error

if data is invalid.

Definition at line 1230 of file httpserver.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

LoadBody()

bool HTTPRequest::LoadBody ( util::LineReader &  reader )

private

Definition at line 430 of file httpserver.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

LoadControlData()

bool HTTPRequest::LoadControlData ( util::LineReader &  reader )

private

Definition at line 377 of file httpserver.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

LoadHeaders()

bool HTTPRequest::LoadHeaders ( util::LineReader &  reader )

private

Definition at line 425 of file httpserver.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

ReadBody()

std::string HTTPRequest::ReadBody ( ) const

inline

Definition at line 194 of file httpserver.h.

Here is the caller graph for this function:

WriteHeader()

void HTTPRequest::WriteHeader	(	std::string &&	hdr,
		std::string &&	value
	)

Definition at line 702 of file httpserver.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

WriteReply() [1/2]

void HTTPRequest::WriteReply	(	HTTPStatusCode	status,
		std::span< const std::byte >	reply_body = {}
	)

Definition at line 534 of file httpserver.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

WriteReply() [2/2]

void HTTPRequest::WriteReply ( HTTPStatusCode  status, std::string_view  reply_body_view  )

inline

Definition at line 179 of file httpserver.h.

Here is the call graph for this function:

Member Data Documentation

m_body

std::string HTTPRequest::m_body

private

Definition at line 220 of file httpserver.h.

m_chunk_read

uint64_t HTTPRequest::m_chunk_read {0}

private

Definition at line 234 of file httpserver.h.

m_chunk_size

std::optional<uint64_t> HTTPRequest::m_chunk_size

private

Definition at line 231 of file httpserver.h.

m_client

std::weak_ptr<HTTPRemoteClient> HTTPRequest::m_client

private

Pointer to the client that made the request so we know who to respond to.

Definition at line 223 of file httpserver.h.

m_headers

HTTPHeaders HTTPRequest::m_headers

private

Definition at line 219 of file httpserver.h.

m_method

HTTPRequestMethod HTTPRequest::m_method

private

Definition at line 216 of file httpserver.h.

m_response_headers

HTTPHeaders HTTPRequest::m_response_headers

private

Response headers may be set in advance before response body is known.

Definition at line 226 of file httpserver.h.

m_state

State HTTPRequest::m_state = State::Init

private

Definition at line 236 of file httpserver.h.

m_target

std::string HTTPRequest::m_target

private

Definition at line 217 of file httpserver.h.

m_version

HTTPVersion HTTPRequest::m_version

private

Definition at line 218 of file httpserver.h.

---

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

• src/httpserver.h
• src/httpserver.cpp