QgsServerFilter Class Reference

Class defining I/O filters for QGIS Server and implemented in plugins. More...

#include <qgsserverfilter.h>

Public Member Functions
	QgsServerFilter (QgsServerInterface *serverInterface)
	Constructor QgsServerInterface passed to plugins constructors and must be passed to QgsServerFilter instances.
virtual	~QgsServerFilter ()=default
virtual bool	onProjectReady ()
	Method called when the QgsProject instance is ready to be used to perform the request, just before entering the main switch for core services.
virtual bool	onRequestReady ()
	Method called when the QgsRequestHandler is ready and populated with parameters, just before entering the main switch for core services.
virtual bool	onResponseComplete ()
	Method called when the QgsRequestHandler processing has done and the response is ready, just after the main switch for core services and before final sending response to FCGI stdout.
virtual bool	onSendResponse ()
	Method called when the QgsRequestHandler sends its data to FCGI stdout.
virtual Q_DECL_DEPRECATED void	requestReady ()
	Method called when the QgsRequestHandler is ready and populated with parameters, just before entering the main switch for core services.
virtual Q_DECL_DEPRECATED void	responseComplete ()
	Method called when the QgsRequestHandler processing has done and the response is ready, just after the main switch for core services and before final sending response.
virtual Q_DECL_DEPRECATED void	sendResponse ()
	Method called when the QgsRequestHandler sends its data to FCGI stdout.
QgsServerInterface *	serverInterface ()
	Returns the QgsServerInterface instance.

Detailed Description

Class defining I/O filters for QGIS Server and implemented in plugins.

Filters can define any (or none) of the following hooks:

• requestReady() - called when request is ready
• responseComplete() - called when the response is complete after core services have returned to main loop
• sendResponse() - called just before sending output to FGCI

Definition at line 43 of file qgsserverfilter.h.

Constructor & Destructor Documentation

QgsServerFilter()

QgsServerFilter::QgsServerFilter

(

QgsServerInterface *

serverInterface

)

Constructor QgsServerInterface passed to plugins constructors and must be passed to QgsServerFilter instances.

QgsServerFilter Class defining I/O filters for QGIS Server and implemented in plugins.

Definition at line 31 of file qgsserverfilter.cpp.

~QgsServerFilter()

virtual QgsServerFilter::~QgsServerFilter ( )

virtualdefault

Member Function Documentation

onProjectReady()

bool QgsServerFilter::onProjectReady ( )

virtual

Method called when the QgsProject instance is ready to be used to perform the request, just before entering the main switch for core services.

Returns

true if the call must propagate to the subsequent filters, false otherwise

Since

QGIS 3.36

Definition at line 59 of file qgsserverfilter.cpp.

onRequestReady()

bool QgsServerFilter::onRequestReady ( )

virtual

Method called when the QgsRequestHandler is ready and populated with parameters, just before entering the main switch for core services.

Returns

true if the call must propagate to the subsequent filters, false otherwise

Since

QGIS 3.24

Definition at line 51 of file qgsserverfilter.cpp.

onResponseComplete()

bool QgsServerFilter::onResponseComplete ( )

virtual

Method called when the QgsRequestHandler processing has done and the response is ready, just after the main switch for core services and before final sending response to FCGI stdout.

Returns

true if the call must propagate to the subsequent filters, false otherwise

Since

QGIS 3.24

Definition at line 64 of file qgsserverfilter.cpp.

onSendResponse()

bool QgsServerFilter::onSendResponse ( )

virtual

Method called when the QgsRequestHandler sends its data to FCGI stdout.

This normally occurs at the end of core services processing just after the responseComplete() plugin hook. For streaming services (like WFS on getFeature requests, sendResponse() might have been called several times before the response is complete: in this particular case, sendResponse() is called once for each feature before hitting responseComplete()

Returns

true if the call must propagate to the subsequent filters, false otherwise

Since

QGIS 3.22

Definition at line 72 of file qgsserverfilter.cpp.

requestReady()

void QgsServerFilter::requestReady ( )

virtual

Method called when the QgsRequestHandler is ready and populated with parameters, just before entering the main switch for core services.

This method is considered as deprecated and

See also

onRequestReady should be used instead.

Deprecated:

QGIS 3.40. Will be removed in QGIS 4.0.

Definition at line 36 of file qgsserverfilter.cpp.

responseComplete()

void QgsServerFilter::responseComplete ( )

virtual

Method called when the QgsRequestHandler processing has done and the response is ready, just after the main switch for core services and before final sending response.

This method is considered as deprecated and

See also

onResponseComplete should be used instead.

Deprecated:

QGIS 3.40. Will be removed in QGIS 4.0.

Definition at line 41 of file qgsserverfilter.cpp.

sendResponse()

void QgsServerFilter::sendResponse ( )

virtual

Method called when the QgsRequestHandler sends its data to FCGI stdout.

This normally occurs at the end of core services processing just after the responseComplete() plugin hook. For streaming services (like WFS on getFeature requests, sendResponse() might have been called several times before the response is complete: in this particular case, sendResponse() is called once for each feature before hitting responseComplete()

This method is considered as deprecated and

See also

onSendResponse should be used instead.

Deprecated:

QGIS 3.40. Will be removed in QGIS 4.0.

Definition at line 46 of file qgsserverfilter.cpp.

serverInterface()

QgsServerInterface * QgsServerFilter::serverInterface ( )

inline

Returns the QgsServerInterface instance.

Definition at line 58 of file qgsserverfilter.h.

---

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

• /build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/server/qgsserverfilter.h
• /build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/server/qgsserverfilter.cpp