A decorator for calling filter's hooks. More...

#include <qgsfilterresponsedecorator.h>

Inheritance diagram for QgsFilterResponseDecorator:

Public Member Functions
	QgsFilterResponseDecorator (QgsServerFiltersMap filters, QgsServerResponse &response)
	Constructor for QgsFilterResponseDecorator.
void	addHeader (const QString &key, const QString &value) override
	Add a header value for the given key, without replacing any existing value for the same key Add Header entry to the response.
void	clear () override
	Reset all headers and content for this response.
QByteArray	data () const override
	Gets the data written so far.
QgsFeedback *	feedback () const override
	Returns the socket feedback if any.
void	finish () override
	Finish the response, ending the transaction.
void	flush () override
	Flushes the current output buffer to the network.
virtual QList< QString >	fullHeader (const QString &key) const override
	Returns a (possibly empty) list of all the header values for the given key.
virtual QMap< QString, QList< QString > >	fullHeaders () const override
	Returns all the header values.
Q_DECL_DEPRECATED QString	header (const QString &key) const override
	Returns a single header value for a given key.
Q_DECL_DEPRECATED QMap< QString, QString >	headers () const override
	Returns the header values as a map: only the last value is returned if multiple values are set for the same header.
bool	headersSent () const override
	Returns `true` if the headers have already been sent.
QIODevice *	io () override
	Returns the underlying QIODevice.
void	ready ()
	Call filters projectReady() method.
void	removeHeader (const QString &key) override
	Clear all header values for the given key Undo a previous 'setHeader' call.
void	sendError (int code, const QString &message) override
	Send error This method delegates error handling at the server level.
void	setHeader (const QString &key, const QString &value) override
	Set a single header value replacing any existing value(s) for the same key.
void	setStatusCode (int code) override
	Set the http status code.
void	start ()
	Call filters requestReady() method.
int	statusCode () const override
	Returns the http status code.
void	truncate () override
	Truncate data.
Public Member Functions inherited from QgsServerResponse
	QgsServerResponse ()=default
virtual	~QgsServerResponse ()=default
virtual qint64	write (const char *data)
	Writes at most maxSize bytes of data.
virtual qint64	write (const char *data, qint64 maxsize)
	Writes at most maxSize bytes of data.
virtual qint64	write (const QByteArray &byteArray)
	Write chunk of data This is a convenient method that will write directly to the underlying I/O device.
virtual void	write (const QgsServerException &ex)
	Write server exception.
virtual void	write (const QString &data)
	Write string This is a convenient method that will write directly to the underlying I/O device.
virtual qint64	write (std::string data)
	Writes at most maxSize bytes of data.

Detailed Description

A decorator for calling filter's hooks.

Definition at line 34 of file qgsfilterresponsedecorator.h.

Constructor & Destructor Documentation

◆ QgsFilterResponseDecorator()

QgsFilterResponseDecorator::QgsFilterResponseDecorator	(	QgsServerFiltersMap	filters,
		QgsServerResponse &	response )

Constructor for QgsFilterResponseDecorator.

Parameters

filters	Map of filters to apply before terminating the response
response	Server response

Definition at line 23 of file qgsfilterresponsedecorator.cpp.

Member Function Documentation

◆ addHeader()

void QgsFilterResponseDecorator::addHeader	(	const QString &	key,
		const QString &	value )

inlineoverridevirtual

Add a header value for the given key, without replacing any existing value for the same key Add Header entry to the response.

Note: that it is usually an error to set Header after data have been sent through the wire

See also: setHeader() for a method that replaces any existing value(s) for the same header key

Since: QGIS 4.2

Implements QgsServerResponse.

Definition at line 59 of file qgsfilterresponsedecorator.h.

◆ clear()

void QgsFilterResponseDecorator::clear ( )

inlineoverridevirtual

Reset all headers and content for this response.

Implements QgsServerResponse.

Definition at line 95 of file qgsfilterresponsedecorator.h.

◆ data()

QByteArray QgsFilterResponseDecorator::data ( ) const

inlineoverridevirtual

Gets the data written so far.

This is implementation dependent: some implementations may not give access to the underlying and return an empty array.

Note that each call to 'flush' may empty the buffer and in case of streaming process you may get partial content

Implements QgsServerResponse.

Definition at line 97 of file qgsfilterresponsedecorator.h.

◆ feedback()

QgsFeedback * QgsFilterResponseDecorator::feedback ( ) const

inlineoverridevirtual

Returns the socket feedback if any.

Since: QGIS 3.36

Reimplemented from QgsServerResponse.

Definition at line 101 of file qgsfilterresponsedecorator.h.

◆ finish()

void QgsFilterResponseDecorator::finish ( )

overridevirtual

Finish the response, ending the transaction.

The default implementation does nothing.

Reimplemented from QgsServerResponse.

Definition at line 54 of file qgsfilterresponsedecorator.cpp.

◆ flush()

void QgsFilterResponseDecorator::flush ( )

overridevirtual

Flushes the current output buffer to the network.

'flush()' may be called multiple times. For HTTP transactions headers will be written on the first call to 'flush()'. The default implementation does nothing.

Reimplemented from QgsServerResponse.

Definition at line 71 of file qgsfilterresponsedecorator.cpp.

◆ fullHeader()

virtual QList< QString > QgsFilterResponseDecorator::fullHeader ( const QString & key ) const

inlineoverridevirtual

Returns a (possibly empty) list of all the header values for the given key.

See also: header() to get only the last value for a given header key

Since: QGIS 4.2

Implements QgsServerResponse.

Definition at line 77 of file qgsfilterresponsedecorator.h.

◆ fullHeaders()

virtual QMap< QString, QList< QString > > QgsFilterResponseDecorator::fullHeaders ( ) const

inlineoverridevirtual

Returns all the header values.

See also: headers() to get only the last value for each header key

Since: QGIS 4.2

Implements QgsServerResponse.

Definition at line 79 of file qgsfilterresponsedecorator.h.

◆ header()

Q_DECL_DEPRECATED QString QgsFilterResponseDecorator::header ( const QString & key ) const

inlineoverridevirtual

Returns a single header value for a given key.

Note: if multiple values are set for the same key, the last one is returned

Deprecated: QGIS 4.2. Use fullHeader() instead.

Implements QgsServerResponse.

Definition at line 63 of file qgsfilterresponsedecorator.h.

◆ headers()

Q_DECL_DEPRECATED QMap< QString, QString > QgsFilterResponseDecorator::headers ( ) const

inlineoverridevirtual

Returns the header values as a map: only the last value is returned if multiple values are set for the same header.

See also: fullHeaders() to get all the values for all the headers

Deprecated: QGIS 4.2. Use fullHeaders() instead.

Implements QgsServerResponse.

Definition at line 70 of file qgsfilterresponsedecorator.h.

◆ headersSent()

bool QgsFilterResponseDecorator::headersSent ( ) const

inlineoverridevirtual

Returns true if the headers have already been sent.

Implements QgsServerResponse.

Definition at line 81 of file qgsfilterresponsedecorator.h.

◆ io()

QIODevice * QgsFilterResponseDecorator::io ( )

inlineoverridevirtual

Returns the underlying QIODevice.

Implements QgsServerResponse.

Definition at line 89 of file qgsfilterresponsedecorator.h.

◆ ready()

void QgsFilterResponseDecorator::ready ( )

Call filters projectReady() method.

Since: QGIS 3.36

Definition at line 41 of file qgsfilterresponsedecorator.cpp.

◆ removeHeader()

void QgsFilterResponseDecorator::removeHeader ( const QString & key )

inlineoverridevirtual

Clear all header values for the given key Undo a previous 'setHeader' call.

Implements QgsServerResponse.

Definition at line 61 of file qgsfilterresponsedecorator.h.

◆ sendError()

void QgsFilterResponseDecorator::sendError	(	int	code,
		const QString &	message )

inlineoverridevirtual

Send error This method delegates error handling at the server level.

This is different from calling setReturnCode() which let you return a specific response body. Calling sendError() will end the transaction and any attempt to write data or set headers will be an error.

Parameters

code	HHTP return code value
message	An informative error message

Implements QgsServerResponse.

Definition at line 87 of file qgsfilterresponsedecorator.h.

◆ setHeader()

void QgsFilterResponseDecorator::setHeader	(	const QString &	key,
		const QString &	value )

inlineoverridevirtual

Set a single header value replacing any existing value(s) for the same key.

Note: that it is usually an error to set Header after data have been sent through the wire

See also: addHeader() for a method that allows setting multiple values for the same header key; removeHeader() to clear header values for a given key

Implements QgsServerResponse.

Definition at line 57 of file qgsfilterresponsedecorator.h.

◆ setStatusCode()

void QgsFilterResponseDecorator::setStatusCode ( int code )

inlineoverridevirtual

Set the http status code.

Parameters

code	HTTP status code value

Implements QgsServerResponse.

Definition at line 83 of file qgsfilterresponsedecorator.h.

◆ start()

void QgsFilterResponseDecorator::start ( )

Call filters requestReady() method.

Definition at line 28 of file qgsfilterresponsedecorator.cpp.

◆ statusCode()

int QgsFilterResponseDecorator::statusCode ( ) const

inlineoverridevirtual

Returns the http status code.

Implements QgsServerResponse.

Definition at line 85 of file qgsfilterresponsedecorator.h.

◆ truncate()

void QgsFilterResponseDecorator::truncate ( )

inlineoverridevirtual

Truncate data.

Clear internal buffer

Implements QgsServerResponse.

Definition at line 99 of file qgsfilterresponsedecorator.h.

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

/build/qgis-4.1.0+git20260604+ca2ac17535b+99sid/src/server/qgsfilterresponsedecorator.h
/build/qgis-4.1.0+git20260604+ca2ac17535b+99sid/src/server/qgsfilterresponsedecorator.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ QgsFilterResponseDecorator()

Member Function Documentation

◆ addHeader()

◆ clear()

◆ data()

◆ feedback()

◆ finish()

◆ flush()

◆ fullHeader()

◆ fullHeaders()

◆ header()

◆ headers()

◆ headersSent()

◆ io()

◆ ready()

◆ removeHeader()

◆ sendError()

◆ setHeader()

◆ setStatusCode()

◆ start()

◆ statusCode()

◆ truncate()