Class ApplicationAvailability

Namespace

Steeltoe.Common.Availability

Assembly

Steeltoe.Common.dll

public class ApplicationAvailability

Inheritance

object

ApplicationAvailability

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ApplicationAvailability(ILogger<ApplicationAvailability>)

public ApplicationAvailability(ILogger<ApplicationAvailability> logger = null)

Parameters

logger ILogger<ApplicationAvailability>

Fields

LivenessKey

public readonly string LivenessKey

Field Value

string

ReadinessKey

public readonly string ReadinessKey

Field Value

string

Methods

GetAvailabilityState(string)

public IAvailabilityState GetAvailabilityState(string availabilityType)

Parameters

availabilityType string

Returns

IAvailabilityState

GetLivenessState()

public IAvailabilityState GetLivenessState()

Returns

IAvailabilityState

GetReadinessState()

public IAvailabilityState GetReadinessState()

Returns

IAvailabilityState

SetAvailabilityState(string, IAvailabilityState, string)

Set the availability state for a given availability type

public void SetAvailabilityState(string stateKey, IAvailabilityState newState, string caller)

Parameters

stateKey string

String name for the type of state to set. See LivenessKey or ReadinessKey for convenience

newState IAvailabilityState

The new IAvailabilityState

caller string

Logged at trace level for tracking origin of state change

Events

LivenessChanged

public event EventHandler LivenessChanged

Event Type

EventHandler

ReadinessChanged

public event EventHandler ReadinessChanged

Event Type

EventHandler