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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/server/qgsrequesthandler.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsRequestHandler
{
%Docstring(signature="appended")
This class is an interface hiding the details of reading input and
writing output from/to a wms request mechanism.
%End
%TypeHeaderCode
#include "qgsrequesthandler.h"
%End
public:
explicit QgsRequestHandler( QgsServerRequest &request, QgsServerResponse &response );
%Docstring
Constructor
Note that :py:class:`QgsServerRequest` and :py:class:`QgsServerResponse`
MUST live in the same scope
%End
void setServiceException( const QgsServerException &ex );
%Docstring
Allow plugins to return a :py:class:`QgsMapServiceException`
%End
void sendResponse();
%Docstring
Send out HTTP headers and flush output buffer
This method is intended only for streaming partial content.
%End
void setResponseHeader( const QString &name, const QString &value );
%Docstring
Sets an HTTP response header
%End
void removeResponseHeader( const QString &name );
%Docstring
Remove an HTTP response header
%End
QString responseHeader( const QString &name ) const;
%Docstring
Retrieve response header value
%End
QMap<QString, QString> responseHeaders() const;
%Docstring
Returns the response headers
%End
void setRequestHeader( const QString &name, const QString &value );
%Docstring
Sets an HTTP request header
%End
void removeRequestHeader( const QString &name );
%Docstring
Remove an HTTP request header
%End
QString requestHeader( const QString &name ) const;
%Docstring
Retrieve request header value
%End
QMap<QString, QString> requestHeaders() const;
%Docstring
Returns the the Request headers
%End
void clear();
%Docstring
Clears the response body and headers
%End
void appendBody( const QByteArray &body );
%Docstring
Sets the info format string such as "text/xml"
%End
bool exceptionRaised() const;
%Docstring
Pointer to last raised exception
%End
void clearBody();
%Docstring
Clear response buffer
%End
QByteArray body() const;
%Docstring
Returns the response body data
%End
QByteArray data() const;
%Docstring
Returns the request POST data (can be null)
%End
QString url() const;
%Docstring
Returns the request url
%End
QString path() const;
%Docstring
Returns the path component of the request URL
.. versionadded:: 3.16
%End
void setStatusCode( int code );
%Docstring
Sets response http status code
%End
int statusCode() const;
%Docstring
Returns the response http status code
%End
QMap<QString, QString> parameterMap() const;
%Docstring
Returns the parsed parameters as a key-value pair, to modify a parameter
setParameter( const QString &key, const QString &value) and
removeParameter(const QString &key) must be used
%End
void setParameter( const QString &key, const QString &value );
%Docstring
Sets a request parameter
%End
QString parameter( const QString &key ) const;
%Docstring
Returns a request parameter
%End
void removeParameter( const QString &key );
%Docstring
Remove a request parameter
%End
QString format() const;
%Docstring
Returns the requested format string
%End
bool headersSent() const;
%Docstring
Returns ``True`` if the HTTP headers were already sent to the client
%End
private:
QgsRequestHandler &operator=( const QgsRequestHandler & );
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/server/qgsrequesthandler.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
