QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
|
Class defining fcgi response. More...
#include <qgsfcgiserverresponse.h>
Public Member Functions | |
QgsFcgiServerResponse (QgsServerRequest::Method method=QgsServerRequest::GetMethod) | |
Constructor for QgsFcgiServerResponse. | |
virtual | ~QgsFcgiServerResponse () |
void | clear () override |
Reset all headers and content for this response. | |
QByteArray | data () const override |
Gets the data written so far. | |
QgsFeedback * | feedback () const override |
Returns socket feedback if any. | |
void | finish () override |
Finish the response, ending the transaction. | |
void | flush () override |
Flushes the current output buffer to the network. | |
QString | header (const QString &key) const override |
Returns the header value. | |
QMap< QString, QString > | headers () const override |
Returns the header value. | |
bool | headersSent () const override |
Returns true if the headers have already been sent. | |
QIODevice * | io () override |
Returns the underlying QIODevice. | |
void | removeHeader (const QString &key) override |
Clear header Undo a previous 'setHeader' call. | |
void | sendError (int code, const QString &message) override |
Send error This method delegates error handling at the server level. | |
void | setDefaultHeaders () |
Set the default headers. | |
void | setHeader (const QString &key, const QString &value) override |
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. | |
void | setStatusCode (int code) override |
Set the http status code. | |
int | statusCode () const override |
Returns the http status code. | |
void | truncate () override |
Truncate data. | |
Public Member Functions inherited from QgsServerResponse | |
QgsServerResponse ()=default | |
virtual | ~QgsServerResponse ()=default |
virtual qint64 | write (const char *data) |
Writes at most maxSize bytes of data. | |
virtual qint64 | write (const char *data, qint64 maxsize) |
Writes at most maxSize bytes of data. | |
virtual qint64 | write (const QByteArray &byteArray) |
Write chunk of data This is a convenient method that will write directly to the underlying I/O device. | |
virtual void | write (const QgsServerException &ex) |
Write server exception. | |
virtual void | write (const QString &data) |
Write string This is a convenient method that will write directly to the underlying I/O device. | |
virtual qint64 | write (std::string data) |
Writes at most maxSize bytes of data. | |
Class defining fcgi response.
Definition at line 62 of file qgsfcgiserverresponse.h.
QgsFcgiServerResponse::QgsFcgiServerResponse | ( | QgsServerRequest::Method | method = QgsServerRequest::GetMethod | ) |
Constructor for QgsFcgiServerResponse.
method | The HTTP method (Get by default) |
Definition at line 136 of file qgsfcgiserverresponse.cpp.
|
virtual |
Definition at line 147 of file qgsfcgiserverresponse.cpp.
|
overridevirtual |
Reset all headers and content for this response.
Implements QgsServerResponse.
Definition at line 272 of file qgsfcgiserverresponse.cpp.
|
overridevirtual |
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
Implements QgsServerResponse.
Definition at line 283 of file qgsfcgiserverresponse.cpp.
|
inlineoverridevirtual |
Returns socket feedback if any.
Reimplemented from QgsServerResponse.
Definition at line 110 of file qgsfcgiserverresponse.h.
|
overridevirtual |
Finish the response, ending the transaction.
The default implementation does nothing.
Reimplemented from QgsServerResponse.
Definition at line 204 of file qgsfcgiserverresponse.cpp.
|
overridevirtual |
Flushes the current output buffer to the network.
'flush()' may be called multiple times. For HTTP transactions headers will be written on the first call to 'flush()'. The default implementation does nothing.
Reimplemented from QgsServerResponse.
Definition at line 233 of file qgsfcgiserverresponse.cpp.
|
overridevirtual |
Returns the header value.
Implements QgsServerResponse.
Definition at line 164 of file qgsfcgiserverresponse.cpp.
|
inlineoverridevirtual |
Returns the header value.
Implements QgsServerResponse.
Definition at line 79 of file qgsfcgiserverresponse.h.
|
overridevirtual |
Returns true
if the headers have already been sent.
Implements QgsServerResponse.
Definition at line 169 of file qgsfcgiserverresponse.cpp.
|
overridevirtual |
Returns the underlying QIODevice.
Implements QgsServerResponse.
Definition at line 199 of file qgsfcgiserverresponse.cpp.
|
overridevirtual |
Clear header Undo a previous 'setHeader' call.
Implements QgsServerResponse.
Definition at line 154 of file qgsfcgiserverresponse.cpp.
|
overridevirtual |
Send error This method delegates error handling at the server level.
This is different from calling setReturnCode() which let you return a specific response body. Calling sendError() will end the transaction and any attempt to write data or set headers will be an error.
code | HHTP return code value |
message | An informative error message |
Implements QgsServerResponse.
Definition at line 182 of file qgsfcgiserverresponse.cpp.
void QgsFcgiServerResponse::setDefaultHeaders | ( | ) |
Set the default headers.
Definition at line 296 of file qgsfcgiserverresponse.cpp.
|
overridevirtual |
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.
Implements QgsServerResponse.
Definition at line 159 of file qgsfcgiserverresponse.cpp.
|
overridevirtual |
Set the http status code.
code | HTTP status code value |
Implements QgsServerResponse.
Definition at line 174 of file qgsfcgiserverresponse.cpp.
|
inlineoverridevirtual |
Returns the http status code.
Implements QgsServerResponse.
Definition at line 85 of file qgsfcgiserverresponse.h.
|
overridevirtual |
Truncate data.
Clear internal buffer
Implements QgsServerResponse.
Definition at line 289 of file qgsfcgiserverresponse.cpp.