QGIS API Documentation  3.23.0-Master (dd0cd13a00)
qgsserverfilter.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsserverfilter.h
3  Server I/O filters class for QGIS Server for use by plugins
4  -------------------
5  begin : 2014-09-10
6  copyright : (C) 2014 by Alessandro Pasotti
7  email : a dot pasotti at itopen dot it
8  ***************************************************************************/
9 
10 /***************************************************************************
11  * *
12  * This program is free software; you can redistribute it and/or modify *
13  * it under the terms of the GNU General Public License as published by *
14  * the Free Software Foundation; either version 2 of the License, or *
15  * (at your option) any later version. *
16  * *
17  ***************************************************************************/
18 
19 
20 #ifndef QGSSERVERFILTER_H
21 #define QGSSERVERFILTER_H
22 
23 #include <QMultiMap>
24 #include "qgis_server.h"
25 #include "qgis_sip.h"
26 
27 SIP_IF_MODULE( HAVE_SERVER_PYTHON_PLUGINS )
28 
29 class QgsServerInterface;
30 
43 class SERVER_EXPORT QgsServerFilter
44 {
45 
46  public:
47 
53  QgsServerFilter( QgsServerInterface *serverInterface );
54 
55  virtual ~QgsServerFilter() = default;
56 
58  QgsServerInterface *serverInterface() { return mServerInterface; }
59 
69  Q_DECL_DEPRECATED virtual void requestReady() SIP_DEPRECATED;
70 
81  Q_DECL_DEPRECATED virtual void responseComplete() SIP_DEPRECATED;
82 
96  Q_DECL_DEPRECATED virtual void sendResponse() SIP_DEPRECATED;
97 
106  virtual bool onRequestReady();
107 
117  virtual bool onResponseComplete();
118 
131  virtual bool onSendResponse();
132 
133 
134 
135  private:
136  QgsServerInterface *mServerInterface = nullptr;
137 
138 };
139 
140 typedef QMultiMap<int, QgsServerFilter *> QgsServerFiltersMap;
141 
142 #endif // QGSSERVERFILTER_H
Class defining I/O filters for QGIS Server and implemented in plugins.
virtual ~QgsServerFilter()=default
QgsServerInterface * serverInterface()
Returns the QgsServerInterface instance.
QgsServerInterface Class defining interfaces exposed by QGIS Server and made available to plugins.
#define SIP_IF_MODULE(condition)
Definition: qgis_sip.h:28
#define SIP_DEPRECATED
Definition: qgis_sip.h:106
QMultiMap< int, QgsServerFilter * > QgsServerFiltersMap