Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

cache

package module

Go to main page

Versions in this module

v1

v1.0.1

Mar 30, 2026

retracted

v1.0.0

Mar 30, 2026

retracted

v0

v0.2.0

Mar 31, 2026

Changes in this version

+ type FactoryExecutionContext struct

+ HasStaleValue bool

+ Options *EntryOptions

+ StaleValue any

v0.1.2

Mar 30, 2026

v0.1.1

Mar 27, 2026

v0.1.0

Mar 27, 2026

Changes in this version

+ var ErrFactoryHardTimeout = fmt.Errorf("cache: factory hard timeout")

+ var ErrLockTimeout = fmt.Errorf("cache: stampede lock timeout")

+ func GetOrSet[T any](ctx context.Context, c Cache, key string, ...) (T, error)

+ func Get[T any](ctx context.Context, c Cache, key string, opts ...EntryOption) (T, bool, error)

+ type Cache interface

+ Clear func(ctx context.Context, clearL2 bool) error

+ Close func() error

+ DefaultEntryOptions func() EntryOptions

+ Delete func(ctx context.Context, key string, opts ...EntryOption) error

+ DeleteByTag func(ctx context.Context, tag string, opts ...EntryOption) error

+ Events func() *EventEmitter

+ Expire func(ctx context.Context, key string, opts ...EntryOption) error

+ Get func(ctx context.Context, key string, opts ...EntryOption) (any, bool, error)

+ GetOrSet func(ctx context.Context, key string, factory FactoryFunc, opts ...EntryOption) (any, error)

+ Name func() string

+ Set func(ctx context.Context, key string, value any, opts ...EntryOption) error

+ func New(opts ...Option) (Cache, error)

+ type EntryOption func(*EntryOptions)

+ func WithAllowStaleOnReadOnly() EntryOption

+ func WithAutoClone() EntryOption

+ func WithBackgroundL2Ops() EntryOption

+ func WithDistributedCacheTimeouts(soft, hard time.Duration) EntryOption

+ func WithDuration(d time.Duration) EntryOption

+ func WithEagerRefresh(threshold float32) EntryOption

+ func WithFactoryTimeouts(soft, hard time.Duration) EntryOption

+ func WithFailSafe(maxDuration, throttleDuration time.Duration) EntryOption

+ func WithJitter(max time.Duration) EntryOption

+ func WithLockTimeout(d time.Duration) EntryOption

+ func WithPriority(p EvictionPriority) EntryOption

+ func WithSize(n int64) EntryOption

+ func WithSkipL2() EntryOption

+ func WithSkipL2ReadWhenStale() EntryOption

+ func WithTags(tags ...string) EntryOption

+ type EntryOptions struct

+ AllowBackgroundBackplaneOperations bool

+ AllowBackgroundDistributedCacheOperations bool

+ AllowStaleOnReadOnly bool

+ AllowTimedOutFactoryBackgroundCompletion bool

+ DistributedCacheDuration time.Duration

+ DistributedCacheFailSafeMaxDuration time.Duration

+ DistributedCacheHardTimeout time.Duration

+ DistributedCacheSoftTimeout time.Duration

+ Duration time.Duration

+ EagerRefreshThreshold float32

+ EnableAutoClone bool

+ FactoryHardTimeout time.Duration

+ FactorySoftTimeout time.Duration

+ FailSafeMaxDuration time.Duration

+ FailSafeThrottleDuration time.Duration

+ IsFailSafeEnabled bool

+ JitterMaxDuration time.Duration

+ LockTimeout time.Duration

+ Priority EvictionPriority

+ ReThrowBackplaneExceptions bool

+ ReThrowDistributedCacheExceptions bool

+ ReThrowSerializationExceptions bool

+ Size int64

+ SkipBackplaneNotifications bool

+ SkipL1Read bool

+ SkipL1Write bool

+ SkipL2Read bool

+ SkipL2ReadWhenStale bool

+ SkipL2Write bool

+ Tags []string

+ type Event interface

+ type EventBackplaneCircuitBreakerStateChange struct

+ Open bool

+ type EventBackplaneReceived struct

+ Key string

+ Type backplane.MessageType

+ type EventBackplaneSent struct

+ Key string

+ Type backplane.MessageType

+ type EventCacheHit struct

+ IsStale bool

+ Key string

+ type EventCacheMiss struct

+ Key string

+ type EventEagerRefreshComplete struct

+ Key string

+ type EventEagerRefreshStarted struct

+ Key string

+ type EventEmitter struct

+ func (e *EventEmitter) On(handler EventHandler) (unsubscribe func())

+ type EventFactoryCall struct

+ Key string

+ type EventFactoryError struct

+ Err error

+ Key string

+ type EventFactorySuccess struct

+ Key string

+ Shared bool

+ type EventFailSafeActivated struct

+ Key string

+ StaleValue any

+ type EventHandler func(Event)

+ type EventHardTimeoutActivated struct

+ Key string

+ type EventL2CircuitBreakerStateChange struct

+ Open bool

+ type EventL2Error struct

+ Err error

+ Key string

+ type EventL2Hit struct

+ Key string

+ type EventL2Miss struct

+ Key string

+ type EventSoftTimeoutActivated struct

+ Key string

+ type EvictionPriority int

+ const PriorityHigh

+ const PriorityLow

+ const PriorityNeverRemove

+ const PriorityNormal

+ type FactoryFunc func(ctx context.Context) (any, error)

+ type Option func(*Options)

+ func WithBackplane(bp backplane.Backplane) Option

+ func WithBackplaneCircuitBreaker(threshold int, openDuration time.Duration) Option

+ func WithCacheName(name string) Option

+ func WithDefaultEntryOptions(eo EntryOptions) Option

+ func WithKeyPrefix(prefix string) Option

+ func WithL1(adapter l1.Adapter) Option

+ func WithL2(adapter l2.Adapter) Option

+ func WithL2CircuitBreaker(threshold int, openDuration time.Duration) Option

+ func WithLogger(logger *slog.Logger) Option

+ func WithNodeID(id string) Option

+ func WithSerializer(s serializer.Serializer) Option

+ type Options struct

+ AutoRecoveryDelay time.Duration

+ AutoRecoveryMaxRetries int

+ Backplane backplane.Backplane

+ BackplaneAutoRecovery bool

+ BackplaneCircuitBreakerDuration time.Duration

+ BackplaneCircuitBreakerThreshold int

+ CacheName string

+ DefaultEntryOptions EntryOptions

+ DistributedCacheCircuitBreakerDuration time.Duration

+ DistributedCacheCircuitBreakerThreshold int

+ IgnoreIncomingBackplaneNotifications bool

+ KeyPrefix string

+ L1 l1.Adapter

+ L2 l2.Adapter

+ Logger *slog.Logger

+ NodeID string

+ Serializer serializer.Serializer

+ SkipL2OnError bool