1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/server/qgsservercachefilter.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsServerCacheFilter
{
%Docstring(signature="appended")
Class defining cache interface for QGIS Server plugins.
.. versionadded:: 3.4
%End
%TypeHeaderCode
#include "qgsservercachefilter.h"
%End
public:
QgsServerCacheFilter( const QgsServerInterface *serverInterface );
%Docstring
Constructor :py:class:`QgsServerInterface` passed to plugins
constructors and must be passed to QgsServerCacheFilter instances.
%End
virtual ~QgsServerCacheFilter();
virtual QByteArray getCachedDocument( const QgsProject *project, const QgsServerRequest &request, const QString &key ) const;
%Docstring
Returns cached document (or 0 if document not in cache) like
capabilities
:param project: the project used to generate the document to provide
path
:param request: the request used to generate the document to provider
parameters or data
:param key: the key provided by the access control to identify different
documents for the same request
:return: QByteArray of the cached document or an empty one if no
corresponding document found
%End
virtual bool setCachedDocument( const QDomDocument *doc, const QgsProject *project, const QgsServerRequest &request, const QString &key ) const;
%Docstring
Updates or inserts the document in cache like capabilities
:param doc: the document to cache
:param project: the project used to generate the document to provide
path
:param request: the request used to generate the document to provider
parameters or data
:param key: the key provided by the access control to identify different
documents for the same request
:return: ``True`` if the document has been cached
%End
virtual bool deleteCachedDocument( const QgsProject *project, const QgsServerRequest &request, const QString &key ) const;
%Docstring
Deletes the cached document
:param project: the project used to generate the document to provide
path
:param request: the request used to generate the document to provider
parameters or data
:param key: the key provided by the access control to identify different
documents for the same request
:return: ``True`` if the document has been deleted
%End
virtual bool deleteCachedDocuments( const QgsProject *project ) const;
%Docstring
Deletes all cached documents for a QGIS project
:param project: the project used to generate the documents to provide
path
:return: ``True`` if the documents have been deleted
%End
virtual QByteArray getCachedImage( const QgsProject *project, const QgsServerRequest &request, const QString &key ) const;
%Docstring
Returns cached image (or 0 if document not in cache) like tiles
:param project: the project used to generate the image to provide path
:param request: the request used to generate the image to provider
parameters or data
:param key: the key provided by the access control to identify different
images for the same request
:return: QByteArray of the cached image or an empty one if no
corresponding image found
%End
virtual bool setCachedImage( const QByteArray *img, const QgsProject *project, const QgsServerRequest &request, const QString &key ) const;
%Docstring
Updates or inserts the image in cache like tiles
:param img: the document to cache
:param project: the project used to generate the image to provide path
:param request: the request used to generate the image to provider
parameters or data
:param key: the key provided by the access control to identify different
images for the same request
:return: ``True`` if the image has been cached
%End
virtual bool deleteCachedImage( const QgsProject *project, const QgsServerRequest &request, const QString &key ) const;
%Docstring
Deletes the cached image
:param project: the project used to generate the image to provide path
:param request: the request used to generate the image to provider
parameters or data
:param key: the key provided by the access control to identify different
images for the same request
:return: ``True`` if the image has been deleted
%End
virtual bool deleteCachedImages( const QgsProject *project ) const;
%Docstring
Deletes all cached images for a QGIS project
:param project: the project used to generate the images to provide path
:return: ``True`` if the images have been deleted
%End
};
typedef QMultiMap<int, QgsServerCacheFilter *> QgsServerCacheFilterMap;
/************************************************************************
* This file has been generated automatically from *
* *
* src/server/qgsservercachefilter.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
