Class defining fcgi request. More...

#include <qgsfcgiserverrequest.h>

Inheritance diagram for QgsFcgiServerRequest:

Public Member Functions
	QgsFcgiServerRequest ()

QByteArray	data () const override
	Returns post/put data Check for QByteArray::isNull() to check if data is available.

bool	hasError () const
	Returns `true` if an error occurred during initialization.

QString	header (const QString &name) const override
	Returns the header value.

Public Member Functions inherited from QgsServerRequest
	QgsServerRequest ()=default
	Constructor.

	QgsServerRequest (const QgsServerRequest &other)
	Copy constructor.

	QgsServerRequest (const QString &url, QgsServerRequest::Method method=QgsServerRequest::GetMethod, const QgsServerRequest::Headers &headers=QgsServerRequest::Headers())
	Constructor.

	QgsServerRequest (const QUrl &url, QgsServerRequest::Method method=QgsServerRequest::GetMethod, const QgsServerRequest::Headers &headers=QgsServerRequest::Headers())
	Constructor.

virtual	~QgsServerRequest ()=default
	destructor

QUrl	baseUrl () const
	Returns the base URL of QGIS server.

virtual QString	header (const RequestHeader &headerEnum) const
	Returns the header value.

QMap< QString, QString >	headers () const
	Returns the header map.

QgsServerRequest::Method	method () const

QgsServerRequest &	operator= (const QgsServerRequest &)=default

QUrl	originalUrl () const
	Returns the request url as seen by the web server, by default this is equal to the url seen by QGIS server.

QString	parameter (const QString &key, const QString &defaultValue=QString()) const
	Gets a parameter value.

QgsServerRequest::Parameters	parameters () const
	Returns a map of query parameters with keys converted to uppercase.

const QString	queryParameter (const QString &name, const QString &defaultValue=QString()) const
	Returns the query string parameter with the given name from the request URL, a defaultValue can be specified.

void	removeHeader (const QString &name)
	Remove an header.

virtual void	removeParameter (const QString &key)
	Remove a parameter.

QgsServerParameters	serverParameters () const
	Returns parameters.

void	setHeader (const QString &name, const QString &value)
	Set an header.

void	setMethod (QgsServerRequest::Method method)
	Set the request method.

virtual void	setParameter (const QString &key, const QString &value)
	Set a parameter.

virtual void	setUrl (const QUrl &url)
	Set the request url.

QUrl	url () const

Additional Inherited Members
Public Types inherited from QgsServerRequest
typedef QMap< QString, QString >	Headers

enum	Method { HeadMethod , PutMethod , GetMethod , PostMethod , DeleteMethod , PatchMethod }
	HTTP Method (or equivalent) used for the request. More...

typedef QMap< QString, QString >	Parameters

enum	RequestHeader { HOST , FORWARDED , X_FORWARDED_FOR , X_FORWARDED_HOST , X_FORWARDED_PROTO , X_QGIS_SERVICE_URL , X_QGIS_WMS_SERVICE_URL , X_QGIS_WFS_SERVICE_URL , X_QGIS_WCS_SERVICE_URL , X_QGIS_WMTS_SERVICE_URL , ACCEPT , USER_AGENT , AUTHORIZATION }
	The internal HTTP Header used for the request as enum. More...

Static Public Member Functions inherited from QgsServerRequest
static QString	methodToString (const Method &method)
	Returns a string representation of an HTTP request method.

Protected Member Functions inherited from QgsServerRequest
void	setBaseUrl (const QUrl &url)
	Set the base URL of QGIS server.

void	setOriginalUrl (const QUrl &url)
	Set the request original url (the request url as seen by the web server)

Detailed Description

Class defining fcgi request.

Definition at line 31 of file qgsfcgiserverrequest.h.

Constructor & Destructor Documentation

◆ QgsFcgiServerRequest()

QgsFcgiServerRequest::QgsFcgiServerRequest ( )

Definition at line 28 of file qgsfcgiserverrequest.cpp.

Member Function Documentation

◆ data()

QByteArray QgsFcgiServerRequest::data ( ) const

overridevirtual

Returns post/put data Check for QByteArray::isNull() to check if data is available.

Reimplemented from QgsServerRequest.

Definition at line 163 of file qgsfcgiserverrequest.cpp.

◆ hasError()

bool QgsFcgiServerRequest::hasError ( ) const

inline

Returns true if an error occurred during initialization.

Definition at line 41 of file qgsfcgiserverrequest.h.

◆ header()

QString QgsFcgiServerRequest::header ( const QString & name ) const

overridevirtual

Returns the header value.

Parameters

name	of the header

Returns: the header value or an empty string

Since: QGIS 3.20

Reimplemented from QgsServerRequest.

Definition at line 266 of file qgsfcgiserverrequest.cpp.

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

/build/qgis-3.36.0+99sid/src/server/qgsfcgiserverrequest.h
/build/qgis-3.36.0+99sid/src/server/qgsfcgiserverrequest.cpp

Public Member Functions