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
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/server/qgsserverresponse.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsServerResponse
{
%TypeHeaderCode
#include "qgsserverresponse.h"
%End
public:
QgsServerResponse();
virtual ~QgsServerResponse();
virtual void setHeader( const QString &key, const QString &value ) = 0;
%Docstring
Set Header entry Add Header entry to the response Note that it is
usually an error to set Header after data have been sent through the
wire
%End
virtual void removeHeader( const QString &key ) = 0;
%Docstring
Clear header Undo a previous 'setHeader' call
%End
virtual QString header( const QString &key ) const = 0;
%Docstring
Returns the header value
%End
virtual QMap<QString, QString> headers() const = 0;
%Docstring
Returns the header value
%End
virtual bool headersSent() const = 0;
%Docstring
Returns ``True`` if the headers have already been sent
%End
virtual void setStatusCode( int code ) = 0;
%Docstring
Set the http status code
:param code: HTTP status code value
%End
virtual int statusCode() const = 0;
%Docstring
Returns the http status code
%End
virtual void sendError( int code, const QString &message ) = 0;
%Docstring
Send error This method delegates error handling at the server level.
This is different from calling
:py:func:`~QgsServerResponse.setReturnCode` which let you return a
specific response body. Calling :py:func:`~QgsServerResponse.sendError`
will end the transaction and any attempt to write data or set headers
will be an error.
:param code: HHTP return code value
:param message: An informative error message
%End
virtual void write( const QString &data );
%Docstring
Write string This is a convenient method that will write directly to the
underlying I/O device
%End
virtual qint64 write( const QByteArray &byteArray );
%Docstring
Write chunk of data This is a convenient method that will write directly
to the underlying I/O device
:return: the number of bytes that were actually written
%End
virtual void write( const QgsServerException &ex );
%Docstring
Write server exception
%End
virtual QIODevice *io() = 0;
%Docstring
Returns the underlying QIODevice
%End
virtual void finish() throw( QgsServerException ) /VirtualErrorHandler=server_exception_handler/;
%Docstring
Finish the response, ending the transaction. The default implementation
does nothing.
%End
virtual void flush() throw( QgsServerException ) /VirtualErrorHandler=server_exception_handler/;
%Docstring
Flushes the current output buffer to the network
':py:func:`~QgsServerResponse.flush`' may be called multiple times. For
HTTP transactions headers will be written on the first call to
':py:func:`~QgsServerResponse.flush`'. The default implementation does
nothing.
%End
virtual void clear() = 0;
%Docstring
Reset all headers and content for this response
%End
virtual QByteArray data() const = 0;
%Docstring
Gets the data written so far
This is implementation dependent: some implementations may not give
access to the underlying and return an empty array.
Note that each call to 'flush' may empty the buffer and in case of
streaming process you may get partial content
%End
virtual void truncate() = 0;
%Docstring
Truncate data
Clear internal buffer
%End
virtual QgsFeedback *feedback() const;
%Docstring
Returns the socket feedback if any
.. versionadded:: 3.36
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/server/qgsserverresponse.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
