A Cutelyst response. More...

#include <Cutelyst/Response>

Inheritance diagram for Cutelyst::Response:

Public Types
enum	CloseCode { CloseCodeNormal , CloseCodeGoingAway , CloseCodeProtocolError , CloseCodeDatatypeNotSupported , CloseCodeReserved1004 , CloseCodeMissingStatusCode , CloseCodeAbnormalDisconnection , CloseCodeWrongDatatype , CloseCodePolicyViolated , CloseCodeTooMuchData , CloseCodeMissingExtension , CloseCodeBadOperation , CloseCodeTlsHandshakeFailed }
enum	HttpStatus { Continue , SwitchingProtocols , OK , Created , Accepted , NonAuthoritativeInformation , NoContent , ResetContent , PartialContent , MultiStatus , MultipleChoices , MovedPermanently , Found , SeeOther , NotModified , UseProxy , TemporaryRedirect , PermanentRedirect , BadRequest , Unauthorized , PaymentRequired , Forbidden , NotFound , MethodNotAllowed , NotAcceptable , ProxyAuthenticationRequired , RequestTimeout , Conflict , Gone , LengthRequired , PreconditionFailed , RequestEntityTooLarge , RequestURITooLong , UnsupportedMediaType , RequestedRangeNotSatisfiable , ExpectationFailed , InternalServerError , NotImplemented , BadGateway , ServiceUnavailable , GatewayTimeout , HTTPVersionNotSupported , BandwidthLimitExceeded }

Public Member Functions
virtual	~Response () override
QByteArray &	body ()
QIODevice *	bodyDevice () const noexcept
QByteArray	contentEncoding () const noexcept
qint64	contentLength () const
QByteArray	contentType () const
QByteArray	contentTypeCharset () const
QVariant	cookie (const QByteArray &name) const
QList< QNetworkCookie >	cookies () const
bool	hasBody () const noexcept
QByteArray	header (const QByteArray &field) const noexcept
Headers &	headers () noexcept
bool	isFinalizedHeaders () const noexcept
bool	isSequential () const noexcept override
QUrl	location () const noexcept
void	redirect (const QString &url, quint16 status=Found)
void	redirect (const QUrl &url, quint16 status=Found)
void	redirectSafe (const QUrl &url, const QUrl &fallback)
int	removeCookies (const QByteArray &name)
void	setBody (const QByteArray &body)
void	setBody (const QString &body)
void	setBody (QIODevice *body)
void	setBody (QStringView body)
void	setCborBody (const QByteArray &cbor)
void	setCborValueBody (const QCborValue &value)
void	setContentEncoding (const QByteArray &encoding)
void	setContentLength (qint64 length)
void	setContentType (const QByteArray &type)
void	setCookie (const QNetworkCookie &cookie)
void	setCookies (const QList< QNetworkCookie > &cookies)
void	setHeader (const QByteArray &key, const QByteArray &value)
void	setJsonArrayBody (const QJsonArray &array)
void	setJsonBody (const QByteArray &json)
void	setJsonBody (QStringView json)
void	setJsonObjectBody (const QJsonObject &obj)
void	setStatus (quint16 status) noexcept
qint64	size () const noexcept override
quint16	status () const noexcept
bool	webSocketBinaryMessage (const QByteArray &message)
bool	webSocketClose (quint16 code=Response::CloseCodeNormal, const QString &reason={})
bool	webSocketHandshake (const QByteArray &key={}, const QByteArray &origin={}, const QByteArray &protocol={})
bool	webSocketPing (const QByteArray &payload={})
bool	webSocketTextMessage (const QString &message)

Protected Member Functions
	Response (const Headers &defaultHeaders, EngineRequest *conn=nullptr)
virtual qint64	readData (char *data, qint64 maxlen) override
virtual qint64	writeData (const char *data, qint64 len) override

Friends
class	Application
class	Context
class	ContextPrivate
class	Engine
class	EngineConnection

Detailed Description

A Cutelyst response contains the data created by your application that should be send back to the requesting client.

Definition at line 28 of file response.h.

Member Enumeration Documentation

◆ CloseCode

enum Cutelyst::Response::CloseCode

This enum type specifies the status response to be sent to the client

Definition at line 82 of file response.h.

◆ HttpStatus

enum Cutelyst::Response::HttpStatus

This enum type specifies the status response to be sent to the client

Definition at line 34 of file response.h.

Constructor & Destructor Documentation

◆ ~Response()

Response::~Response ( )

overridevirtual

Destroys the Response object.

Definition at line 61 of file response.cpp.

◆ Response()

Response::Response	(	const Headers &	defaultHeaders,
		EngineRequest *	conn = nullptr )

explicitprotected

Constructs a Response object, for engine request conn with defaultHeaders.

Definition at line 20 of file response.cpp.

Referenced by body(), bodyDevice(), contentEncoding(), contentLength(), contentType(), contentTypeCharset(), cookie(), cookies(), hasBody(), headers(), location(), redirect(), removeCookies(), setBody(), setBody(), setCborBody(), setContentEncoding(), setContentLength(), setCookie(), setCookies(), setJsonBody(), setStatus(), size(), status(), webSocketTextMessage(), and writeData().

Member Function Documentation

◆ body()

QByteArray & Response::body ( )

nodiscard

This function returns a reference to a QByteArray which implicity sets the body device to a QBuffer, even if one was already set.

Definition at line 86 of file response.cpp.

References Response().

Referenced by Cutelyst::EngineRequest::finalizeBody(), setBody(), and setBody().

◆ bodyDevice()

QIODevice * Response::bodyDevice ( ) const

noexcept

Returns the body IO device (if any) of this response.

Definition at line 98 of file response.cpp.

References Response().

Referenced by Cutelyst::EngineRequest::finalizeBody().

◆ contentEncoding()

QByteArray Response::contentEncoding ( ) const

noexcept

Short for headers().contentEncoding();

See also: Headers::contentEncoding(); setContentEncoding()

Definition at line 155 of file response.cpp.

References Response().

◆ contentLength()

qint64 Response::contentLength ( ) const

Short for headers().contentLength();

See also: Headers::contentLength(); setContentLength()

Definition at line 172 of file response.cpp.

References Response().

◆ contentType()

QByteArray Response::contentType ( ) const

Short for headers().contentType();

See also: Headers::contentType(); setContentType()

Definition at line 189 of file response.cpp.

References Response().

Referenced by Cutelyst::RenderView::doExecute().

◆ contentTypeCharset()

QByteArray Response::contentTypeCharset ( ) const

Short for headers().contentTypeCharset();

See also: Headers::contentTypeCharset()

Definition at line 195 of file response.cpp.

References Response().

◆ cookie()

QVariant Response::cookie ( const QByteArray & name ) const

Returns the first QNetworkCookie matching the name or a null QVariant if not found.

Definition at line 201 of file response.cpp.

References Response().

Referenced by setCookie(), and setCookies().

◆ cookies()

QList< QNetworkCookie > Response::cookies ( ) const

Returns a list of all cookies set.

Definition at line 207 of file response.cpp.

References Response().

Referenced by Cutelyst::EngineRequest::finalizeCookies(), and setCookies().

◆ hasBody()

bool Response::hasBody ( ) const

noexcept

Returns true if a body device has been defined as QByteArray or QIODevice or write() was called and it's on chunked mode.

Definition at line 79 of file response.cpp.

References Response().

Referenced by Cutelyst::RenderView::doExecute().

◆ header()

QByteArray Response::header ( const QByteArray & field ) const

noexcept

Shortcut headers().header()

See also: Headers::header()

Definition at line 277 of file response.cpp.

◆ headers()

Headers & Response::headers ( )

noexcept

Returns a reference to the response headers class.

Definition at line 294 of file response.cpp.

References Response().

Referenced by Cutelyst::EngineRequest::finalizeCookies(), Cutelyst::EngineRequest::finalizeHeaders(), Cutelyst::UA::forwardAsync(), Cutelyst::UA::forwardRequestResponse(), and setContentType().

◆ isFinalizedHeaders()

bool Response::isFinalizedHeaders ( ) const

noexcept

Returns true if Headers are finalized (sent to the client).

Definition at line 300 of file response.cpp.

◆ isSequential()

bool Response::isSequential ( ) const

overridenoexcept

Writing to user-agent is always sequential.

Definition at line 306 of file response.cpp.

◆ location()

QUrl Response::location ( ) const

noexcept

Returns the HTTP location set by the redirect

Definition at line 271 of file response.cpp.

References Response().

Referenced by redirect().

◆ readData()

qint64 Response::readData	(	char *	data,
		qint64	maxlen )

overrideprotectedvirtual

Reimplemented from QIODevice::readData().

Definition at line 26 of file response.cpp.

◆ redirect() [1/2]

void Response::redirect	(	const QString &	url,
		quint16	status = Found )

Causes the response to redirect to the specified URL. The default status is 302. This is a convenience method that sets the Location header to the redirect destination, and then sets the response status. You will want to return false or c->detach() to interrupt the normal processing flow if you want the redirect to occur straight away.

Note: Do not give a relative URL as $url, i.e: one that is not fully qualified ("http://...", etc.) or that starts with a slash "/path/here". While it may work, it is not guaranteed to do the right thing and is not a standard behaviour. You may opt to use uriFor() or uriForAction() instead.

Definition at line 255 of file response.cpp.

◆ redirect() [2/2]

void Response::redirect	(	const QUrl &	url,
		quint16	status = Found )

Causes the response to redirect to the specified URL. The default status is 302. This is a convenience method that sets the Location header to the redirect destination, and then sets the response status. You will want to return false or c->detach() to interrupt the normal processing flow if you want the redirect to occur straight away.

Note: Do not give a relative URL as $url, i.e: one that is not fully qualified ("http://...", etc.) or that starts with a slash "/path/here". While it may work, it is not guaranteed to do the right thing and is not a standard behaviour. You may opt to use uriFor() or uriForAction() instead.

Definition at line 233 of file response.cpp.

References Response(), location(), and status().

Referenced by Cutelyst::LangSelect::fromPath().

◆ redirectSafe()

void Response::redirectSafe	(	const QUrl &	url,
		const QUrl &	fallback )

Open Redirect Vulnerability is when you get an user provided URL and redirect to it without checking if it's safe.

This can be used on login forms that receive some "redir" parameter that once logged in allows the user to go straight to that page instead of some home page.

It's then possible to receive a link like http://example.com/login?redir=http://exemple.com/login notice how both domain names are similar for malicious porpuses, once logged in it redirects to a similar login page that will pretent the auth didn't work, user might then type their credentials on that page.

This method validades that the url scheme, domain name and port are the same of the request to your server if it isn't it will send the user to fallback url that you know it's safe. If you need to redirect the user to some other domain/port validate the URL manually an use the regular

See also: redirect method instead.

Definition at line 260 of file response.cpp.

References status().

◆ removeCookies()

int Response::removeCookies ( const QByteArray & name )

Removes all cookies that matches name, returning the number of cookies removed

Definition at line 227 of file response.cpp.

References Response().

◆ setBody() [1/4]

void Response::setBody ( const QByteArray & body )

Sets a QByteArray as the response body, content length will be automatically set to it's size.

Definition at line 120 of file response.cpp.

References Response(), and body().

◆ setBody() [2/4]

void Cutelyst::Response::setBody ( const QString & body )

inline

Sets a QString as the response body, the output will be UTF-8 and content length will be automatically set to it's size.

Definition at line 430 of file response.h.

References setBody().

◆ setBody() [3/4]

void Response::setBody ( QIODevice * body )

Sets an IO device as the response body, the open mode must be at least QIODevice::ReadOnly. This function takes ownership of your device deleting after the request has completed.

Definition at line 104 of file response.cpp.

References Response(), and body().

Referenced by Cutelyst::EngineRequest::finalizeError(), Cutelyst::UA::forwardAsync(), Cutelyst::UA::forwardRequestResponse(), Cutelyst::CuteleeView::render(), setBody(), and setBody().

◆ setBody() [4/4]

void Cutelyst::Response::setBody ( QStringView body )

inline

Sets a QString as the response body, the output will be UTF-8 and content length will be automatically set to it's size.

Definition at line 435 of file response.h.

References setBody().

◆ setCborBody()

void Response::setCborBody ( const QByteArray & cbor )

Sets a CBOR data as the response body, this method is provided for convenience as it sets the content-type to application/cbor.

Definition at line 126 of file response.cpp.

References Response().

Referenced by setCborValueBody().

◆ setCborValueBody()

void Response::setCborValueBody ( const QCborValue & value )

Sets a CBOR value without transformation as the response body, this method is provided for convenience as it sets the content-type to application/json.

Definition at line 133 of file response.cpp.

References setCborBody().

◆ setContentEncoding()

void Cutelyst::Response::setContentEncoding ( const QByteArray & encoding )

Short for headers().setContentEncoding(encoding);

See also: Headers::setContentEncoding(); contentEncoding()

Definition at line 161 of file response.cpp.

References Response().

◆ setContentLength()

void Response::setContentLength ( qint64 length )

Short for headers().setContentLength(length);

See also: Headers::setContentLength(); contentLength()

Definition at line 178 of file response.cpp.

References Response().

◆ setContentType()

void Cutelyst::Response::setContentType ( const QByteArray & type )

inline

Short for headers().setContentType(type);

See also: Headers::setContentType(); contentType()

Definition at line 238 of file response.h.

References headers(), and setContentType().

Referenced by Cutelyst::RenderView::doExecute(), Cutelyst::EngineRequest::finalizeError(), Cutelyst::ViewJson::render(), and setContentType().

◆ setCookie()

void Response::setCookie ( const QNetworkCookie & cookie )

Defines a QNetworkCookie to be sent to the user-agent, if a previous cookie->name() was set it will be replaced.

Definition at line 213 of file response.cpp.

References Response(), and cookie().

◆ setCookies()

void Response::setCookies ( const QList< QNetworkCookie > & cookies )

Defines a list of QNetworkCookie to be sent to the user-agent, all previous matches to cookie->name() will be preserved.

Definition at line 219 of file response.cpp.

References Response(), cookie(), and cookies().

◆ setHeader()

void Response::setHeader	(	const QByteArray &	key,
		const QByteArray &	value )

Shortcut headers().setHeader()

See also: Headers::setHeader()

Definition at line 283 of file response.cpp.

Referenced by Cutelyst::ViewJson::render().

◆ setJsonArrayBody()

void Response::setJsonArrayBody ( const QJsonArray & array )

Sets a QJsonArray array on a QJsonDocument as the response body, using toJson(QJsonDocument::Compact) output and setting content-type to application/json.

Definition at line 150 of file response.cpp.

References setJsonBody().

◆ setJsonBody() [1/2]

void Response::setJsonBody ( const QByteArray & json )

Sets a JSON string as the response body, this method is provided for convenience as it sets the content-type to application/json.

Definition at line 138 of file response.cpp.

References Response().

◆ setJsonBody() [2/2]

void Cutelyst::Response::setJsonBody ( QStringView json )

inline

Sets a JSON string as the response body, this method is provided for convenience as it sets the content-type to application/json.

Definition at line 440 of file response.h.

References setJsonBody().

Referenced by setJsonArrayBody(), setJsonBody(), and setJsonObjectBody().

◆ setJsonObjectBody()

void Response::setJsonObjectBody ( const QJsonObject & obj )

Sets a QJsonObject obj on a QJsonDocument as the response body, using toJson(QJsonDocument::Compact) output and setting content-type to application/json.

Definition at line 145 of file response.cpp.

References setJsonBody().

◆ setStatus()

void Response::setStatus ( quint16 status )

noexcept

Sets the response code status.

Definition at line 73 of file response.cpp.

References Response(), and status().

Referenced by Cutelyst::RenderView::doExecute(), Cutelyst::EngineRequest::finalizeError(), Cutelyst::UA::forwardAsync(), and Cutelyst::UA::forwardRequestResponse().

◆ size()

qint64 Response::size ( ) const

overridenoexcept

Reimplemented from QIODevice::readData().

Definition at line 311 of file response.cpp.

References Response().

Referenced by Cutelyst::EngineRequest::finalizeHeaders().

◆ status()

quint16 Response::status ( ) const

noexcept

The current response code status.

Definition at line 67 of file response.cpp.

References Response().

Referenced by Cutelyst::RenderView::doExecute(), Cutelyst::EngineRequest::finalizeHeaders(), redirect(), redirectSafe(), and setStatus().

◆ webSocketBinaryMessage()

bool Response::webSocketBinaryMessage ( const QByteArray & message )

Sends a WebSocket binary message.

Definition at line 337 of file response.cpp.

◆ webSocketClose()

bool Response::webSocketClose	(	quint16	code = Response::CloseCodeNormal,
		const QString &	reason = {} )

Sends a WebSocket close frame, with both optional close code and a string reason.

Note: This method does not emit Request::webSocketClosed() signal. If you need to track when the connection was closed, the proper way is to rely on Context::destroyed() signal.

Definition at line 349 of file response.cpp.

◆ webSocketHandshake()

bool Response::webSocketHandshake	(	const QByteArray &	key = {},
		const QByteArray &	origin = {},
		const QByteArray &	protocol = {} )

Sends the websocket handshake, if no parameters are defined it will use header data. Returns true in case of success, false otherwise, which can be due missing support on the engine or missing the appropriate headers.

Note: Most WebSockets client doesn't handle when a call to a WebSocket endpoint ends on an HTTP authentication failure or other HTTP status that is not the update. Due that it's best to always do the proper websocket handshake and then

See also: webSocketClose() the connection, with some meaning reason.

Definition at line 323 of file response.cpp.

◆ webSocketPing()

bool Response::webSocketPing ( const QByteArray & payload = {} )

Sends a WebSocket ping with an optional payload limited to 125 bytes, which will be truncated if larger.

Note: Some front-end servers will close the connection if no activity is seem, NGINX closes in 60 seconds by default, in order to avoid that, sending a ping is the best to way to keep the connection alive and to know that your client is still there.

Definition at line 343 of file response.cpp.

◆ webSocketTextMessage()

bool Response::webSocketTextMessage ( const QString & message )

Sends a WebSocket text message.

Definition at line 331 of file response.cpp.

References Response().

◆ writeData()

qint64 Response::writeData	(	const char *	data,
		qint64	len )

overrideprotectedvirtual

Writes data to the response body, this will flush all response headers first and will enter in chunked mode if Transfer-Encoding header is set to chunked or if no content length is set and status is not 1xx or 204 (NoContent) or 304 (NotModified)

Definition at line 33 of file response.cpp.

References Response().

◆ Application

friend class Application

friend

Definition at line 423 of file response.h.

◆ Context

friend class Context

friend

Definition at line 426 of file response.h.

◆ ContextPrivate

friend class ContextPrivate

friend

Definition at line 427 of file response.h.

◆ Engine

friend class Engine

friend

Definition at line 424 of file response.h.

◆ EngineConnection

friend class EngineConnection

friend

Definition at line 425 of file response.h.

Public Types

Public Member Functions

Protected Member Functions

Friends

Detailed Description

Member Enumeration Documentation

◆ CloseCode

◆ HttpStatus

Constructor & Destructor Documentation

◆ ~Response()

◆ Response()

Member Function Documentation

◆ body()

◆ bodyDevice()

◆ contentEncoding()

◆ contentLength()

◆ contentType()

◆ contentTypeCharset()

◆ cookie()

◆ cookies()

◆ hasBody()

◆ header()

◆ headers()

◆ isFinalizedHeaders()

◆ isSequential()

◆ location()

◆ readData()

◆ redirect() [1/2]

◆ redirect() [2/2]

◆ redirectSafe()

◆ removeCookies()

◆ setBody() [1/4]

◆ setBody() [2/4]

◆ setBody() [3/4]

◆ setBody() [4/4]

◆ setCborBody()

◆ setCborValueBody()

◆ setContentEncoding()

◆ setContentLength()

◆ setContentType()

◆ setCookie()

◆ setCookies()

◆ setHeader()

◆ setJsonArrayBody()

◆ setJsonBody() [1/2]

◆ setJsonBody() [2/2]

◆ setJsonObjectBody()

◆ setStatus()

◆ size()

◆ status()

◆ webSocketBinaryMessage()

◆ webSocketClose()

◆ webSocketHandshake()

◆ webSocketPing()

◆ webSocketTextMessage()

◆ writeData()

Friends And Related Symbol Documentation

◆ Application

◆ Context

◆ ContextPrivate

◆ Engine

◆ EngineConnection