qgsfcgiserverresponse.h

Go to the documentation of this file.

/***************************************************************************
                          qgsfcgiserverresponse.h
 
  Define response wrapper for fcgi response
  -------------------
  begin                : 2017-01-03
  copyright            : (C) 2017 by David Marteau
  email                : david dot marteau at 3liz dot com
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
#ifndef QGSFCGISERVERRESPONSE_H
#define QGSFCGISERVERRESPONSE_H
 
#define SIP_NO_FILE
 
 
#include <mutex>
#include <thread>
 
#include "qgsserverrequest.h"
#include "qgsserverresponse.h"
 
#include <QBuffer>

class QgsSocketMonitoringThread
{
  public:

    QgsSocketMonitoringThread( std::shared_ptr<QgsFeedback> feedback );

    void run();

    void stop();
 
  private:
    std::atomic_bool mShouldStop;
    std::shared_ptr<QgsFeedback> mFeedback;
    int mIpcFd = -1;
 
    // used to synchronize socket monitoring thread and fcgi response
    std::timed_mutex mMutex;
};

class SERVER_EXPORT QgsFcgiServerResponse : public QgsServerResponse
{
  public:

    QgsFcgiServerResponse( QgsServerRequest::Method method = QgsServerRequest::GetMethod );
 
    ~QgsFcgiServerResponse() override;
 
    void setHeader( const QString &key, const QString &value ) override;
 
    void removeHeader( const QString &key ) override;
 
    QString header( const QString &key ) const override;
 
    QMap<QString, QString> headers() const override { return mHeaders; }
 
    bool headersSent() const override;
 
    void setStatusCode( int code ) override;
 
    int statusCode() const override { return mStatusCode; }
 
    void sendError( int code, const QString &message ) override;
 
    QIODevice *io() override;
 
    void finish() override;
 
    void flush() override;
 
    void clear() override;
 
    QByteArray data() const override;
 
    void truncate() override;

    void setDefaultHeaders();

    QgsFeedback *feedback() const override { return mFeedback.get(); }
 
  private:
    QMap<QString, QString> mHeaders;
    QBuffer mBuffer;
    bool mFinished = false;
    bool mHeadersSent = false;
    QgsServerRequest::Method mMethod;
    int mStatusCode = 0;
 
    // encapsulate thread data
    std::unique_ptr<QgsSocketMonitoringThread> mSocketMonitoringThread;
    // real thread object. Used to join.
    std::thread mThread;
    // Used to cancel rendering jobs
    std::shared_ptr<QgsFeedback> mFeedback;
};
 
#endif