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
151
152
153
154
155
156
157
158
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/server/qgsservercachemanager.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsServerCacheManager
{
%Docstring(signature="appended")
A helper class that centralizes caches accesses given by all the server
cache filter plugins.
.. versionadded:: 3.4
%End
%TypeHeaderCode
#include "qgsservercachemanager.h"
#include "qgsservercachefilter.h"
%End
public:
QgsServerCacheManager( const QgsServerSettings &settings = QgsServerSettings() );
%Docstring
Constructor
%End
QgsServerCacheManager( const QgsServerCacheManager © );
~QgsServerCacheManager();
bool getCachedDocument( QDomDocument *doc, const QgsProject *project, const QgsServerRequest &request, QgsAccessControl *accessControl ) const;
%Docstring
Returns cached document (or 0 if document not in cache) like
capabilities
:param doc: the document to update by content found in 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 accessControl: the access control to identify different documents
for the same request provided by server interface
:return: ``True`` if the document has been found in cache and the
document's content set
%End
bool setCachedDocument( const QDomDocument *doc, const QgsProject *project, const QgsServerRequest &request, QgsAccessControl *accessControl ) 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 accessControl: the access control to identify different documents
for the same request provided by server interface
:return: ``True`` if the document has been cached
%End
bool deleteCachedDocument( const QgsProject *project, const QgsServerRequest &request, QgsAccessControl *accessControl ) 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 accessControl: the access control to identify different documents
for the same request provided by server interface
:return: ``True`` if the document has been deleted
%End
bool deleteCachedDocuments( const QgsProject *project ) const;
%Docstring
Deletes all cached documents for a QGIS project
:param project: the project used to generate the document to provide
path
:return: ``True`` if the document has been deleted
%End
QByteArray getCachedImage( const QgsProject *project, const QgsServerRequest &request, QgsAccessControl *accessControl ) const;
%Docstring
Returns cached image (or 0 if image 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 accessControl: the access control to identify different documents
for the same request provided by server interface
:return: the cached image or 0 if no corresponding image found
%End
bool setCachedImage( const QByteArray *img, const QgsProject *project, const QgsServerRequest &request, QgsAccessControl *accessControl ) const;
%Docstring
Updates or inserts the image in cache like tiles
:param img: the image 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 accessControl: the access control to identify different documents
for the same request provided by server interface
:return: ``True`` if the image has been cached
%End
bool deleteCachedImage( const QgsProject *project, const QgsServerRequest &request, QgsAccessControl *accessControl ) 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 accessControl: the access control to identify different documents
for the same request provided by server interface
:return: ``True`` if the image has been deleted
%End
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
void registerServerCache( QgsServerCacheFilter *serverCache, int priority = 0 );
%Docstring
Register a server cache filter
:param serverCache: the server cache to add
:param priority: the priority used to define the order
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/server/qgsservercachemanager.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
