Inheritance diagram for Cutelyst::Request:

Signals
void	webSocketBinaryFrame (const QByteArray &message, bool isLastFrame, Cutelyst::Context *c)
	Emitted when the websocket receives a binary frame, this is usefull for parsing big chunks of data without waiting till the whole message arives.

void	webSocketBinaryMessage (const QByteArray &message, Cutelyst::Context *c)
	Emitted when the websocket receives a binary message, this accounts for all binary frames till the last one.

void	webSocketClosed (quint16 closeCode, const QString &reason)
	Emitted when the websocket receives a close frame, including a close code and a reason, it's also emitted when the connection closes without the client sending the close frame.

void	webSocketPong (const QByteArray &payload, Cutelyst::Context *c)
	Emitted when the websocket receives a pong frame, which might include a payload.

void	webSocketTextFrame (const QString &message, bool isLastFrame, Cutelyst::Context *c)
	Emitted when the websocket receives a text frame, this is usefull for parsing big chunks of data without waiting till the whole message arives.

void	webSocketTextMessage (const QString &message, Cutelyst::Context *c)
	Emitted when the websocket receives a text message, this accounts for all text frames till the last one.

Public Member Functions
	Request (EngineRequest *engineRequest)

QHostAddress	address () const noexcept

QString	addressString () const

QStringList	args () const

QStringList	arguments () const noexcept

QString	base () const

QIODevice *	body () const

QVariant	bodyData () const

QJsonArray	bodyJsonArray () const

QJsonDocument	bodyJsonDocument () const

QJsonObject	bodyJsonObject () const

QString	bodyParam (const QString &key, const QString &defaultValue={}) const

QString	bodyParameter (const QString &key, const QString &defaultValue={}) const

ParamsMultiMap	bodyParameters () const

QStringList	bodyParameters (const QString &key) const

QVariantMap	bodyParametersVariant () const

ParamsMultiMap	bodyParams () const

QStringList	bodyParams (const QString &key) const

QStringList	captures () const noexcept

QString	contentEncoding () const

QString	contentType () const

QString	cookie (const QString &name) const

ParamsMultiMap	cookies () const

QStringList	cookies (const QString &name) const

Engine *	engine () const noexcept

QString	header (const QString &key) const

Headers	headers () const noexcept

QString	hostname () const

bool	isDelete () const noexcept

bool	isGet () const noexcept

bool	isHead () const noexcept

bool	isPatch () const noexcept

bool	isPost () const noexcept

bool	isPut () const noexcept

ParamsMultiMap	mangleParams (const ParamsMultiMap &args, bool append=false) const

QString	match () const noexcept

QString	method () const noexcept

QString	path () const noexcept

quint16	port () const

QString	protocol () const noexcept

QString	queryKeywords () const

QString	queryParam (const QString &key, const QString &defaultValue={}) const

QString	queryParameter (const QString &key, const QString &defaultValue={}) const

ParamsMultiMap	queryParameters () const

QStringList	queryParameters (const QString &key) const

QVariantMap	queryParametersVariant () const

ParamsMultiMap	queryParams () const

QStringList	queryParams (const QString &key) const

QString	referer () const

QString	remoteUser () const noexcept

bool	secure () const noexcept

void	setArguments (const QStringList &arguments)

void	setCaptures (const QStringList &captures)

void	setMatch (const QString &match)

Upload *	upload (const QString &name) const

QVector< Upload * >	uploads () const

Uploads	uploads (const QString &name) const

QMultiMap< QString, Upload * >	uploadsMap () const

QUrl	uri () const

QUrl	uriWith (const ParamsMultiMap &args, bool append=false) const

QString	userAgent () const

bool	xhr () const noexcept

Properties
QStringList	args

QStringList	arguments

QString	base

QVariant	bodyData

Cutelyst::ParamsMultiMap	bodyParams

QString	contentEncoding

QString	contentType

QString	hostname

QString	match

QString	method

QString	path

quint16	port

QString	protocol

Cutelyst::ParamsMultiMap	queryParams

QString	referer

QString	remoteUser

bool	secure

QUrl	uri

QString	userAgent

Friends
class	Application

class	Context

class	Dispatcher

class	DispatchType

Detailed Description

Definition at line 29 of file request.h.

Constructor & Destructor Documentation

◆ ~Request()

Request::~Request ( )

virtual

Definition at line 26 of file request.cpp.

◆ Request()

Request::Request ( Cutelyst::EngineRequest * engineRequest )

Constructs a new Request object.

Definition at line 19 of file request.cpp.

References Cutelyst::EngineRequest::body.

Referenced by address(), addressString(), arguments(), base(), body(), bodyData(), bodyParameters(), captures(), cookie(), cookies(), cookies(), engine(), headers(), hostname(), isDelete(), isGet(), isHead(), isPatch(), isPost(), isPut(), match(), method(), path(), port(), protocol(), queryKeywords(), queryParameters(), remoteUser(), secure(), setArguments(), setCaptures(), setMatch(), uploads(), uploadsMap(), uri(), webSocketClosed(), and xhr().

Member Function Documentation

◆ address()

QHostAddress Request::address ( ) const

noexcept

Returns the address of the client

Definition at line 33 of file request.cpp.

References Request().

◆ addressString()

QString Request::addressString ( ) const

Returns the address as string of the client.

When using IPv6 sockets to listen to both IPv4 and IPv6 sockets the output of QHostAddress might be something like "::ffff:127.0.0.1", which is not a bug and a valid address, but from an application point of view this might not be interesting to have, so this function checks if it's possible to convert to an IPv4 address and returns "127.0.0.1".

Definition at line 39 of file request.cpp.

References Request().

◆ args()

QStringList Cutelyst::Request::args ( ) const

inline

Shortcut for arguments()

Definition at line 526 of file request.h.

◆ arguments()

QStringList Request::arguments ( ) const

noexcept

Returns a list of string containing the arguments. For example, if your action was

class foo : public Cutelyst::Controller
{
public:
  C_ATTR(bar, :Local)
  void bar(Context *c);
};

and the URI for the request was http://.../foo/bar/bah, the string bah would be the first and only argument.

Arguments get automatically URI-unescaped for you.

Definition at line 151 of file request.cpp.

References Request().

◆ base()

QString Request::base ( ) const

Returns Contains the URI base. This will always have a trailing slash. Note that the URI scheme (e.g., http vs. https) must be determined through heuristics; depending on your server configuration, it may be incorrect. See secure() for more info.

If your application was queried with the URI http://localhost:3000/some/path then base is http://localhost:3000/.

Definition at line 110 of file request.cpp.

References Request().

◆ body()

QIODevice * Request::body ( ) const

Returns the message body of the request as passed by the Engine, this can even be a file if the Engine wants to.

Definition at line 181 of file request.cpp.

References Request().

◆ bodyData()

QVariant Request::bodyData ( ) const

Returns a QVariant representation of POST/PUT body data that is not classic HTML form data, such as JSON, XML, etc. By default, Cutelyst will parse incoming data of the type 'application/json' and return access to that data via this method.

You may define addition data_handlers.

If the POST is malformed in some way (such as undefined or not content that matches the content-type) we return a null QVariant.

If the POSTed content type does not match an available data handler, this will also return a null QVariant.

Definition at line 187 of file request.cpp.

References Request().

◆ bodyJsonArray()

QJsonArray Request::bodyJsonArray ( ) const

When request Content-Type is 'application/json' this will contain the parsed JSON representation array.

Definition at line 206 of file request.cpp.

◆ bodyJsonDocument()

QJsonDocument Request::bodyJsonDocument ( ) const

When request Content-Type is 'application/json' this will contain the parsed JSON representation document.

Definition at line 196 of file request.cpp.

◆ bodyJsonObject()

QJsonObject Request::bodyJsonObject ( ) const

When request Content-Type is 'application/json' this will contain the parsed JSON representation object.

Definition at line 201 of file request.cpp.

◆ bodyParam()

QString Cutelyst::Request::bodyParam	(	const QString &	key,
		const QString &	defaultValue = {} ) const

inline

Convenience method for geting a single body value passing a key and an optional default value

Definition at line 541 of file request.h.

References bodyParameters().

◆ bodyParameter()

QString Cutelyst::Request::bodyParameter	(	const QString &	key,
		const QString &	defaultValue = {} ) const

inline

Convenience method for geting a single body value passing a key and an optional default value

Definition at line 531 of file request.h.

References bodyParameters().

◆ bodyParameters() [1/2]

ParamsMultiMap Request::bodyParameters ( ) const

Returns a Map of body (POST/PUT) parameters when content type is application/x-www-form-urlencoded

Definition at line 216 of file request.cpp.

References Request().

Referenced by bodyParam(), bodyParameter(), bodyParameters(), bodyParametersVariant(), bodyParams(), bodyParams(), and Cutelyst::Validator::validate().

◆ bodyParameters() [2/2]

QStringList Request::bodyParameters ( const QString & key ) const

Convenience method for geting all body values passing a key

Note: Unlike QMap::values() this return values in insertion order.

Definition at line 225 of file request.cpp.

References bodyParameters().

◆ bodyParametersVariant()

QVariantMap Request::bodyParametersVariant ( ) const

Returns a QVariantMap of body (POST/PUT) parameters, this method is expensive as it creates the map each time it's called, cache it's result instead of calling multiple times

Definition at line 211 of file request.cpp.

References bodyParameters().

◆ bodyParams() [1/2]

ParamsMultiMap Cutelyst::Request::bodyParams ( ) const

inline

Short for bodyParameters()

Definition at line 536 of file request.h.

References bodyParameters().

◆ bodyParams() [2/2]

QStringList Cutelyst::Request::bodyParams ( const QString & key ) const

inline

Convenience method for geting all body values passing a key

Note: Unlike QMap::values() this return values in insertion order.

Definition at line 546 of file request.h.

References bodyParameters().

◆ captures()

QStringList Request::captures ( ) const

noexcept

Captures

Definition at line 163 of file request.cpp.

References Request().

Referenced by Cutelyst::ActionChain::doExecute(), and setCaptures().

◆ contentEncoding()

QString Cutelyst::Request::contentEncoding ( ) const

inline

Returns the Content-Encoding header

Definition at line 571 of file request.h.

References Cutelyst::Headers::contentEncoding(), and headers().

◆ contentType()

QString Cutelyst::Request::contentType ( ) const

inline

Returns the Content-Type header

Definition at line 576 of file request.h.

References Cutelyst::Headers::contentType(), and headers().

◆ cookie()

QString Request::cookie ( const QString & name ) const

Returns the cookie with the given name

Definition at line 274 of file request.cpp.

References Request().

◆ cookies() [1/2]

Cutelyst::ParamsMultiMap Request::cookies ( ) const

Returns all the cookies from the request

Definition at line 301 of file request.cpp.

References Request().

◆ cookies() [2/2]

QStringList Request::cookies ( const QString & name ) const

Returns a list of cookies that match with the given name

Note: Unlike QMap::values() this return values in insertion order.

Definition at line 284 of file request.cpp.

References Request().

◆ engine()

Engine * Request::engine ( ) const

noexcept

Returns the current Engine processing the requests.

Definition at line 437 of file request.cpp.

References Request().

◆ header()

QString Cutelyst::Request::header ( const QString & key ) const

inline

Short for headers().header(key);

Definition at line 581 of file request.h.

References Cutelyst::Headers::header(), and headers().

◆ headers()

Headers Request::headers ( ) const

noexcept

Returns the HTTP request headers

Definition at line 310 of file request.cpp.

References Request().

Referenced by contentEncoding(), contentType(), header(), referer(), Cutelyst::ViewJson::render(), and userAgent().

◆ hostname()

QString Request::hostname ( ) const

Returns the hostname of the client, or null if not found or an error has happened.

This functions makes blocking call to do a reverse DNS lookup if the engine didn't set the hostname.

Definition at line 52 of file request.cpp.

References Request().

◆ isDelete()

bool Request::isDelete ( ) const

noexcept

Returns true if the request method is DELETE.

Definition at line 352 of file request.cpp.

References Request().

◆ isGet()

bool Request::isGet ( ) const

noexcept

Returns true if the request method is GET.

Definition at line 328 of file request.cpp.

References Request().

◆ isHead()

bool Request::isHead ( ) const

noexcept

Returns true if the request method is HEAD.

Definition at line 334 of file request.cpp.

References Request().

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

◆ isPatch()

bool Request::isPatch ( ) const

noexcept

Returns true if the request method is PATCH.

Definition at line 346 of file request.cpp.

References Request().

◆ isPost()

bool Request::isPost ( ) const

noexcept

Returns true if the request method is POST.

Definition at line 322 of file request.cpp.

References Request().

◆ isPut()

bool Request::isPut ( ) const

noexcept

Returns true if the request method is PUT.

Definition at line 340 of file request.cpp.

References Request().

◆ mangleParams()

ParamsMultiMap Request::mangleParams	(	const ParamsMultiMap &	args,
		bool	append = false ) const

Returns a ParamsMultiMap of parameters stemming from the current request's params, plus the ones supplied. Keys for which no current param exists will be added, keys with null values will be removed and keys with existing params will be replaced. Note that you can supply a true value as the final argument to change behavior with regards to existing parameters, appending values rather than replacing them.

A quick example:

// URI query params foo=1
ParamsMultiMap params = request->mangleParams({ {"foo", "2"} });
// Result is query params of foo=2

versus append mode:

// URI query params foo=1
ParamsMultiMap params = request->mangleParams({ {"foo", "2"} }, true);
// Result is query params of foo=1&foo=2

This is the code behind uriWith().

Definition at line 406 of file request.cpp.

Referenced by uriWith().

◆ match()

QString Request::match ( ) const

noexcept

This contains the matching part of a Regex action. Otherwise it returns the same as 'action' (not a pointer but it's private name), except for default actions, which return an empty string.

Definition at line 139 of file request.cpp.

References Request().

◆ method()

QString Request::method ( ) const

noexcept

Returns the request method (GET, POST, HEAD, etc).

Definition at line 316 of file request.cpp.

References Request().

◆ path()

QString Request::path ( ) const

noexcept

Returns the path, i.e. the part of the URI after base(), for the current request. for http://localhost/path/foo path will contain 'path/foo'

Definition at line 133 of file request.cpp.

References Request().

◆ port()

quint16 Request::port ( ) const

Returns the originating port of the client

Definition at line 75 of file request.cpp.

References Request().

◆ protocol()

QString Request::protocol ( ) const

noexcept

Returns the protocol (HTTP/1.0 or HTTP/1.1) used for the current request.

Definition at line 358 of file request.cpp.

References Request().

◆ queryKeywords()

QString Request::queryKeywords ( ) const

Contains the keywords portion of a query string, when no '=' signs are present.

http://localhost/path?some+keywords

c->request()->queryKeywords() will contain 'some keywords'

Definition at line 238 of file request.cpp.

References Request().

◆ queryParam()

QString Cutelyst::Request::queryParam	(	const QString &	key,
		const QString &	defaultValue = {} ) const

inline

Convenience method for geting a single query value passing a key and an optional default value

Definition at line 561 of file request.h.

References queryParameters().

Referenced by Cutelyst::StatusMessage::load().

◆ queryParameter()

QString Cutelyst::Request::queryParameter	(	const QString &	key,
		const QString &	defaultValue = {} ) const

inline

Convenience method for geting a single query value passing a key and an optional default value

Definition at line 551 of file request.h.

References queryParameters().

◆ queryParameters() [1/2]

ParamsMultiMap Request::queryParameters ( ) const

Returns a QMultiHash containing the query string parameters

Definition at line 252 of file request.cpp.

References Request().

Referenced by queryParam(), queryParameter(), queryParameters(), queryParametersVariant(), queryParams(), queryParams(), and Cutelyst::Validator::validate().

◆ queryParameters() [2/2]

QStringList Request::queryParameters ( const QString & key ) const

Convenience method for geting all query values passing a key

Note: Unlike QMap::values() this return values in insertion order.

Definition at line 261 of file request.cpp.

References queryParameters().

◆ queryParametersVariant()

QVariantMap Request::queryParametersVariant ( ) const

Returns a QVariantMap of query string parameters, this method is expensive as it creates the map each time it's called, cache it's result instead of calling multiple times

Definition at line 247 of file request.cpp.

References queryParameters().

◆ queryParams() [1/2]

ParamsMultiMap Cutelyst::Request::queryParams ( ) const

inline

Short for queryParameters()

Definition at line 556 of file request.h.

References queryParameters().

◆ queryParams() [2/2]

QStringList Cutelyst::Request::queryParams ( const QString & key ) const

inline

Convenience method for geting all query values passing a key

Note: Unlike QMap::values() this return values in insertion order.

Definition at line 566 of file request.h.

References queryParameters().

◆ referer()

QString Cutelyst::Request::referer ( ) const

inline

referer Shortcut for header("Referer")

Definition at line 591 of file request.h.

References headers(), and Cutelyst::Headers::referer().

◆ remoteUser()

QString Request::remoteUser ( ) const

noexcept

Returns the value of the REMOTE_USER environment variable.

Definition at line 371 of file request.cpp.

References Request().

◆ secure()

bool Request::secure ( ) const

noexcept

Returns true or false to indicate that a connection is secure (https), The reliability of it may depend on your server configuration, Cutelyst relies on the Engine to set this information which is used to build up uri().scheme(). The Engine itself might not be aware of a front HTTP server with https enabled.

Definition at line 175 of file request.cpp.

References Request().

◆ setArguments()

void Request::setArguments ( const QStringList & arguments )

Defines the arguments of the request Useful for custom dispatchers and/or actions

Definition at line 157 of file request.cpp.

References Request().

Referenced by Cutelyst::ActionChain::doExecute(), Cutelyst::DispatchTypeChained::match(), and Cutelyst::DispatchTypePath::match().

◆ setCaptures()

void Request::setCaptures ( const QStringList & captures )

Defines the arguments of the request Useful for custom dispatchers and/or actions

Definition at line 169 of file request.cpp.

References Request(), and captures().

Referenced by Cutelyst::DispatchTypeChained::match().

◆ setMatch()

void Request::setMatch ( const QString & match )

Defines the matching part of the request Useful for custom dispatchers

Definition at line 145 of file request.cpp.

References Request().

Referenced by Cutelyst::DispatchTypeChained::match(), and Cutelyst::DispatchTypePath::match().

◆ upload()

Upload * Cutelyst::Request::upload ( const QString & name ) const

inline

Returns the first Upload object for the given field, if no upload matches the field name this function returns 0.

Definition at line 596 of file request.h.

References uploadsMap().

◆ uploads() [1/2]

QVector< Upload * > Request::uploads ( ) const

Returns a vector containing uploads as provided by a multipart/form-data content type

Definition at line 377 of file request.cpp.

References Request().

◆ uploads() [2/2]

Uploads Request::uploads ( const QString & name ) const

Returns all (if any) Upload objects for the given field.

Definition at line 395 of file request.cpp.

References uploadsMap().

◆ uploadsMap()

QMultiMap< QString, Cutelyst::Upload * > Request::uploadsMap ( ) const

Returns a map containing uploads, where their key is the field name.

Definition at line 386 of file request.cpp.

References Request().

Referenced by upload(), and uploads().

◆ uri()

QUrl Request::uri ( ) const

Returns the uri as close as possible to what the user has in his browser url.

Definition at line 81 of file request.cpp.

References Request().

◆ uriWith()

QUrl Request::uriWith	(	const ParamsMultiMap &	args,
		bool	append = false ) const

Returns a rewritten URI object for the current request. Key/value pairs passed in will override existing parameters. You can remove an existing parameter by passing in an undef value. Unmodified pairs will be preserved.

You may also pass an optional second parameter that puts uriWith() into append mode:

req->uriWith({ {"key", "value"} }, true);

See mangleParams() for an explanation of this behavior.

Definition at line 422 of file request.cpp.

References mangleParams().

◆ userAgent()

QString Cutelyst::Request::userAgent ( ) const

inline

Returns the user agent (browser) version string.

Definition at line 586 of file request.h.

References headers(), and Cutelyst::Headers::userAgent().

◆ webSocketClosed

void Cutelyst::Request::webSocketClosed	(	quint16	closeCode,
		const QString &	reason )

signal

Note: This signal is NOT emitted when explicit calling

See also: Response::webSocketClose(). If you need to track when the connection was closed, the proper way is to rely on Context::destroyed() signal.

References Request().

◆ xhr()

bool Request::xhr ( ) const

noexcept

Returns true if the request's X-Requested-With header field is "XMLHttpRequest", indicating that the request was issued by a client library such as jQuery.

Definition at line 364 of file request.cpp.

References Request().

Friends And Related Symbol Documentation

◆ Application

friend class Application

friend

Definition at line 519 of file request.h.

◆ Context

friend class Context

friend

Definition at line 522 of file request.h.

◆ Dispatcher

friend class Dispatcher

friend

Definition at line 520 of file request.h.

◆ DispatchType

friend class DispatchType

friend

Definition at line 521 of file request.h.

Property Documentation

◆ args

QStringList Cutelyst::Request::args

read

Definition at line 39 of file request.h.

◆ arguments

QStringList Cutelyst::Request::arguments

read

Definition at line 38 of file request.h.

◆ base

QString Cutelyst::Request::base

read

Definition at line 35 of file request.h.

◆ bodyData

QVariant Cutelyst::Request::bodyData

read

Definition at line 41 of file request.h.

◆ bodyParams

Cutelyst::ParamsMultiMap Cutelyst::Request::bodyParams

read

Definition at line 42 of file request.h.

◆ contentEncoding

QString Cutelyst::Request::contentEncoding

read

Definition at line 44 of file request.h.

◆ contentType

QString Cutelyst::Request::contentType

read

Definition at line 45 of file request.h.

◆ hostname

QString Cutelyst::Request::hostname

read

Definition at line 32 of file request.h.

◆ match

QString Cutelyst::Request::match

read

Definition at line 37 of file request.h.

◆ method

QString Cutelyst::Request::method

read

Definition at line 46 of file request.h.

◆ path

QString Cutelyst::Request::path

read

Definition at line 36 of file request.h.

◆ port

quint16 Cutelyst::Request::port

read

Definition at line 33 of file request.h.

◆ protocol

QString Cutelyst::Request::protocol

read

Definition at line 47 of file request.h.

◆ queryParams

Cutelyst::ParamsMultiMap Cutelyst::Request::queryParams

read

Definition at line 43 of file request.h.

◆ referer

QString Cutelyst::Request::referer

read

Definition at line 49 of file request.h.

◆ remoteUser

QString Cutelyst::Request::remoteUser

read

Definition at line 50 of file request.h.

◆ secure

bool Cutelyst::Request::secure

read

Definition at line 40 of file request.h.

◆ uri

QUrl Cutelyst::Request::uri

read

Definition at line 34 of file request.h.

◆ userAgent

QString Cutelyst::Request::userAgent

read

Definition at line 48 of file request.h.

Signals

Public Member Functions

Properties

Friends

Detailed Description

Constructor & Destructor Documentation

◆ ~Request()

◆ Request()

Member Function Documentation

◆ address()

◆ addressString()

◆ args()

◆ arguments()

◆ base()

◆ body()

◆ bodyData()

◆ bodyJsonArray()

◆ bodyJsonDocument()

◆ bodyJsonObject()

◆ bodyParam()

◆ bodyParameter()

◆ bodyParameters() [1/2]

◆ bodyParameters() [2/2]

◆ bodyParametersVariant()

◆ bodyParams() [1/2]

◆ bodyParams() [2/2]

◆ captures()

◆ contentEncoding()

◆ contentType()

◆ cookie()

◆ cookies() [1/2]

◆ cookies() [2/2]

◆ engine()

◆ header()

◆ headers()

◆ hostname()

◆ isDelete()

◆ isGet()

◆ isHead()

◆ isPatch()

◆ isPost()

◆ isPut()

◆ mangleParams()

◆ match()

◆ method()

◆ path()

◆ port()

◆ protocol()

◆ queryKeywords()

◆ queryParam()

◆ queryParameter()

◆ queryParameters() [1/2]

◆ queryParameters() [2/2]

◆ queryParametersVariant()

◆ queryParams() [1/2]

◆ queryParams() [2/2]

◆ referer()

◆ remoteUser()

◆ secure()

◆ setArguments()

◆ setCaptures()

◆ setMatch()

◆ upload()

◆ uploads() [1/2]

◆ uploads() [2/2]

◆ uploadsMap()

◆ uri()

◆ uriWith()

◆ userAgent()

◆ webSocketClosed

◆ xhr()

Friends And Related Symbol Documentation

◆ Application

◆ Context

◆ Dispatcher

◆ DispatchType

Property Documentation

◆ args

◆ arguments

◆ base