cache

Documentation

Index

• Variables
• type CacheEntry
• type CachedContextFunc
• type CachedContextKeyFunc
• type CachedContextKeyFuncState
  • func (state *CachedContextKeyFuncState[T, K]) Cleanup()
• type CachedFuncBuilder
  • func NewFunc[T any](fn CachedContextFunc[T]) CachedFuncBuilder[T]
  • func (builder CachedFuncBuilder[T]) Build() CachedContextFunc[T]
  • func (builder CachedFuncBuilder[T]) WithRetriesConstantBackoff(retries int, interval time.Duration) CachedFuncBuilder[T]
  • func (builder CachedFuncBuilder[T]) WithRetriesExponentialBackoff(retries int) CachedFuncBuilder[T]
  • func (builder CachedFuncBuilder[T]) WithRetriesZeroBackoff(retries int) CachedFuncBuilder[T]
  • func (builder CachedFuncBuilder[T]) WithTTL(ttl time.Duration) CachedFuncBuilder[T]
• type CachedFuncConfig
• type CachedFuncState
• type CachedKeyFuncBuilder
  • func NewKeyFunc[T any, K comparable](fn CachedContextKeyFunc[T, K]) CachedKeyFuncBuilder[T, K]
  • func (builder CachedKeyFuncBuilder[T, K]) Build() CachedContextKeyFunc[T, K]
  • func (builder CachedKeyFuncBuilder[T, K]) WithCleanupInterval(cleanupInterval time.Duration) CachedKeyFuncBuilder[T, K]
  • func (builder CachedKeyFuncBuilder[T, K]) WithMaxEntries(maxEntries int) CachedKeyFuncBuilder[T, K]
  • func (builder CachedKeyFuncBuilder[T, K]) WithRetriesConstantBackoff(retries int, interval time.Duration) CachedKeyFuncBuilder[T, K]
  • func (builder CachedKeyFuncBuilder[T, K]) WithRetriesExponentialBackoff(retries int) CachedKeyFuncBuilder[T, K]
  • func (builder CachedKeyFuncBuilder[T, K]) WithRetriesZeroBackoff(retries int) CachedKeyFuncBuilder[T, K]
  • func (builder CachedKeyFuncBuilder[T, K]) WithTTL(ttl time.Duration) CachedKeyFuncBuilder[T, K]
• type State

Variables

var Janitor = newStatesJanitor()

Types

type CacheEntry

type CacheEntry[T any] struct {
	sync.Mutex
	// contains filtered or unexported fields
}

type CachedContextFunc

type CachedContextFunc[T any] func(ctx context.Context) (T, error)

type CachedContextKeyFunc

type CachedContextKeyFunc[T any, K comparable] func(ctx context.Context, key K) (T, error)

type CachedContextKeyFuncState

type CachedContextKeyFuncState[T any, K comparable] struct {
	CachedKeyFuncBuilder[T, K]
	// contains filtered or unexported fields
}

func (*CachedContextKeyFuncState[T, K]) Cleanup

func (state *CachedContextKeyFuncState[T, K]) Cleanup()

type CachedFuncBuilder

type CachedFuncBuilder[T any] struct {
	CachedFuncConfig
	// contains filtered or unexported fields
}

func NewFunc

func NewFunc[T any](fn CachedContextFunc[T]) CachedFuncBuilder[T]

NewFunc creates a new CachedFuncBuilder with the given CachedContextFunc).

func (CachedFuncBuilder[T]) Build

func (builder CachedFuncBuilder[T]) Build() CachedContextFunc[T]

func (CachedFuncBuilder[T]) WithRetriesConstantBackoff

func (builder CachedFuncBuilder[T]) WithRetriesConstantBackoff(retries int, interval time.Duration) CachedFuncBuilder[T]

func (CachedFuncBuilder[T]) WithRetriesExponentialBackoff

func (builder CachedFuncBuilder[T]) WithRetriesExponentialBackoff(retries int) CachedFuncBuilder[T]

func (CachedFuncBuilder[T]) WithRetriesZeroBackoff

func (builder CachedFuncBuilder[T]) WithRetriesZeroBackoff(retries int) CachedFuncBuilder[T]

func (CachedFuncBuilder[T]) WithTTL

func (builder CachedFuncBuilder[T]) WithTTL(ttl time.Duration) CachedFuncBuilder[T]

type CachedFuncConfig

type CachedFuncConfig struct {
	// contains filtered or unexported fields
}

type CachedFuncState

type CachedFuncState[T any] struct {
	CachedFuncBuilder[T]
	sync.Mutex
	// contains filtered or unexported fields
}

type CachedKeyFuncBuilder

type CachedKeyFuncBuilder[T any, K comparable] struct {
	CachedFuncConfig
	// contains filtered or unexported fields
}

func NewKeyFunc

func NewKeyFunc[T any, K comparable](fn CachedContextKeyFunc[T, K]) CachedKeyFuncBuilder[T, K]

NewKeyFunc creates a new CachedKeyFuncBuilder with the given CachedContextKeyFunc and default options (15 seconds cleanup interval).

func (CachedKeyFuncBuilder[T, K]) Build

func (builder CachedKeyFuncBuilder[T, K]) Build() CachedContextKeyFunc[T, K]

func (CachedKeyFuncBuilder[T, K]) WithCleanupInterval

func (builder CachedKeyFuncBuilder[T, K]) WithCleanupInterval(cleanupInterval time.Duration) CachedKeyFuncBuilder[T, K]

WithCleanupInterval configures new CachedKeyFuncBuilder instance with the given cleanupInterval. MaxEntries must be set for this to have any effect.

func (CachedKeyFuncBuilder[T, K]) WithMaxEntries

func (builder CachedKeyFuncBuilder[T, K]) WithMaxEntries(maxEntries int) CachedKeyFuncBuilder[T, K]

WithMaxEntries configures new CachedKeyFuncBuilder instance with the given maxEntries.

func (CachedKeyFuncBuilder[T, K]) WithRetriesConstantBackoff

func (builder CachedKeyFuncBuilder[T, K]) WithRetriesConstantBackoff(retries int, interval time.Duration) CachedKeyFuncBuilder[T, K]

func (CachedKeyFuncBuilder[T, K]) WithRetriesExponentialBackoff

func (builder CachedKeyFuncBuilder[T, K]) WithRetriesExponentialBackoff(retries int) CachedKeyFuncBuilder[T, K]

func (CachedKeyFuncBuilder[T, K]) WithRetriesZeroBackoff

func (builder CachedKeyFuncBuilder[T, K]) WithRetriesZeroBackoff(retries int) CachedKeyFuncBuilder[T, K]

func (CachedKeyFuncBuilder[T, K]) WithTTL

func (builder CachedKeyFuncBuilder[T, K]) WithTTL(ttl time.Duration) CachedKeyFuncBuilder[T, K]

type State

type State interface {
	// Cleanup must be concurrency-safe.
	Cleanup()
}