QGIS API Documentation
4.3.0-Master (16eddb2670e)
Toggle main menu visibility
Loading...
Searching...
No Matches
src
server
qgsservice.h
Go to the documentation of this file.
1
/***************************************************************************
2
qgsservice.h
3
4
Class defining the service interface for QGIS server services.
5
-------------------
6
begin : 2016-12-05
7
copyright : (C) 2016 by David Marteau
8
email : david dot marteau at 3liz dot com
9
***************************************************************************/
10
11
/***************************************************************************
12
* *
13
* This program is free software; you can redistribute it and/or modify *
14
* it under the terms of the GNU General Public License as published by *
15
* the Free Software Foundation; either version 2 of the License, or *
16
* (at your option) any later version. *
17
* *
18
***************************************************************************/
19
20
21
#ifndef QGSSERVICECOMPONENT_H
22
#define QGSSERVICECOMPONENT_H
23
24
#include "
qgsserverrequest.h
"
25
#include "
qgsserverresponse.h
"
26
27
class
QgsProject
;
28
37
class
SERVER_EXPORT
QgsService
38
{
39
#ifdef SIP_RUN
40
#include "
qgsserverrequest.h
"
41
#include "
qgsserverresponse.h
"
42
#endif
43
44
public
:
45
QgsService
();
46
virtual
~QgsService
() =
default
;
47
51
virtual
QString
name
()
const
= 0;
52
56
virtual
QString
version
()
const
= 0;
57
61
virtual
void
executeRequest
(
const
QgsServerRequest
&request,
QgsServerResponse
&response,
const
QgsProject
*project ) = 0;
62
};
63
64
#endif
QgsProject
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
Definition
qgsproject.h:114
QgsServerRequest
Defines requests passed to QgsService classes.
Definition
qgsserverrequest.h:36
QgsServerResponse
Defines the response interface passed to QgsService.
Definition
qgsserverresponse.h:42
QgsService::name
virtual QString name() const =0
Returns the name of the service.
QgsService::QgsService
QgsService()
Constructor.
QgsService::~QgsService
virtual ~QgsService()=default
QgsService::version
virtual QString version() const =0
Returns the version of the service.
QgsService::executeRequest
virtual void executeRequest(const QgsServerRequest &request, QgsServerResponse &response, const QgsProject *project)=0
Executes the requests and sets result in QgsServerRequest.
qgsserverrequest.h
qgsserverresponse.h
Generated on
for QGIS API Documentation by
1.17.0