Provides a way to retrieve settings by prioritizing according to environment variables, ini file and default values. More...

#include <qgsserversettings.h>

Classes
struct	Setting

Public Member Functions
	QgsServerSettings ()
	Constructor. More...

QString	apiResourcesDirectory () const
	Returns the server-wide base directory where HTML templates and static assets (e.g. More...

qlonglong	apiWfs3MaxLimit () const
	Returns the server-wide maximum allowed value for "limit" in a features request. More...

QString	cacheDirectory () const
	Returns the cache directory. More...

qint64	cacheSize () const
	Returns the cache size. More...

QString	iniFile () const
	Returns the ini file loaded by QSetting. More...

void	load ()
	Load settings according to current environment variables. More...

bool	load (const QString &envVarName)
	Load setting for a specific environment variable name. More...

QString	logFile () const
	Returns the log file. More...

Qgis::MessageLevel	logLevel () const
	Returns the log level. More...

bool	logStderr () const
	Returns whether logging to stderr is activated. More...

void	logSummary () const
	Log a summary of settings currently loaded. More...

int	maxCacheLayers () const
	Returns the maximum number of cached layers. More...

int	maxThreads () const
	Returns the maximum number of threads to use. More...

QString	overrideSystemLocale () const
	Overrides system locale. More...

bool	parallelRendering () const
	Returns parallel rendering setting. More...

QString	projectFile () const
	Returns the QGS project file to use. More...

bool	showGroupSeparator () const
	Show group (thousand) separator. More...

int	wmsMaxHeight () const
	Returns the server-wide max height of a WMS GetMap request. More...

int	wmsMaxWidth () const
	Returns the server-wide max width of a WMS GetMap request. More...

Detailed Description

Provides a way to retrieve settings by prioritizing according to environment variables, ini file and default values.

Since: QGIS 3.0

Definition at line 81 of file qgsserversettings.h.

Constructor & Destructor Documentation

◆ QgsServerSettings()

QgsServerSettings::QgsServerSettings ( )

Constructor.

Definition at line 25 of file qgsserversettings.cpp.

Member Function Documentation

◆ apiResourcesDirectory()

QString QgsServerSettings::apiResourcesDirectory ( ) const

Returns the server-wide base directory where HTML templates and static assets (e.g.

images, js and css files) are searched for.

The default path is calculated by joining QgsApplication::pkgDataPath() with "resources/server/api", this path can be changed by setting the environment variable QGIS_SERVER_API_RESOURCES_DIRECTORY.

Since: QGIS 3.10

Definition at line 412 of file qgsserversettings.cpp.

◆ apiWfs3MaxLimit()

qlonglong QgsServerSettings::apiWfs3MaxLimit ( ) const

Returns the server-wide maximum allowed value for "limit" in a features request.

The default value is 10000, this value can be changed by setting the environment variable QGIS_SERVER_API_WFS3_MAX_LIMIT.

Since: QGIS 3.10

Definition at line 417 of file qgsserversettings.cpp.

◆ cacheDirectory()

QString QgsServerSettings::cacheDirectory ( ) const

Returns the cache directory.

Returns: the directory.

Definition at line 387 of file qgsserversettings.cpp.

◆ cacheSize()

qint64 QgsServerSettings::cacheSize ( ) const

Returns the cache size.

Returns: the cache size.

Definition at line 382 of file qgsserversettings.cpp.

◆ iniFile()

QString QgsServerSettings::iniFile ( ) const

Returns the ini file loaded by QSetting.

Returns: the path of the ini file or an empty string if none is loaded.

Definition at line 342 of file qgsserversettings.cpp.

◆ load() [1/2]

void QgsServerSettings::load ( )

Load settings according to current environment variables.

Definition at line 213 of file qgsserversettings.cpp.

◆ load() [2/2]

bool QgsServerSettings::load ( const QString & envVarName )

Load setting for a specific environment variable name.

Returns: true if loading is successful, false in case of an invalid name.

Definition at line 229 of file qgsserversettings.cpp.

◆ logFile()

QString QgsServerSettings::logFile ( ) const

Returns the log file.

Returns: the path of the log file or an empty string if none is defined.

Definition at line 357 of file qgsserversettings.cpp.

◆ logLevel()

Qgis::MessageLevel QgsServerSettings::logLevel ( ) const

Returns the log level.

Returns: the log level.

Definition at line 367 of file qgsserversettings.cpp.

◆ logStderr()

bool QgsServerSettings::logStderr ( ) const

Returns whether logging to stderr is activated.

Returns: true if logging to stderr is activated, false otherwise.

Since: QGIS 3.4

Definition at line 362 of file qgsserversettings.cpp.

◆ logSummary()

void QgsServerSettings::logSummary ( ) const

Log a summary of settings currently loaded.

Definition at line 319 of file qgsserversettings.cpp.

◆ maxCacheLayers()

int QgsServerSettings::maxCacheLayers ( ) const

Returns the maximum number of cached layers.

Returns: the number of cached layers.

Definition at line 372 of file qgsserversettings.cpp.

◆ maxThreads()

int QgsServerSettings::maxThreads ( ) const

Returns the maximum number of threads to use.

Returns: the number of threads.

Definition at line 352 of file qgsserversettings.cpp.

◆ overrideSystemLocale()

QString QgsServerSettings::overrideSystemLocale ( ) const

Overrides system locale.

Returns: the optional override for system locale.

Since: QGIS 3.8

Definition at line 392 of file qgsserversettings.cpp.

◆ parallelRendering()

bool QgsServerSettings::parallelRendering ( ) const

Returns parallel rendering setting.

Returns: true if parallel rendering is activated, false otherwise.

Definition at line 347 of file qgsserversettings.cpp.

◆ projectFile()

QString QgsServerSettings::projectFile ( ) const

Returns the QGS project file to use.

Returns: the path of the QGS project or an empty string if none is defined.

Definition at line 377 of file qgsserversettings.cpp.

◆ showGroupSeparator()

bool QgsServerSettings::showGroupSeparator ( ) const

Show group (thousand) separator.

Returns: if group separator must be shown, default to false.

Since: QGIS 3.8

Definition at line 397 of file qgsserversettings.cpp.

◆ wmsMaxHeight()

int QgsServerSettings::wmsMaxHeight ( ) const

Returns the server-wide max height of a WMS GetMap request.

The lower one of this and the project configuration is used.

Returns: the max height of a WMS GetMap request.

Since: QGIS 3.8

Definition at line 402 of file qgsserversettings.cpp.

◆ wmsMaxWidth()

int QgsServerSettings::wmsMaxWidth ( ) const

Returns the server-wide max width of a WMS GetMap request.