qgsserverresponse.h

Go to the documentation of this file.

/***************************************************************************
                          qgsserverresponse.h
 
  Define response class for services
  -------------------
  begin                : 2016-12-05
  copyright            : (C) 2016 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 QGSSERVERRESPONSE_H
#define QGSSERVERRESPONSE_H
 
#include "qgis_server.h"
#include "qgis_sip.h"
#include "qgsfeedback.h"
#include "qgsserverexception.h"
 
#include <QIODevice>
#include <QString>
 
class QgsServerException;

 
// Note:
// This class is intended to be used from Python code: method signatures and return types should be
// compatible with pyQGIS/pyQT types and rules.
 
class SERVER_EXPORT QgsServerResponse
{
  public:
    QgsServerResponse() = default;
    virtual ~QgsServerResponse() = default;

    virtual void setHeader( const QString &key, const QString &value ) = 0;

    virtual void addHeader( const QString &key, const QString &value ) = 0;

    virtual void removeHeader( const QString &key ) = 0;

    Q_DECL_DEPRECATED virtual QString header( const QString &key ) const = 0 SIP_DEPRECATED;

    virtual QList<QString> fullHeader( const QString &key ) const = 0;

    Q_DECL_DEPRECATED virtual QMap<QString, QString> headers() const = 0 SIP_DEPRECATED;

    virtual QMap<QString, QList<QString>> fullHeaders() const = 0;

    virtual bool headersSent() const = 0;

    virtual void setStatusCode( int code ) = 0;

    virtual int statusCode() const = 0;

    virtual void sendError( int code, const QString &message ) = 0;

    virtual void write( const QString &data );

    virtual qint64 write( const QByteArray &byteArray );

    virtual qint64 write( const char *data, qint64 maxsize ) SIP_SKIP;

    virtual qint64 write( const char *data ) SIP_SKIP;

    virtual qint64 write( std::string data ) SIP_SKIP;

    virtual void write( const QgsServerException &ex );

    virtual QIODevice *io() = 0;

    virtual void finish() SIP_THROW( QgsServerException ) SIP_VIRTUALERRORHANDLER( server_exception_handler );

    virtual void flush() SIP_THROW( QgsServerException ) SIP_VIRTUALERRORHANDLER( server_exception_handler );

    virtual void clear() = 0;

    virtual QByteArray data() const = 0;

    virtual void truncate() = 0;

    virtual QgsFeedback *feedback() const;
};
 
#endif