1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/server/qgsserverfilter.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsServerFilter
{
%Docstring(signature="appended")
Class defining I/O filters for QGIS Server and implemented in plugins.
%End
%TypeHeaderCode
#include "qgsserverfilter.h"
%End
public:
QgsServerFilter( QgsServerInterface *serverInterface );
%Docstring
Constructor :py:class:`QgsServerInterface` passed to plugins
constructors and must be passed to QgsServerFilter instances.
%End
virtual ~QgsServerFilter();
QgsServerInterface *serverInterface();
%Docstring
Returns the :py:class:`QgsServerInterface` instance
%End
virtual void requestReady() /Deprecated/;
%Docstring
Method called when the :py:class:`QgsRequestHandler` is ready and
populated with parameters, just before entering the main switch for core
services.
This method is considered as deprecated and :py:func:`onRequestReady`
should be used instead.
.. deprecated:: 3.40
Will be removed in QGIS 4.0.
%End
virtual void responseComplete() /Deprecated/;
%Docstring
Method called when the :py:class:`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
:py:func:`onResponseComplete` should be used instead.
.. deprecated:: 3.40
Will be removed in QGIS 4.0.
%End
virtual void sendResponse() /Deprecated/;
%Docstring
Method called when the :py:class:`QgsRequestHandler` sends its data to
FCGI stdout. This normally occurs at the end of core services processing
just after the :py:func:`~QgsServerFilter.responseComplete` plugin hook.
For streaming services (like WFS on getFeature requests,
:py:func:`~QgsServerFilter.sendResponse` might have been called several
times before the response is complete: in this particular case,
:py:func:`~QgsServerFilter.sendResponse` is called once for each feature
before hitting :py:func:`~QgsServerFilter.responseComplete`
This method is considered as deprecated and :py:func:`onSendResponse`
should be used instead.
.. deprecated:: 3.40
Will be removed in QGIS 4.0.
%End
virtual bool onRequestReady();
%Docstring
Method called when the :py:class:`QgsRequestHandler` is ready and
populated with parameters, just before entering the main switch for core
services.
:return: true if the call must propagate to the subsequent filters,
false otherwise
.. versionadded:: 3.24
%End
virtual bool onProjectReady();
%Docstring
Method called when the :py:class:`QgsProject` instance is ready to be
used to perform the request, just before entering the main switch for
core services.
:return: true if the call must propagate to the subsequent filters,
false otherwise
.. versionadded:: 3.36
%End
virtual bool onResponseComplete();
%Docstring
Method called when the :py:class:`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.
:return: true if the call must propagate to the subsequent filters,
false otherwise
.. versionadded:: 3.24
%End
virtual bool onSendResponse();
%Docstring
Method called when the :py:class:`QgsRequestHandler` sends its data to
FCGI stdout. This normally occurs at the end of core services processing
just after the :py:func:`~QgsServerFilter.responseComplete` plugin hook.
For streaming services (like WFS on getFeature requests,
:py:func:`~QgsServerFilter.sendResponse` might have been called several
times before the response is complete: in this particular case,
:py:func:`~QgsServerFilter.sendResponse` is called once for each feature
before hitting :py:func:`~QgsServerFilter.responseComplete`
:return: true if the call must propagate to the subsequent filters,
false otherwise
.. versionadded:: 3.22
%End
};
typedef QMultiMap<int, QgsServerFilter *> QgsServerFiltersMap;
/************************************************************************
* This file has been generated automatically from *
* *
* src/server/qgsserverfilter.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
