QGIS API Documentation  3.10.0-A Coruña (6c816b4204)
Public Member Functions | List of all members
QgsService Class Referenceabstract

QgsService Class defining interfaces for QGIS server services. More...

#include <qgsservice.h>

Inheritance diagram for QgsService:
Inheritance graph
[legend]

Public Member Functions

 QgsService ()
 Constructor. More...
 
virtual ~QgsService ()=default
 Destructor. More...
 
virtual bool allowMethod (QgsServerRequest::Method) const =0
 Returns true if the given method is supported for that service. More...
 
virtual void executeRequest (const QgsServerRequest &request, QgsServerResponse &response, const QgsProject *project)=0
 Execute the requests and set result in QgsServerRequest. More...
 
virtual QString name () const =0
 
virtual QString version () const =0
 

Detailed Description

QgsService Class defining interfaces for QGIS server services.

This class provides methods for executing server requests They are registered at runtime for a given service name.

Since
QGIS 3.0

Definition at line 39 of file qgsservice.h.

Constructor & Destructor Documentation

◆ QgsService()

QgsService::QgsService ( )
default

Constructor.

◆ ~QgsService()

virtual QgsService::~QgsService ( )
virtualdefault

Destructor.

Member Function Documentation

◆ allowMethod()

virtual bool QgsService::allowMethod ( QgsServerRequest::Method  ) const
pure virtual

Returns true if the given method is supported for that service.

Implemented in QgsWms::Service, QgsWfs::Service, and QgsWcs::Service.

◆ executeRequest()

virtual void QgsService::executeRequest ( const QgsServerRequest request,
QgsServerResponse response,
const QgsProject project 
)
pure virtual

Execute the requests and set result in QgsServerRequest.

Implemented in QgsWms::Service, QgsWfs::Service, and QgsWcs::Service.

◆ name()

virtual QString QgsService::name ( ) const
pure virtual
Returns
the name of the service

Implemented in QgsWms::Service, QgsWfs::Service, and QgsWcs::Service.

◆ version()

virtual QString QgsService::version ( ) const
pure virtual
Returns
the version of the service

Implemented in QgsWms::Service, QgsWfs::Service, and QgsWcs::Service.


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