MythHTTPResponse Class Reference

#include <libmythbase/http/mythhttpresponse.h>

Collaboration diagram for MythHTTPResponse:

Public Member Functions
	MythHTTPResponse ()=default
	MythHTTPResponse (const HTTPRequest2 &Request)
void	Finalise (const MythHTTPConfig &Config)
	Complete all necessary headers, add final line break after headers, remove data etc. More...
template<class T >
std::enable_if_t< std::is_convertible_v< T, QString >, void >	AddHeader (const QString &key, const T &val)
template<class T >
std::enable_if_t<!std::is_convertible_v< T, QString >, void >	AddHeader (const QString &key, T val)

Static Public Member Functions
static HTTPResponse	HandleOptions (const HTTPRequest2 &Request)
static HTTPResponse	ErrorResponse (MythHTTPStatus Status, const QString &ServerName)
static HTTPResponse	RedirectionResponse (const HTTPRequest2 &Request, const QString &Redirect)
static HTTPResponse	ErrorResponse (const HTTPRequest2 &Request, const QString &Message={})
static HTTPResponse	OptionsResponse (const HTTPRequest2 &Request)
static HTTPResponse	DataResponse (const HTTPRequest2 &Request, const HTTPData &Data)
static HTTPResponse	FileResponse (const HTTPRequest2 &Request, const HTTPFile &File)
static HTTPResponse	EmptyResponse (const HTTPRequest2 &Request)
static HTTPResponse	UpgradeResponse (const HTTPRequest2 &Request, MythSocketProtocol &Protocol, bool &Testing)

Public Attributes
QString	m_serverName
MythHTTPVersion	m_version { HTTPOneDotOne }
MythHTTPConnection	m_connection { HTTPConnectionClose }
std::chrono::milliseconds	m_timeout { HTTP_SOCKET_TIMEOUT_MS }
MythHTTPStatus	m_status { HTTPBadRequest }
MythHTTPRequestType	m_requestType { HTTPGet }
int	m_allowed { HTTP_DEFAULT_ALLOWED }
HTTPHeaders	m_requestHeaders { nullptr }
HTTPContents	m_responseHeaders
HTTPVariant	m_response { std::monostate() }

Protected Member Functions
void	AddDefaultHeaders ()
void	AddContentHeaders ()

Detailed Description

Definition at line 16 of file mythhttpresponse.h.

Constructor & Destructor Documentation

MythHTTPResponse() [1/2]

MythHTTPResponse::MythHTTPResponse ( )

default

MythHTTPResponse() [2/2]

MythHTTPResponse::MythHTTPResponse ( const HTTPRequest2 &  Request )

explicit

Definition at line 20 of file mythhttpresponse.cpp.

Member Function Documentation

HandleOptions()

HTTPResponse MythHTTPResponse::HandleOptions ( const HTTPRequest2 &  Request )

static

Definition at line 192 of file mythhttpresponse.cpp.

Referenced by MythHTTPService::HTTPRequest(), MythHTTPFile::ProcessFile(), and MythHTTPRoot::RedirectRoot().

ErrorResponse() [1/2]

HTTPResponse MythHTTPResponse::ErrorResponse ( MythHTTPStatus  Status, const QString &  ServerName  )

static

Definition at line 216 of file mythhttpresponse.cpp.

Referenced by MythXSD::Error(), HandleOptions(), MythHTTPService::HTTPRequest(), MythHTTPFile::ProcessFile(), MythHTTPSocket::Read(), and MythHTTPSocket::Timeout().

RedirectionResponse()

HTTPResponse MythHTTPResponse::RedirectionResponse ( const HTTPRequest2 &  Request, const QString &  Redirect  )

static

Definition at line 233 of file mythhttpresponse.cpp.

Referenced by MythHTTPService::HTTPRequest().

ErrorResponse() [2/2]

HTTPResponse MythHTTPResponse::ErrorResponse ( const HTTPRequest2 &  Request, const QString &  Message = {}  )

static

Definition at line 243 of file mythhttpresponse.cpp.

OptionsResponse()

HTTPResponse MythHTTPResponse::OptionsResponse ( const HTTPRequest2 &  Request )

static

Definition at line 253 of file mythhttpresponse.cpp.

Referenced by HandleOptions().

DataResponse()

HTTPResponse MythHTTPResponse::DataResponse ( const HTTPRequest2 &  Request, const HTTPData &  Data  )

static

Definition at line 262 of file mythhttpresponse.cpp.

Referenced by MythWSDL::GetWSDL(), MythXSD::GetXSD(), MythHTTPService::HTTPRequest(), and MythHTTPRoot::RedirectRoot().

FileResponse()

HTTPResponse MythHTTPResponse::FileResponse ( const HTTPRequest2 &  Request, const HTTPFile &  File  )

static

Definition at line 273 of file mythhttpresponse.cpp.

Referenced by MythHTTPService::HTTPRequest(), and MythHTTPFile::ProcessFile().

EmptyResponse()

HTTPResponse MythHTTPResponse::EmptyResponse ( const HTTPRequest2 &  Request )

static

Definition at line 284 of file mythhttpresponse.cpp.

UpgradeResponse()

HTTPResponse MythHTTPResponse::UpgradeResponse ( const HTTPRequest2 &  Request, MythSocketProtocol &  Protocol, bool &  Testing  )

static

Definition at line 389 of file mythhttpresponse.cpp.

Referenced by MythHTTPSocket::Read().

Finalise()

void MythHTTPResponse::Finalise

(

const MythHTTPConfig &

Config

)

Complete all necessary headers, add final line break after headers, remove data etc.

Definition at line 34 of file mythhttpresponse.cpp.

AddHeader() [1/2]

template<class T >

std::enable_if_t<std::is_convertible_v<T, QString>, void> MythHTTPResponse::AddHeader ( const QString &  key, const T &  val  )

inline

Definition at line 35 of file mythhttpresponse.h.

Referenced by AddContentHeaders(), AddDefaultHeaders(), MythHTTPEncoding::Compress(), and Finalise().

AddHeader() [2/2]

template<class T >

std::enable_if_t<!std::is_convertible_v<T, QString>, void> MythHTTPResponse::AddHeader ( const QString &  key, T  val  )

inline

Definition at line 42 of file mythhttpresponse.h.

AddDefaultHeaders()

void MythHTTPResponse::AddDefaultHeaders ( )

protected

Definition at line 292 of file mythhttpresponse.cpp.

AddContentHeaders()

void MythHTTPResponse::AddContentHeaders ( )

protected

Definition at line 315 of file mythhttpresponse.cpp.

Member Data Documentation

m_serverName

QString MythHTTPResponse::m_serverName

Definition at line 48 of file mythhttpresponse.h.

Referenced by AddDefaultHeaders().

m_version

MythHTTPVersion MythHTTPResponse::m_version { HTTPOneDotOne }

Definition at line 49 of file mythhttpresponse.h.

Referenced by AddDefaultHeaders(), and MythHTTPEncoding::Compress().

m_connection

MythHTTPConnection MythHTTPResponse::m_connection { HTTPConnectionClose }

Definition at line 50 of file mythhttpresponse.h.

Referenced by AddDefaultHeaders().

m_timeout

std::chrono::milliseconds MythHTTPResponse::m_timeout { HTTP_SOCKET_TIMEOUT_MS }

Definition at line 51 of file mythhttpresponse.h.

Referenced by AddDefaultHeaders().

m_status

MythHTTPStatus MythHTTPResponse::m_status { HTTPBadRequest }

Definition at line 52 of file mythhttpresponse.h.

Referenced by AddContentHeaders(), AddDefaultHeaders(), MythHTTPRanges::BuildMultipartHeaders(), Finalise(), and MythHTTPRanges::HandleRangeRequest().

m_requestType

MythHTTPRequestType MythHTTPResponse::m_requestType { HTTPGet }

Definition at line 53 of file mythhttpresponse.h.

Referenced by Finalise().

m_allowed

int MythHTTPResponse::m_allowed { HTTP_DEFAULT_ALLOWED }

Definition at line 54 of file mythhttpresponse.h.

Referenced by Finalise().

m_requestHeaders

HTTPHeaders MythHTTPResponse::m_requestHeaders { nullptr }

Definition at line 55 of file mythhttpresponse.h.

Referenced by AddDefaultHeaders(), MythHTTPEncoding::Compress(), and Finalise().

m_responseHeaders

HTTPContents MythHTTPResponse::m_responseHeaders

Definition at line 56 of file mythhttpresponse.h.

Referenced by AddDefaultHeaders(), and Finalise().

m_response

HTTPVariant MythHTTPResponse::m_response { std::monostate() }

Definition at line 57 of file mythhttpresponse.h.

Referenced by AddContentHeaders(), MythHTTPRanges::BuildMultipartHeaders(), MythHTTPEncoding::Compress(), Finalise(), and MythHTTPRanges::HandleRangeRequest().

---

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

• mythtv/libs/libmythbase/http/mythhttpresponse.h
• mythtv/libs/libmythbase/http/mythhttpresponse.cpp