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. More...
virtual	~QgsServerFilter ()=default
virtual void	requestReady ()
	Method called when the QgsRequestHandler is ready and populated with parameters, just before entering the main switch for core services. More...
virtual 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 to FCGI stdout. More...
virtual void	sendResponse ()
	Method called when the QgsRequestHandler sends its data to FCGI stdout. More...
QgsServerInterface *	serverInterface ()
	Return the QgsServerInterface instance. More...

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()

virtual QgsServerFilter::~QgsServerFilter ( )

virtualdefault

Member Function Documentation

requestReady()

virtual void QgsServerFilter::requestReady ( )

virtual

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

responseComplete()

virtual 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 to FCGI stdout.

sendResponse()

virtual 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()

serverInterface()

QgsServerInterface* QgsServerFilter::serverInterface ( )

inline

Return the QgsServerInterface instance.

Definition at line 58 of file qgsserverfilter.h.

---

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

• /tmp/buildd/qgis-3.0.2+14stretch/src/server/qgsserverfilter.h