Class defining I/O filters for QGIS Server and implemented in plugins.
More...
#include <qgsserverfilter.h>
Class defining I/O filters for QGIS Server and implemented in plugins.
Filters can define any (or none) of the following hooks:
Definition at line 43 of file qgsserverfilter.h.
◆ QgsServerFilter()
◆ ~QgsServerFilter()
virtual QgsServerFilter::~QgsServerFilter |
( |
| ) |
|
|
virtualdefault |
◆ 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 59 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 67 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:
- 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:
- Will be removed in QGIS 4.0
Definition at line 41 of file qgsserverfilter.cpp.
◆ sendResponse()
void QgsServerFilter::sendResponse |
( |
| ) |
|
|
virtual |
◆ serverInterface()
The documentation for this class was generated from the following files: