Class ServiceDefinition

• Defined in File CSPFoundation.h

Class Documentation

class ServiceDefinition

Represents definition for identifying and versioning an external service endpoint.

Public Functions

inline ServiceDefinition()

inline ServiceDefinition(const csp::common::String &InURI, const uint32_t InVersion)

inline csp::common::String GetURI() const

Gets the URI for the service endpoint.

Returns

csp::common::String : URI of the service endpoint.

inline void SetURI(const csp::common::String &InURI)

Sets the URI for the service endpoint.

Parameters

InURI – const csp::common::String& : URI for service endpoint.

inline int32_t GetVersion() const

Gets the current version of the service endpoint.

Returns

int32_t : Representing the current version of the service endpoint.

inline void SetVersion(const uint32_t InVersion)

Sets the current Version for the service endpoint.

Parameters

InVersion – const uint32_t : Version for service endpoint.

bool CheckPrerequisites(const csp::systems::ServicesDeploymentStatus &ServicesDeploymentStatus) const

Compares the service definition against services deployment status to evaluate state differences.

This function analyzes the provided ServiceDefinition and compares it with the corresponding ServicesDeploymentStatus to determine the differences between the two. The comparison is performed with respect to a defined set of service states: ‘Latest’, ‘Deployed’, ‘Deprecated’, and ‘Retired’.

Parameters

ServicesDeploymentStatus – const csp::systems::ServicesDeploymentStatus& : The current status information against which the service definition is compared.

Returns

bool : true if all services are available, false otherwise