senzing::sdk::core::SzCoreDiagnostic Class Reference

Core implementation of SzDiagnostic backed by the native SzDiagnostic_* module. More...

#include <SzCoreDiagnostic.hpp>

Inheritance diagram for senzing::sdk::core::SzCoreDiagnostic:

Collaboration diagram for senzing::sdk::core::SzCoreDiagnostic:

Public Member Functions
	SzCoreDiagnostic (SzCoreEnvironment &env)
	Constructs and initializes the native diagnostic module using the owning environment's settings.
	~SzCoreDiagnostic () override=default
	SzCoreDiagnostic (const SzCoreDiagnostic &)=delete
SzCoreDiagnostic &	operator= (const SzCoreDiagnostic &)=delete
std::string	GetRepositoryInfo () override
	Returns JSON describing the repository (datastore) configuration/state.
std::string	CheckRepositoryPerformance (int32_t secondsToRun) override
	Runs a timed repository performance check for secondsToRun seconds and returns the resulting JSON.
void	PurgeRepository () override
	Purges all records from the repository. Irreversible.
std::string	GetFeature (int64_t featureID) override
	Returns JSON describing the feature identified by featureID.
void	Destroy ()
	Destroys the native diagnostic module.
bool	IsDestroyed ()
	True once the native module has been destroyed.
Public Member Functions inherited from senzing::sdk::SzDiagnostic
virtual	~SzDiagnostic ()=default

Detailed Description

Core implementation of SzDiagnostic backed by the native SzDiagnostic_* module.

Constructor & Destructor Documentation

SzCoreDiagnostic() [1/2]

senzing::sdk::core::SzCoreDiagnostic::SzCoreDiagnostic ( SzCoreEnvironment &  env )

explicit

Constructs and initializes the native diagnostic module using the owning environment's settings.

Throws the mapped SzException on init failure.

~SzCoreDiagnostic()

senzing::sdk::core::SzCoreDiagnostic::~SzCoreDiagnostic ( )

overridedefault

SzCoreDiagnostic() [2/2]

senzing::sdk::core::SzCoreDiagnostic::SzCoreDiagnostic ( const SzCoreDiagnostic &  )

delete

Member Function Documentation

CheckRepositoryPerformance()

std::string senzing::sdk::core::SzCoreDiagnostic::CheckRepositoryPerformance ( int32_t  secondsToRun )

overridevirtual

Runs a timed repository performance check for secondsToRun seconds and returns the resulting JSON.

Implements senzing::sdk::SzDiagnostic.

Destroy()

void senzing::sdk::core::SzCoreDiagnostic::Destroy

(

)

Destroys the native diagnostic module.

Idempotent; called by the owning environment during teardown.

GetFeature()

std::string senzing::sdk::core::SzCoreDiagnostic::GetFeature ( int64_t  featureID )

overridevirtual

Returns JSON describing the feature identified by featureID.

[SzConfigRetryable]

Implements senzing::sdk::SzDiagnostic.

GetRepositoryInfo()

std::string senzing::sdk::core::SzCoreDiagnostic::GetRepositoryInfo ( )

overridevirtual

Returns JSON describing the repository (datastore) configuration/state.

Implements senzing::sdk::SzDiagnostic.

IsDestroyed()

bool senzing::sdk::core::SzCoreDiagnostic::IsDestroyed

(

)

True once the native module has been destroyed.

operator=()

SzCoreDiagnostic & senzing::sdk::core::SzCoreDiagnostic::operator= ( const SzCoreDiagnostic &  )

delete

PurgeRepository()

void senzing::sdk::core::SzCoreDiagnostic::PurgeRepository ( )

overridevirtual

Purges all records from the repository. Irreversible.

Implements senzing::sdk::SzDiagnostic.

---

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

• senzing/sdk/core/SzCoreDiagnostic.hpp