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

#include <abstract_service.hpp>

Public Types

enum  State {
  Undefined = 0, Initializing, Running, Stopped,
  Failed, Upgrading
}
 

Public Member Functions

bool initialized () const
 Checks whether service has been successfully initialized. More...
 
bool running () const
 Checks whether service is running. More...
 
 ServiceState (int State=Undefined, string description=string())
 c++ constructor More...
 
bool stopped () const
 Checks whether service is stopped. More...
 

Public Attributes

int m_state
 Service state value. More...
 
string m_stateDescription
 detailed description More...
 

Member Enumeration Documentation

◆ State

Enumerator
Undefined 

-> not initialized. hardly ever exposed to outside.

Initializing 

-> under initialization.

Running 

Running.

Stopped 

Stopped.

Failed 

Some error occurred.

Upgrading 

under upgrade.

Constructor & Destructor Documentation

◆ ServiceState()

kanzi::connect::AbstractService::ServiceState::ServiceState ( int  State = Undefined,
string  description = string() 
)

c++ constructor

Member Function Documentation

◆ initialized()

bool kanzi::connect::AbstractService::ServiceState::initialized ( ) const
inline

Checks whether service has been successfully initialized.

Returns
true if service is initialized.

◆ running()

bool kanzi::connect::AbstractService::ServiceState::running ( ) const
inline

Checks whether service is running.

Returns
true if service is running.

◆ stopped()

bool kanzi::connect::AbstractService::ServiceState::stopped ( ) const
inline

Checks whether service is stopped.

Returns
true if service is stopped.

Member Data Documentation

◆ m_state

int kanzi::connect::AbstractService::ServiceState::m_state

Service state value.

◆ m_stateDescription

string kanzi::connect::AbstractService::ServiceState::m_stateDescription

detailed description


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