QGIS API Documentation 3.38.0-Grenoble (exported)
Loading...
Searching...
No Matches
qgsfcgiserverresponse.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsfcgiserverresponse.h
3
4 Define response wrapper for fcgi response
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 QGSFCGISERVERRESPONSE_H
20#define QGSFCGISERVERRESPONSE_H
21
22#define SIP_NO_FILE
23
24
25#include "qgsserverrequest.h"
26#include "qgsserverresponse.h"
27
28#include <QBuffer>
29#include <QThread>
30
37class QgsSocketMonitoringThread: public QThread
38{
39 Q_OBJECT
40
41 public:
42
48 QgsSocketMonitoringThread( bool *isResponseFinished, QgsFeedback *feedback );
49 void run( );
50
51 private:
52 bool *mIsResponseFinished = nullptr;
53 QgsFeedback *mFeedback = nullptr;
54 int mIpcFd = -1;
55};
56
62class SERVER_EXPORT QgsFcgiServerResponse: public QgsServerResponse
63{
64 public:
65
71 virtual ~QgsFcgiServerResponse();
72
73 void setHeader( const QString &key, const QString &value ) override;
74
75 void removeHeader( const QString &key ) override;
76
77 QString header( const QString &key ) const override;
78
79 QMap<QString, QString> headers() const override { return mHeaders; }
80
81 bool headersSent() const override;
82
83 void setStatusCode( int code ) override;
84
85 int statusCode() const override { return mStatusCode; }
86
87 void sendError( int code, const QString &message ) override;
88
89 QIODevice *io() override;
90
91 void finish() override;
92
93 void flush() override;
94
95 void clear() override;
96
97 QByteArray data() const override;
98
99 void truncate() override;
100
104 void setDefaultHeaders();
105
110 QgsFeedback *feedback() const override { return mFeedback.get(); }
111
112 private:
113 QMap<QString, QString> mHeaders;
114 QBuffer mBuffer;
115 bool mFinished = false;
116 bool mHeadersSent = false;
118 int mStatusCode = 0;
119
120 std::unique_ptr<QgsSocketMonitoringThread> mSocketMonitoringThread;
121 std::unique_ptr<QgsFeedback> mFeedback;
122};
123
124#endif
Class defining fcgi response.
QgsFeedback * feedback() const override
Returns socket feedback if any.
QMap< QString, QString > headers() const override
Returns the header value.
int statusCode() const override
Returns the http status code.
Base class for feedback objects to be used for cancellation of something running in a worker thread.
Definition qgsfeedback.h:44
Method
HTTP Method (or equivalent) used for the request.
QgsServerResponse Class defining response interface passed to services QgsService::executeRequest() m...
virtual void removeHeader(const QString &key)=0
Clear header Undo a previous 'setHeader' call.
virtual void truncate()=0
Truncate data.
virtual void flush()
Flushes the current output buffer to the network.
virtual QByteArray data() const =0
Gets the data written so far.
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 clear()=0
Reset all headers and content for this response.
virtual void finish()
Finish the response, ending the transaction.
virtual bool headersSent() const =0
Returns true if the headers have already been sent.
virtual void sendError(int code, const QString &message)=0
Send error This method delegates error handling at the server level.
virtual QIODevice * io()=0
Returns the underlying QIODevice.
virtual QString header(const QString &key) const =0
Returns the header value.
virtual void setStatusCode(int code)=0
Set the http status code.
Thread used to monitor the fcgi socket.