qgsserverfilter.h

Go to the documentation of this file.

/***************************************************************************
                          qgsserverfilter.h
 Server I/O filters class for QGIS Server for use by plugins
                          -------------------
  begin                : 2014-09-10
  copyright            : (C) 2014 by Alessandro Pasotti
  email                : a dot pasotti at itopen dot it
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   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 QGSSERVERFILTER_H
#define QGSSERVERFILTER_H
 
#include "qgis_server.h"
#include "qgis_sip.h"
 
#include <QMultiMap>
 
SIP_IF_MODULE( HAVE_SERVER_PYTHON_PLUGINS )
 
class QgsServerInterface;

class SERVER_EXPORT QgsServerFilter
{
  public:
    QgsServerFilter( QgsServerInterface *serverInterface );
 
    virtual ~QgsServerFilter() = default;

    QgsServerInterface *serverInterface() { return mServerInterface; }

    Q_DECL_DEPRECATED virtual void requestReady() SIP_DEPRECATED;

    Q_DECL_DEPRECATED virtual void responseComplete() SIP_DEPRECATED;

    Q_DECL_DEPRECATED virtual void sendResponse() SIP_DEPRECATED;

    virtual bool onRequestReady();

    virtual bool onProjectReady();

    virtual bool onResponseComplete();

    virtual bool onSendResponse();
 
 
  private:
    QgsServerInterface *mServerInterface = nullptr;
};
 
typedef QMultiMap<int, QgsServerFilter *> QgsServerFiltersMap;
 
#endif // QGSSERVERFILTER_H