Common System 0.2.0
Common interfaces and patterns for system integration
Loading...
Searching...
No Matches
app_liveness_check Class Reference
Inheritance diagram for app_liveness_check:
Inheritance graph
Collaboration diagram for app_liveness_check:
Collaboration graph

Public Member Functions

std::string get_name () const override
 Get the unique name of this health check.
 
health_check_type get_type () const override
 Get the type of this health check.
 
bool is_critical () const override
 Check if this health check is critical.
 
health_check_result check () override
 Perform the health check.
 
- Public Member Functions inherited from kcenon::common::interfaces::health_check
 health_check ()=default
 
virtual ~health_check ()=default
 
 health_check (const health_check &)=delete
 
health_checkoperator= (const health_check &)=delete
 
 health_check (health_check &&)=delete
 
health_checkoperator= (health_check &&)=delete
 
virtual std::chrono::milliseconds get_timeout () const
 Get timeout duration for this health check.
 

Detailed Description

Examples
health_check_example.cpp.

Definition at line 28 of file health_check_example.cpp.

Member Function Documentation

◆ check()

health_check_result app_liveness_check::check ( )
inlineoverridevirtual

Perform the health check.

Returns
Health check result containing status and details

Implements kcenon::common::interfaces::health_check.

Examples
health_check_example.cpp.

Definition at line 35 of file health_check_example.cpp.

36 {
38 result.status = health_status::healthy;
39 result.message = "Application is running";
40 return result;
41 }

References kcenon::common::interfaces::health_check_result::message, and kcenon::common::interfaces::health_check_result::status.

◆ get_name()

std::string app_liveness_check::get_name ( ) const
inlineoverridevirtual

Get the unique name of this health check.

Returns
Health check name

Implements kcenon::common::interfaces::health_check.

Examples
health_check_example.cpp.

Definition at line 31 of file health_check_example.cpp.

31{ return "app_liveness"; }

◆ get_type()

health_check_type app_liveness_check::get_type ( ) const
inlineoverridevirtual

Get the type of this health check.

Returns
Health check type

Implements kcenon::common::interfaces::health_check.

Examples
health_check_example.cpp.

Definition at line 32 of file health_check_example.cpp.

32{ return health_check_type::liveness; }

◆ is_critical()

bool app_liveness_check::is_critical ( ) const
inlineoverridevirtual

Check if this health check is critical.

Critical health checks affect the overall system health status. Non-critical checks are reported but don't impact system health.

Returns
true if this is a critical health check

Implements kcenon::common::interfaces::health_check.

Examples
health_check_example.cpp.

Definition at line 33 of file health_check_example.cpp.

33{ return true; }

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