Class: QgsServerFilter¶
-
class
qgis.server.
QgsServerFilter
(serverInterface: QgsServerInterface)¶ Bases:
sip.wrapper
Constructor
QgsServerInterface
passed to plugins constructors and must be passed toQgsServerFilter
instances.QgsServerFilter(
QgsServerFilter
)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 readyresponseComplete()
- called when the response is complete after core services have returned to main loopsendResponse()
- called just before sending output to FGCI
- Parameters
serverInterface –
-
requestReady
(self)¶ Method called when the
QgsRequestHandler
is ready and populated with parameters, just before entering the main switch for core services.*
-
responseComplete
(self)¶ 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
(self)¶ Method called when the
QgsRequestHandler
sends its data to FCGI stdout. This normally occurs at the end of core services processing just after theresponseComplete()
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 hittingresponseComplete()
-
serverInterface
(self) → QgsServerInterface¶ Returns the
QgsServerInterface
instance- Return type