kanzi::connect::ServerConfig::Service Class Reference
Service configuration. More...
#include <serverconfig.hpp>
Inheritance diagram for kanzi::connect::ServerConfig::Service:
Public Member Functions | |
| bool | depends (const string &service) |
| Does this service depend on some other service. | |
| vector< string > | getDependencies () |
| Retrieve service dependencies as list of strings. | |
| const string & | getLibrary () const |
| Retrieve the library. | |
| bool | getMandatory () const |
| Retrieve the mandatory status, i.e. | |
| const string & | getName () const |
| Retrieve the configured name. | |
| Security & | getSecurity () |
| Retrieve security information related to a service. | |
| Service (const string &library, const string &name, const string mandatory="") | |
| C++ constructor. | |
 Public Member Functions inherited from kanzi::connect::ServerConfig::AttributeProviderBase | |
| AttributeList & | getAttributes () |
| Retrieve attributes. | |
| const AttributeList & | getAttributes () const |
| Retrieve attributes. | |
| virtual | ~AttributeProviderBase ()=default |
Additional Inherited Members | |
| Protected Attributes inherited from kanzi::connect::ServerConfig::AttributeProviderBase | |
| AttributeList | m_attributes |
| attribute data | |
Detailed Description
Service configuration.
Constructor & Destructor Documentation
◆ Service()
| kanzi::connect::ServerConfig::Service::Service | ( | const string & | library, |
| const string & | name, | ||
| const string | mandatory = "" ) |
C++ constructor.
initialize object
- Parameters
-
library the library for the service. name the name for the service mandatory if contains true|1 then this service is marked as mandatory.
Member Function Documentation
◆ depends()
| bool kanzi::connect::ServerConfig::Service::depends | ( | const string & | service | ) |
Does this service depend on some other service.
- Parameters
-
service the service
- Returns
- true if depends.
◆ getDependencies()
| vector< string > kanzi::connect::ServerConfig::Service::getDependencies | ( | ) |
Retrieve service dependencies as list of strings.
- Returns
- vector of dependency definitions.
◆ getLibrary()
| const string & kanzi::connect::ServerConfig::Service::getLibrary | ( | ) | const |
Retrieve the library.
- Returns
- library name
◆ getMandatory()
| bool kanzi::connect::ServerConfig::Service::getMandatory | ( | ) | const |
Retrieve the mandatory status, i.e.
whether everyting should fail if accessing this service fails
- Returns
- true if this service is marked as mandatory.
◆ getName()
| const string & kanzi::connect::ServerConfig::Service::getName | ( | ) | const |
Retrieve the configured name.
- Returns
- name
◆ getSecurity()
| Security & kanzi::connect::ServerConfig::Service::getSecurity | ( | ) |
Retrieve security information related to a service.
The documentation for this class was generated from the following file:
- connect/serverconfig.hpp