status

Documentation

Index

• func ConnectToKVStores(s events.Stream, log *logrus.Logger, defs rctypes.Definitions, ...)
• func DeleteCondition(kind rctypes.Kind, facility, condID string) error
• func GetAllConditions(kind rctypes.Kind, facility string) ([]nats.KeyValueEntry, error)
• func GetConditionKV(kind rctypes.Kind) (nats.KeyValue, error)
• func GetSingleCondition(kind rctypes.Kind, facility, condID string) (nats.KeyValueEntry, error)
• func WatchConditionStatus(ctx context.Context, kind rctypes.Kind, facility string) (nats.KeyWatcher, error)

Functions

func ConnectToKVStores

func ConnectToKVStores(s events.Stream, log *logrus.Logger,
	defs rctypes.Definitions, opts ...kv.Option,
)

ConnectToKVStores initializes all status KVs in preparation for monitoring status updates Any errors here are fatal, as we are failing to initialize something we are explicitly configured for.

func DeleteCondition

func DeleteCondition(kind rctypes.Kind, facility, condID string) error

DeleteCondition does what it says on the tin. If this does not return an error, the KV entry is gone.

func GetAllConditions

func GetAllConditions(kind rctypes.Kind, facility string) ([]nats.KeyValueEntry, error)

GetAllConditions returns all conditions for a specific type and facility. This includes any entry in any state, provided it has not been reaped by TTL.

func GetConditionKV

func GetConditionKV(kind rctypes.Kind) (nats.KeyValue, error)

GetConditionKV returns the raw NATS KeyValue interface for the bucket associated with the given condition type. This is a really low-level access, but if you want a handle to the raw NATS API, here it is.

func GetSingleCondition

func GetSingleCondition(kind rctypes.Kind, facility, condID string) (nats.KeyValueEntry, error)

GetSingleCondition does exactly that given a kind, facility, and condition-id

func WatchConditionStatus

func WatchConditionStatus(ctx context.Context, kind rctypes.Kind, facility string) (nats.KeyWatcher, error)

WatchConditionStatus specializes some generic NATS functionality, mainly to keep the callers cleaner of the NATS-specific details.