checkstore

Documentation

Index

• type Shim
  • func NewStore(log hclog.Logger, db state.StateDB) Shim

Types

type Shim

type Shim interface {
	// Set the latest result for a specific check.
	Set(allocID string, result *structs.CheckQueryResult) error

	// List the latest results for a specific allocation.
	List(allocID string) map[structs.CheckID]*structs.CheckQueryResult

	// Difference returns the set of IDs being stored that are not in ids.
	Difference(allocID string, ids []structs.CheckID) []structs.CheckID

	// Remove will remove ids from the cache and persistent store.
	Remove(allocID string, ids []structs.CheckID) error

	// Purge results for a specific allocation.
	Purge(allocID string) error

	// Snapshot returns a copy of the current status of every check indexed by
	// checkID, for use by CheckWatcher.
	Snapshot() map[string]string
}

A Shim is used to track the latest check status information, one layer above the client persistent store so we can do efficient indexing, etc.

func NewStore

func NewStore(log hclog.Logger, db state.StateDB) Shim

NewStore creates a new store.