QGIS API Documentation  3.17.0-Master (a84647cf30)
Public Member Functions | List of all members
QgsServer Class Reference

The QgsServer class provides OGC web services. More...

#include <qgsserver.h>

Public Member Functions

 QgsServer ()
 Creates the server instance. More...
void handleRequest (QgsServerRequest &request, QgsServerResponse &response, const QgsProject *project=nullptr)
 Handles the request. More...
void putenv (const QString &var, const QString &val)
 Set environment variable. More...
QgsServerInterfaceImplserverInterface ()
 Returns a pointer to the server interface. More...

Detailed Description

The QgsServer class provides OGC web services.

Definition at line 48 of file qgsserver.h.

Constructor & Destructor Documentation

◆ QgsServer()

QgsServer::QgsServer ( )

Creates the server instance.

Definition at line 67 of file qgsserver.cpp.

Member Function Documentation

◆ handleRequest()

void QgsServer::handleRequest ( QgsServerRequest request,
QgsServerResponse response,
const QgsProject project = nullptr 

Handles the request.

The query string is normally read from environment but can be also passed in args and in this case overrides the environment variable

requesta QgsServerRequest holding request parameters
responsea QgsServerResponse for handling response I/O)
projecta QgsProject or nullptr, if it is NULLPTR the project is created from the MAP param specified in request or from the QGIS_PROJECT_FILE setting

Definition at line 297 of file qgsserver.cpp.

◆ putenv()

void QgsServer::putenv ( const QString &  var,
const QString &  val 

Set environment variable.

varenvironment variable name
QGIS 2.14

Definition at line 284 of file qgsserver.cpp.

◆ serverInterface()

QgsServerInterfaceImpl* QgsServer::serverInterface ( )

Returns a pointer to the server interface.

Definition at line 81 of file qgsserver.h.

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