Kanzi Connect  3.9.8
Kanzi Connect C++ API
kanzi::connect::AbstractService::ServiceDescription Class Reference

#include <abstract_service.hpp>

Classes

class  Version
 Encapsulates version information. More...
 

Public Types

enum  Persistence { StartOnDemand, AlwaysRunning }
 
typedef enum kanzi::connect::AbstractService::ServiceDescription::Persistence Persistence
 

Public Member Functions

 ServiceDescription (ServiceDescription::Version version=ServiceDescription::Version(), ServiceDescription::Version minVersion=ServiceDescription::Version(), ServiceDescription::Persistence persistence=AlwaysRunning)
 C++ constructor. More...
 
bool valid () const
 Is the object validly constructed. More...
 

Public Attributes

bool m_manualPersistenceOverride
 Whether persistence functionality has been manually overridden. More...
 
Version m_minCompatibleVersion
 Minimum compatible version. More...
 
Persistence m_persistence
 Execution type. More...
 
Version m_version
 The version. More...
 

Member Typedef Documentation

◆ Persistence

Member Enumeration Documentation

◆ Persistence

Enumerator
StartOnDemand 

Service starts and shutdowns automatically when clients connect/disconnect.

AlwaysRunning 

Service is always running regardless whether there are any clients connected.

Constructor & Destructor Documentation

◆ ServiceDescription()

kanzi::connect::AbstractService::ServiceDescription::ServiceDescription ( ServiceDescription::Version  version = ServiceDescription::Version(),
ServiceDescription::Version  minVersion = ServiceDescription::Version(),
ServiceDescription::Persistence  persistence = AlwaysRunning 
)

C++ constructor.

Parameters
versiondefault version
minVersionminimum acceptable version

Member Function Documentation

◆ valid()

bool kanzi::connect::AbstractService::ServiceDescription::valid ( ) const

Is the object validly constructed.

Member Data Documentation

◆ m_manualPersistenceOverride

bool kanzi::connect::AbstractService::ServiceDescription::m_manualPersistenceOverride

Whether persistence functionality has been manually overridden.

◆ m_minCompatibleVersion

Version kanzi::connect::AbstractService::ServiceDescription::m_minCompatibleVersion

Minimum compatible version.

◆ m_persistence

Persistence kanzi::connect::AbstractService::ServiceDescription::m_persistence

Execution type.

◆ m_version

Version kanzi::connect::AbstractService::ServiceDescription::m_version

The version.


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