QGIS/python/server/qgsserverresponse.sip

/***************************************************************************
                          qgsserverresponse.sip

  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.                                   *
 *                                                                         *
 ***************************************************************************/

/**
 * \ingroup server
 * QgsServerResponse
 * Class defining response interface passed to services QgsService::executeRequest() method
 */

class QgsServerResponse
{
%TypeHeaderCode
#include "qgsserverresponse.h"
%End
    public:
       
        //!constructor
        QgsServerResponse();

        //! destructor
        virtual ~QgsServerResponse();

       /** Set Header entry 
        *  Add Header entry to the response 
        *  Note that it is usually an error to set Header after writing data
        */
        virtual void setHeader( const QString& key, const QString& value ) = 0;
        
       /** Set the http return code
        * @param code HTTP return code value
        */
        virtual void setReturnCode( int code ) = 0;

        /**
         * Send error
         * This method delegates error handling at the server level. This is different
         * from calling setReturnCode() along with and a specific response body.
         * @param code HHTP return code value
         * @param message An informative error message
         */
        virtual void sendError( int code,  const QString& message ) = 0;

        /**
         * Write string
         * This is a convenient method that will write directly
         * to the underlying I/O device
         */
        virtual void write(const QString& data );

       /**
        * Write chunk of data
        * This is a convenient method that will write directly to the 
        * underlying I/O device
        * @return the number of bytes that were actually written
        */ 
        virtual qint64 write(const QByteArray& byteArray );

        /**
         * Return the underlying QIODevice
         */
        virtual QIODevice* io() = 0;

};