A dummy service that reports internal metrics as service diagnostics. More...

#include <InternalDiagnosticsService.h>

Inheritance diagram for VLCB::InternalDiagnosticsService:

Public Member Functions
VlcbServiceTypes	getServiceID () const override
	Return a unique ID for this service.
byte	getServiceVersionID () const override
	Return the version of the service specification implemented by this service.
void	reportDiagnostics (byte serviceIndex, byte diagnosticsCode) override
	Report a given diagnostic value.
virtual int	getDiagnosticCount () override
	report how many diagnostics this service supports.
Public Member Functions inherited from VLCB::Service
void	setController (Controller *ctrl)
	Set a pointer to the controller object for use in implementing class.
virtual void	begin ()
	This optional method is called at the beginning of the Arduino sketch. Define this method for the service to do any setup required at the beginning.
virtual void	process ()
	This method that be called regularly from the VLCB core to let the service perform regular tasks.
virtual void	processAction (const Action &action)
	Called when there is an action available.
virtual Data	getServiceData ()
	Return Data bytes specific for the implementing service. The meaning of each data byte is defined in the service specification.

Additional Inherited Members
Protected Member Functions inherited from VLCB::Service
bool	isThisNodeNumber (unsigned int nodeNumber)
	Helper function to decide if a given node number is the same as that assigned to this node.
Protected Attributes inherited from VLCB::Service
Controller *	controller
	Pointer to the Controller object that can be used by implementing classes.

Detailed Description

A dummy service that reports internal metrics as service diagnostics.

Use this service to share internal metrics as diagnostics that can be viewed in configuration utilities. Supported diagnostics are: 1) Available memory 2) ActionQueue current size 3) ActionQueue high water mark 4) ActionQueue number of overflows

Member Function Documentation

◆ getServiceID()

VlcbServiceTypes VLCB::InternalDiagnosticsService::getServiceID ( ) const

inlineoverridevirtual

Return a unique ID for this service.

This ID is used by configuration utilities to identify the service type. The service IDs are listed in the VLCB service specifications.

Implements VLCB::Service.

◆ getServiceVersionID()

byte VLCB::InternalDiagnosticsService::getServiceVersionID ( ) const

inlineoverridevirtual

Return the version of the service specification implemented by this service.

This version is used by configuration utilities to identify which features are implemented by this service.

Implements VLCB::Service.

◆ reportDiagnostics()

void VLCB::InternalDiagnosticsService::reportDiagnostics	(	byte	serviceIndex,
		byte	diagnosticsCode )

overridevirtual

Report a given diagnostic value.

Parameters

serviceIndex	index of the service. Not used by the implementation, just passed through to the response message.
diagnosticsCode	code for the diagnostic to report. This code is specific to the implemented service.

Reimplemented from VLCB::Service.

◆ getDiagnosticCount()

int VLCB::InternalDiagnosticsService::getDiagnosticCount ( )

overridevirtual

report how many diagnostics this service supports.