QGIS API Documentation  3.4.15-Madeira (e83d02e274)
qgsbufferserverresponse.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsbufferserverresponse.h
3 
4  Define response wrapper for storing responsea in buffer
5  -------------------
6  begin : 2017-01-03
7  copyright : (C) 2017 by David Marteau
8  email : david dot marteau at 3liz dot com
9  ***************************************************************************/
10 
11 /***************************************************************************
12  * *
13  * This program is free software; you can redistribute it and/or modify *
14  * it under the terms of the GNU General Public License as published by *
15  * the Free Software Foundation; either version 2 of the License, or *
16  * (at your option) any later version. *
17  * *
18  ***************************************************************************/
19 #ifndef QGSBUFFERSERVERRESPONSE_H
20 #define QGSBUFFERSERVERRESPONSE_H
21 
22 #include "qgis_server.h"
23 #include "qgis.h"
24 #include "qgsserverresponse.h"
25 
26 #include <QBuffer>
27 #include <QByteArray>
28 #include <QMap>
29 
36 class SERVER_EXPORT QgsBufferServerResponse: public QgsServerResponse
37 {
38  public:
39 
41 
44 
50  void setHeader( const QString &key, const QString &value ) override;
51 
56  void removeHeader( const QString &key ) override;
57 
61  QString header( const QString &key ) const override;
62 
66  QMap<QString, QString> headers() const override { return mHeaders; }
67 
71  bool headersSent() const override;
72 
77  void setStatusCode( int code ) override;
78 
82  int statusCode() const override { return mStatusCode; }
83 
93  void sendError( int code, const QString &message ) override;
94 
98  QIODevice *io() override;
99 
103  void finish() override;
104 
111  void flush() override;
112 
116  void clear() override;
117 
127  QByteArray data() const override;
128 
134  void truncate() override;
135 
139  QByteArray body() const { return mBody; }
140 
141 
142  private:
143 
144 #ifdef SIP_RUN
146 #endif
147 
148  QMap<QString, QString> mHeaders;
149  QBuffer mBuffer;
150  QByteArray mBody;
151  bool mFinished = false;
152  bool mHeadersSent = false;
153  int mStatusCode = 200;
154 };
155 
156 #endif
virtual void setHeader(const QString &key, const QString &value)=0
Set Header entry Add Header entry to the response Note that it is usually an error to set Header afte...
virtual void truncate()=0
Truncate data.
virtual void sendError(int code, const QString &message)=0
Send error This method delegates error handling at the server level.
virtual void clear()=0
Reset all headers and content for this response.
virtual void removeHeader(const QString &key)=0
Clear header Undo a previous &#39;setHeader&#39; call.
virtual void setStatusCode(int code)=0
Set the http status code.
#define SIP_FORCE
Definition: qgis_sip.h:124
QByteArray body() const
Returns body.
virtual void flush()=0
Flushes the current output buffer to the network.
Class defining buffered response.
virtual QString header(const QString &key) const =0
Returns the header value.
virtual QByteArray data() const =0
Gets the data written so far.
int statusCode() const override
Returns the http status code.
QMap< QString, QString > headers() const override
Returns all the headers.
virtual QIODevice * io()=0
Returns the underlying QIODevice.
virtual bool headersSent() const =0
Returns true if the headers have already been sent.
QgsServerResponse Class defining response interface passed to services QgsService::executeRequest() m...
virtual void finish()=0
Finish the response, ending the transaction.