Kanzi Connect  3.9.8
Kanzi Connect C++ API
kanzi::connect::ServerConfig::Service Class Reference

Service configuration. More...

#include <serverconfig.hpp>

Inheritance diagram for kanzi::connect::ServerConfig::Service:
kanzi::connect::ServerConfig::AttributeProviderBase

Public Member Functions

bool depends (const string &service)
 Does this service depend on some other service. More...
 
vector< string > getDependencies ()
 Retrieve service dependencies as list of strings. More...
 
const string & getLibrary () const
 Retrieve the library. More...
 
bool getMandatory () const
 Retrieve the mandatory status, i.e. More...
 
const string & getName () const
 Retrieve the configured name. More...
 
SecuritygetSecurity ()
 Retrieve security information related to a service. More...
 
 Service (const string &library, const string &name, const string mandatory="")
 C++ constructor. More...
 
- Public Member Functions inherited from kanzi::connect::ServerConfig::AttributeProviderBase
AttributeListgetAttributes ()
 Retrieve attributes. More...
 
const AttributeListgetAttributes () const
 Retrieve attributes. More...
 
virtual ~AttributeProviderBase ()=default
 

Additional Inherited Members

- Protected Attributes inherited from kanzi::connect::ServerConfig::AttributeProviderBase
AttributeList m_attributes
 attribute data More...
 

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
librarythe library for the service.
namethe name for the service
mandatoryif 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
servicethe 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: