2017-06-26 09:57:09 +02:00
|
|
|
/************************************************************************
|
|
|
|
* This file has been generated automatically from *
|
|
|
|
* *
|
|
|
|
* src/server/qgsservice.h *
|
|
|
|
* *
|
|
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
|
|
************************************************************************/
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2016-12-07 22:09:57 +01:00
|
|
|
class QgsService
|
|
|
|
{
|
2021-03-22 21:13:52 +01:00
|
|
|
%Docstring(signature="appended")
|
2021-01-30 09:16:35 +10:00
|
|
|
:py:class:`QgsService`
|
2017-12-15 10:36:55 -04:00
|
|
|
Class defining interfaces for QGIS server services
|
2017-06-26 09:57:09 +02:00
|
|
|
|
2017-12-15 10:36:55 -04:00
|
|
|
This class provides methods for executing server requests
|
|
|
|
They are registered at runtime for a given service name.
|
2017-06-26 09:57:09 +02:00
|
|
|
|
|
|
|
.. versionadded:: 3.0
|
|
|
|
%End
|
|
|
|
|
2016-12-07 22:09:57 +01:00
|
|
|
%TypeHeaderCode
|
|
|
|
#include "qgsservice.h"
|
|
|
|
#include "qgsserverrequest.h"
|
|
|
|
#include "qgsserverresponse.h"
|
|
|
|
%End
|
|
|
|
public:
|
|
|
|
|
|
|
|
QgsService();
|
2017-06-26 09:57:09 +02:00
|
|
|
%Docstring
|
|
|
|
Constructor
|
|
|
|
%End
|
2016-12-07 22:09:57 +01:00
|
|
|
|
|
|
|
virtual ~QgsService();
|
|
|
|
|
2016-12-14 13:44:57 +01:00
|
|
|
virtual QString name() const = 0;
|
2017-06-26 09:57:09 +02:00
|
|
|
%Docstring
|
2017-12-15 10:36:55 -04:00
|
|
|
|
|
|
|
:return: the name of the service
|
2017-06-26 09:57:09 +02:00
|
|
|
%End
|
2016-12-14 13:44:57 +01:00
|
|
|
|
|
|
|
virtual QString version() const = 0;
|
2017-06-26 09:57:09 +02:00
|
|
|
%Docstring
|
2017-12-15 10:36:55 -04:00
|
|
|
|
|
|
|
:return: the version of the service
|
2017-06-26 09:57:09 +02:00
|
|
|
%End
|
2016-12-07 22:09:57 +01:00
|
|
|
|
2017-06-26 09:57:09 +02:00
|
|
|
virtual void executeRequest( const QgsServerRequest &request,
|
|
|
|
QgsServerResponse &response,
|
2017-05-01 16:42:33 +02:00
|
|
|
const QgsProject *project ) = 0;
|
2017-06-26 09:57:09 +02:00
|
|
|
%Docstring
|
2017-12-19 11:43:52 -04:00
|
|
|
Execute the requests and set result in :py:class:`QgsServerRequest`
|
2017-06-26 09:57:09 +02:00
|
|
|
%End
|
2016-12-07 22:09:57 +01:00
|
|
|
};
|
|
|
|
|
2017-06-26 09:57:09 +02:00
|
|
|
|
|
|
|
/************************************************************************
|
|
|
|
* This file has been generated automatically from *
|
|
|
|
* *
|
|
|
|
* src/server/qgsservice.h *
|
|
|
|
* *
|
|
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
|
|
************************************************************************/
|