cache

Documentation

Index

• type Cache

Types

type Cache

type Cache interface {
	// Update updates system status from status.
	UpdateStatus(status *pb.SystemStatus) error

	// Read obtains last known system status.
	// If nil status is returned, empty system status will be
	// assumed as defined by pb.EmptyStatus.
	RecentStatus() (*pb.SystemStatus, error)

	// Recycle is a periodic request to recycle any resources
	// cache might be holding on to. The request can also be used
	// to clean up stale state.
	Recycle() error

	// Close resets the cache and closes any resources.
	Close() error
}

Cache provides access to recent health status information collected on a per-node basis. All methods are expected to be thread-safe.