QgsServiceRegistry Class Reference

QgsServiceRegistry Class defining the registry manager for QGIS server services. More...

#include <qgsserviceregistry.h>

Public Member Functions
	QgsServiceRegistry ()=default
	Constructor. More...
	~QgsServiceRegistry ()
	Destructor. More...
void	cleanUp ()
	Clean up registered service and unregister modules. More...
QgsService *	getService (const QString &name, const QString &version=QString())
	Retrieve a service from its name. More...
void	init (const QString &nativeModulepath, QgsServerInterface *serverIface=nullptr)
	Initialize registry, load modules and auto register services. More...
void	registerService (QgsService *service)
	Register a service by its name and version. More...
int	unregisterService (const QString &name, const QString &version=QString())
	Unregister service from its name and version. More...

Detailed Description

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

Since

QGIS 3.0

Definition at line 47 of file qgsserviceregistry.h.

Constructor & Destructor Documentation

QgsServiceRegistry::QgsServiceRegistry ( )

default

Constructor.

QgsServiceRegistry::~QgsServiceRegistry

(

)

Destructor.

Definition at line 84 of file qgsserviceregistry.cpp.

Member Function Documentation

void QgsServiceRegistry::cleanUp

(

)

Clean up registered service and unregister modules.

Definition at line 231 of file qgsserviceregistry.cpp.

QgsService * QgsServiceRegistry::getService	(	const QString &	name,
		const QString &	version = QString()
	)

Retrieve a service from its name.

Parameters

name	the name of the service
version	the version string (optional)

Returns

QgsService

If the version is not provided the higher version of the service is returned

Definition at line 89 of file qgsserviceregistry.cpp.

void QgsServiceRegistry::init	(	const QString &	nativeModulepath,
		QgsServerInterface *	serverIface = nullptr
	)

Initialize registry, load modules and auto register services.

Parameters

serverIface	the server interface
nativeModulepath	the native module path

Definition at line 226 of file qgsserviceregistry.cpp.

void QgsServiceRegistry::registerService

(

QgsService *

service

)

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 gain ownership of services and will call 'delete' on cleanup

Parameters

service

a QgsService to be registered

Definition at line 118 of file qgsserviceregistry.cpp.

int QgsServiceRegistry::unregisterService	(	const QString &	name,
		const QString &	version = QString()
	)

Unregister service from its name and version.

Parameters

name	the tame of the service
version	(optional) the specific version to unload

Returns

the number of services unregistered

If the version is not specified then all versions from the specified service are unloaded

Definition at line 162 of file qgsserviceregistry.cpp.

---

The documentation for this class was generated from the following files:

• /build/qgis-3.4.15+24xenial/src/server/qgsserviceregistry.h
• /build/qgis-3.4.15+24xenial/src/server/qgsserviceregistry.cpp