QgsServerFilter Class Reference

Class defining I/O filters for Qgis Mapserver and implemented in plugins. More...

Public Member Functions
	QgsServerFilter (QgsServerInterface *serverInterface)
virtual	~QgsServerFilter ()
QgsServerInterface *	serverInterface ()
virtual void	requestReady ()
virtual void	responseComplete ()
virtual void	sendResponse ()

Detailed Description

Class defining I/O filters for Qgis Mapserver 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

Constructor & Destructor Documentation

QgsServerFilter::QgsServerFilter

(

QgsServerInterface *

serverInterface

)

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

virtual QgsServerFilter::~QgsServerFilter ( )

virtual

Destructor

Member Function Documentation

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.

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.

virtual void QgsServerFilter::sendResponse ( )

virtual

Method called when the QgsRequestHandler sends its data to FCGI stdout. This normally occours 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()

QgsServerInterface* QgsServerFilter::serverInterface

(

)

Return the QgsServerInterface instance

---

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

• qgsserverfilter.sip