cache

Documentation

Index

• func Key(kind EntryKind, hash string) string
• func TransformActionCacheKey(key, instance string, logger Logger) string
• type EntryKind
  • func (e EntryKind) String() string
• type Error
  • func (e *Error) Error() string
• type Logger
• type Proxy

Functions

func Key

func Key(kind EntryKind, hash string) string

Key returns the proper cache key for an entry kind and hash.

func TransformActionCacheKey

func TransformActionCacheKey(key, instance string, logger Logger) string

TransformActionCacheKey takes an ActionCache key and an instance name and returns a new ActionCache key to use instead. If the instance name is empty, then the original key is returned unchanged.

Types

type EntryKind

type EntryKind int

EntryKind describes the kind of cache entry

const (
	// AC stands for Action Cache.
	AC EntryKind = iota

	// CAS stands for Content Addressable Storage.
	CAS

	// RAW cache items are not validated. Not exposed externally, only
	// used for HTTP when running with the --disable_http_ac_validation
	// commandline flag.
	RAW
)

func (EntryKind) String

func (e EntryKind) String() string

type Error

type Error struct {
	// Corresponds to a http.Status* code
	Code int
	// A human-readable string describing the error
	Text string
}

Error is used by Cache implementations to return a structured error.

func (*Error) Error

func (e *Error) Error() string

type Logger

type Logger interface {
	Printf(format string, v ...interface{})
}

Logger is designed to be satisfied by log.Logger.

type Proxy

type Proxy interface {
	// Put should make a reasonable effort to proxy this data to the backend.
	// This is allowed to fail silently (eg when under heavy load).
	Put(kind EntryKind, hash string, size int64, rdr io.ReadCloser)

	// Get should return the cache item identified by `hash`, or an error
	// if something went wrong. If the item was not found, the io.ReadCloser
	// will be nil.
	Get(kind EntryKind, hash string) (io.ReadCloser, int64, error)

	// Contains returns whether or not the cache item exists on the
	// remote end, and the size if it exists (and -1 if the size is
	// unknown).
	Contains(kind EntryKind, hash string) (bool, int64)
}

Proxy is the interface that (optional) proxy backends must implement. Implementations are expected to be safe for concurrent use.