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
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/server/qgsserviceregistry.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsServiceRegistry
{
%Docstring(signature="appended")
:py:class:`QgsServiceRegistry` Class defining the registry manager for
QGIS server services
This class provides methods for registering and retrieving services.
IMPORTANT: The registry hold ownership of registered services and will
call 'delete' on cleanup
%End
%TypeHeaderCode
#include "qgsserviceregistry.h"
%End
public:
QgsServiceRegistry();
~QgsServiceRegistry();
QgsService *getService( const QString &name, const QString &version = QString() );
%Docstring
Retrieve a service from its name
:param name: the name of the service
:param version: the version string (optional)
:return: :py:class:`QgsService`
If the version is not provided the higher version of the service is
returned
%End
void registerService( QgsService *service /Transfer/ );
%Docstring
Register a service by its name and version
This method is intended to be called by modules for registering
services. A module may register multiple services.
The registry takes ownership of services and will call 'delete' on
cleanup
:param service: a :py:class:`QgsService` to be registered
%End
bool registerApi( QgsServerApi *api /Transfer/ );
%Docstring
Registers the :py:class:`QgsServerApi` ``api``
The registry takes ownership of services and will call 'delete' on
cleanup
.. versionadded:: 3.10
%End
int unregisterApi( const QString &name, const QString &version = QString() );
%Docstring
Unregisters API from its name and version
:param name: the name of the service
:param version: (optional) the specific version to unload
:return: the number of APIs unregistered
If the version is not specified then all versions from the specified API
are unloaded
.. versionadded:: 3.10
%End
QgsServerApi *getApi( const QString &name, const QString &version = QString() );
%Docstring
Retrieves an API from its name
If the version is not provided the higher version of the service is
returned
:param name: the name of the API
:param version: the version string (optional)
:return: :py:class:`QgsServerApi`
.. versionadded:: 3.10
%End
int unregisterService( const QString &name, const QString &version = QString() );
%Docstring
Unregister service from its name and version
:param name: the name of the service
:param version: (optional) the specific version to unload
:return: the number of services unregistered
If the version is not specified then all versions from the specified
service are unloaded
%End
void init( const QString &nativeModulepath, QgsServerInterface *serverIface = 0 );
%Docstring
Initialize registry, load modules and auto register services
:param serverIface: the server interface
:param nativeModulepath: the native module path
%End
void cleanUp();
%Docstring
Clean up registered service and unregister modules
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/server/qgsserviceregistry.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
