hypercache

Aug 23, 2025

Changes in this version

type Config

+ DistMemoryOptions []backend.DistMemoryOption

+ type DistMemoryBackendConstructor struct

+ func (DistMemoryBackendConstructor) Create(ctx context.Context, _ *Config[backend.DistMemory]) (backend.IBackend[backend.DistMemory], error)

type HyperCache

+ func (hyperCache *HyperCache[T]) ClusterOwners(key string) []string

+ func (hyperCache *HyperCache[T]) DistHeartbeatMetrics() any

+ func (hyperCache *HyperCache[T]) DistMembershipSnapshot() (members []struct{ ... }, replication int, vnodes int)

+ func (hyperCache *HyperCache[T]) DistMetrics() any

+ func (hyperCache *HyperCache[T]) DistRingHashSpots() []string

+ func (hyperCache *HyperCache[T]) EvictionAlgorithm() string

+ func (hyperCache *HyperCache[T]) EvictionInterval() time.Duration

+ func (hyperCache *HyperCache[T]) ExpirationInterval() time.Duration

+ func (hyperCache *HyperCache[T]) ManagementHTTPAddress() string

+ func (hyperCache *HyperCache[T]) TriggerExpiration()

+ type ManagementHTTPOption func(*ManagementHTTPServer)

+ func WithMgmtAuth(fn func(fiber.Ctx) error) ManagementHTTPOption

+ func WithMgmtReadTimeout(d time.Duration) ManagementHTTPOption

+ func WithMgmtWriteTimeout(d time.Duration) ManagementHTTPOption

+ type ManagementHTTPServer struct

+ func NewManagementHTTPServer(addr string, opts ...ManagementHTTPOption) *ManagementHTTPServer

+ func (s *ManagementHTTPServer) Address() string

+ func (s *ManagementHTTPServer) Shutdown(ctx context.Context) error

+ func (s *ManagementHTTPServer) Start(ctx context.Context, hc managementCache) error

type Option

+ func WithManagementHTTP[T backend.IBackendConstrain](addr string, opts ...ManagementHTTPOption) Option[T]

Aug 21, 2025

Changes in this version

type Config

+ RedisClusterOptions []backend.Option[backend.RedisCluster]

+ type RedisClusterBackendConstructor struct

+ func (RedisClusterBackendConstructor) Create(cfg *Config[backend.RedisCluster]) (backend.IBackend[backend.RedisCluster], error)

Aug 20, 2025

Changes in this version

type BackendManager

+ func NewEmptyBackendManager() *BackendManager

type Option

+ func WithExpirationTriggerBuffer[T backend.IBackendConstrain](size int) Option[T]

+ func WithExpirationTriggerDebounce[T backend.IBackendConstrain](interval time.Duration) Option[T]

Apr 3, 2023

Changes in this version

+ type BackendManager struct

+ func GetDefaultManager() *BackendManager

+ func NewBackendManager() *BackendManager

+ func (hcm *BackendManager) RegisterBackend(name string, constructor IBackendConstructor)

type Config

+ BackendType string

+ type IBackendConstructor interface

+ Create func(config interface{}) (interface{}, error)

+ type InMemoryBackendConstructor struct

+ func (ibc InMemoryBackendConstructor) Create(config interface{}) (interface{}, error)

+ type JobFunc func() error

+ type RedisBackendConstructor struct

+ func (rbc RedisBackendConstructor) Create(config interface{}) (interface{}, error)

+ type WorkerPool struct

+ func NewWorkerPool(workers int) *WorkerPool

+ func (pool *WorkerPool) Enqueue(job JobFunc)

+ func (pool *WorkerPool) Errors() <-chan error

+ func (pool *WorkerPool) Resize(newSize int)

+ func (pool *WorkerPool) Shutdown()

Jan 25, 2023

Changes in this version

type HyperCache

+ func (hyperCache *HyperCache[T]) Allocation() int64

+ func (hyperCache *HyperCache[T]) Count() int

+ func (hyperCache *HyperCache[T]) GetWithInfo(key string) (*models.Item, bool)

+ func (hyperCache *HyperCache[T]) MaxCacheSize() int64

type Option

+ func WithMaxCacheSize(maxCacheSize int64) Option[T]

type Service

+ Allocation func() int64

+ Count func() int

+ GetWithInfo func(key string) (*models.Item, bool)

Jan 15, 2023

Changes in this version

type Config

+ InMemoryOptions []backend.Option[backend.InMemory]

+ RedisOptions []backend.Option[backend.RedisBackend]

type HyperCache

+ func New(config *Config[T]) (hyperCache *HyperCache[T], err error)

+ func NewInMemoryWithDefaults(capacity int) (hyperCache *HyperCache[backend.InMemory], err error)

Jan 15, 2023

Changes in this version

+ func ApplyHyperCacheOptions(cache *HyperCache[T], options ...Option[T])

+ type Config struct

+ HyperCacheOptions []Option[T]

+ InMemoryBackendOptions []backend.BackendOption[backend.InMemoryBackend]

+ RedisBackendOptions []backend.BackendOption[backend.RedisBackend]

+ func NewConfig() *Config[T]

type HyperCache

+ StatsCollector stats.Collector

+ func NewHyperCacheInMemoryWithDefaults(capacity int) (hyperCache *HyperCache[backend.InMemoryBackend], err error)

+ func (hyperCache *HyperCache[T]) GetStats() stats.Stats

+ func (hyperCache *HyperCache[T]) SetMultiple(items map[string]any, expiration time.Duration) error

+ type Middleware func(Service) Service

type Option

+ func WithEvictionAlgorithm(name string) Option[T]

+ type Service interface

+ Capacity func() int

+ Clear func() error

+ Get func(key string) (value interface{}, ok bool)

+ GetMultiple func(keys ...string) (result map[string]any, failed map[string]error)

+ GetOrSet func(key string, value any, expiration time.Duration) (any, error)

+ GetStats func() stats.Stats

+ List func(filters ...any) ([]*models.Item, error)

+ Remove func(keys ...string)

+ Set func(key string, value any, expiration time.Duration) error

+ Size func() int

+ Stop func()

+ TriggerEviction func()

+ func ApplyMiddleware(svc Service, mw ...Middleware) Service

Jan 3, 2023

Changes in this version

+ var CacheItemPool = sync.Pool

+ var ClockCacheItemPool = sync.Pool

+ var ErrInvalidCapacity = errors.New("capacity cannot be negative")

+ var ErrInvalidExpiration = errors.New("expiration cannot be negative")

+ var ErrInvalidKey = errors.New("invalid key")

+ var ErrKeyExpired = errors.New("key expired")

+ var ErrKeyNotFound = errors.New("key not found")

+ var ErrNilValue = errors.New("nil value")

+ func RegisterEvictionAlgorithm(name string, createFunc func(capacity int) (EvictionAlgorithm, error))

+ type ARC struct

+ func NewARC(capacity int) (*ARC, error)

+ func (arc *ARC) Delete(key string)

+ func (arc *ARC) Evict() (string, error)

+ func (arc *ARC) Get(key string) (interface{}, bool)

+ func (arc *ARC) Set(key string, value interface{})

+ type CacheItem struct

+ Expiration time.Duration

+ Value interface{}

+ func (item *CacheItem) Expired() bool

+ func (item *CacheItem) FieldByName(name string) reflect.Value

+ func (item *CacheItem) Touch()

+ func (item *CacheItem) Valid() error

+ type ClockCache struct

+ func NewClockCache(capacity int) (*ClockCache, error)

+ func (clock *ClockCache) Delete(key string)

+ func (clock *ClockCache) Evict() (string, error)

+ func (clock *ClockCache) Get(key string) (interface{}, bool)

+ func (clock *ClockCache) Set(key string, value interface{})

+ type ClockCacheItem struct

+ Value interface{}

+ type EvictionAlgorithm interface

+ Delete func(key string)

+ Evict func() (string, error)

+ Get func(key string) (interface{}, bool)

+ Set func(key string, value interface{})

+ func NewEvictionAlgorithm(algorithmName string, capacity int) (EvictionAlgorithm, error)

+ type FilteringOption func(*HyperCache)

+ func WithFilter(fn func(item *CacheItem) bool) FilteringOption

+ func WithSortAscending() FilteringOption

+ func WithSortBy(field types.SortingField) FilteringOption

+ func WithSortDescending() FilteringOption

+ type HyperCache struct

+ func NewHyperCache(capacity int, options ...Option) (cache *HyperCache, err error)

+ func (c *HyperCache) Stop()

+ func (c *HyperCache) TriggerEviction()

+ func (cache *HyperCache) Capacity() int

+ func (cache *HyperCache) Clear()

+ func (cache *HyperCache) Close()

+ func (cache *HyperCache) Get(key string) (value interface{}, ok bool)

+ func (cache *HyperCache) GetMultiple(keys ...string) (result map[string]interface{}, errors []error)

+ func (cache *HyperCache) GetOrSet(key string, value interface{}, expiration time.Duration) (interface{}, error)

+ func (cache *HyperCache) List(options ...FilteringOption) ([]*CacheItem, error)

+ func (cache *HyperCache) Remove(keys ...string)

+ func (cache *HyperCache) Set(key string, value interface{}, expiration time.Duration) error

+ func (cache *HyperCache) SetCapacity(capacity int)

+ func (cache *HyperCache) Size() int

+ type LRU struct

+ func NewLRU(capacity int) (*LRU, error)

+ func (lru *LRU) Delete(key string)

+ func (lru *LRU) Evict() (string, error)

+ func (lru *LRU) Get(key string) (interface{}, bool)

+ func (lru *LRU) Set(key string, value interface{})

+ type LRUCacheItem struct

+ Key string

+ Value interface{}

+ type Option func(*HyperCache)

+ func EvictionAlgorithmName(name string) Option

+ func WithEvictionInterval(evictionInterval time.Duration) Option

+ func WithExpirationInterval(expirationInterval time.Duration) Option

+ func WithExpirationriggerBufferSize(expirationTriggerBufferSize uint) Option

+ func WithMaxEvictionCount(maxEvictionCount uint) Option

+ func WithStatsCollector(statsCollector StatsCollector) Option

+ type StatsCollector interface

+ Decr func(stat stats.Stat, value int64)

+ Gauge func(stat stats.Stat, value int64)

+ Histogram func(stat stats.Stat, value int64)

+ Incr func(stat stats.Stat, value int64)

+ Timing func(stat stats.Stat, value int64)