Documentation
¶
Index ¶
- type Balance
- func (b *Balance) FindVictim(shardKey uint64) (*model.Entry, bool)
- func (b *Balance) Mem() int64
- func (b *Balance) MostLoaded(offset int) (*ShardNode, bool)
- func (b *Balance) Push(entry *model.Entry)
- func (b *Balance) Rebalance()
- func (b *Balance) Register(shard *sharded.Shard[*model.Entry])
- func (b *Balance) Remove(shardKey uint64, el *list.Element[*model.Entry])
- func (b *Balance) Update(existing *model.Entry)
- type Balancer
- type InMemoryStorage
- func (s *InMemoryStorage) Clear()
- func (s *InMemoryStorage) Close() error
- func (s *InMemoryStorage) Get(req *model.Entry) (ptr *model.Entry, found bool)
- func (s *InMemoryStorage) Len() int64
- func (s *InMemoryStorage) Mem() int64
- func (s *InMemoryStorage) Rand() (entry *model.Entry, ok bool)
- func (s *InMemoryStorage) Remove(entry *model.Entry) (freedBytes int64, hit bool)
- func (s *InMemoryStorage) Run()
- func (s *InMemoryStorage) Set(new *model.Entry) (persisted bool)
- func (s *InMemoryStorage) ShouldEvict() bool
- func (s *InMemoryStorage) Stat() (bytes int64, length int64)
- func (s *InMemoryStorage) WalkShards(ctx context.Context, fn func(key uint64, shard *sharded.Shard[*model.Entry]))
- type ShardNode
- type Storage
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Balance ¶
type Balance struct {
// contains filtered or unexported fields
}
Balance maintains per-shard LRUStorage lists and provides efficient selection of loaded shards for eviction. - memList orders shardNodes by usage (most loaded in front). - shards is a flat array for O(1) access by shard index. - shardedMap is the underlying data storage (map of all entries).
func NewBalancer ¶
NewBalancer creates a new Balance instance and initializes memList.
func (*Balance) MostLoaded ¶ added in v1.0.1
MostLoaded returns the first non-empty shard node from the front of memList, optionally skipping a number of nodes by offset (for concurrent eviction fairness).
func (*Balance) Push ¶ added in v1.0.1
Push inserts a response into the appropriate shard's LRUStorage list and updates counters. Returns the affected ShardNode for further operations.
func (*Balance) Register ¶
Register inserts a new ShardNode for a given shard, creates its LRUStorage, and adds it to memList and shards array.
type InMemoryStorage ¶ added in v1.0.1
type InMemoryStorage struct {
// contains filtered or unexported fields
}
InMemoryStorage is a Weight-aware, sharded InMemoryStorage cache with background eviction and refreshItem support.
func NewStorage ¶
func NewStorage( ctx context.Context, cfg config.Config, upstream upstream.Upstream, balancer Balancer, shardedMap *sharded.Map[*model.Entry], ) *InMemoryStorage
NewStorage constructs a new InMemoryStorage cache instance and launches eviction and refreshItem routines.
func (*InMemoryStorage) Clear ¶ added in v1.0.1
func (s *InMemoryStorage) Clear()
func (*InMemoryStorage) Close ¶ added in v1.1.1
func (s *InMemoryStorage) Close() error
func (*InMemoryStorage) Get ¶ added in v1.0.1
Get retrieves a response by request and bumps its InMemoryStorage position. Returns: (response, releaser, found).
func (*InMemoryStorage) Len ¶ added in v1.0.1
func (s *InMemoryStorage) Len() int64
func (*InMemoryStorage) Mem ¶ added in v1.0.1
func (s *InMemoryStorage) Mem() int64
func (*InMemoryStorage) Rand ¶ added in v1.0.1
func (s *InMemoryStorage) Rand() (entry *model.Entry, ok bool)
Rand returns a random item from storage.
func (*InMemoryStorage) Remove ¶ added in v1.0.1
func (s *InMemoryStorage) Remove(entry *model.Entry) (freedBytes int64, hit bool)
func (*InMemoryStorage) Run ¶ added in v1.0.3
func (s *InMemoryStorage) Run()
Run emits detailed stats about evictions, Weight, and GC activity every 5 seconds if debugging is enabled.
func (*InMemoryStorage) Set ¶ added in v1.0.1
func (s *InMemoryStorage) Set(new *model.Entry) (persisted bool)
Set inserts or updates a response in the cache, updating Weight usage and InMemoryStorage position. On 'wasPersisted=true' must be called Entry.Finalize, otherwise Entry.Finalize.
func (*InMemoryStorage) ShouldEvict ¶ added in v1.0.1
func (s *InMemoryStorage) ShouldEvict() bool
ShouldEvict checks if current storage size is greater than the threshold (memory limit).
func (*InMemoryStorage) Stat ¶ added in v1.0.1
func (s *InMemoryStorage) Stat() (bytes int64, length int64)
func (*InMemoryStorage) WalkShards ¶ added in v1.0.1
type ShardNode ¶
type ShardNode struct {
// contains filtered or unexported fields
}
ShardNode represents a single shard's LRUStorage and accounting info. Each shard has its own LRUStorage list and a pointer to its element in the balancer's memList.
type Storage ¶
type Storage interface {
// Run is start internal workers and loggers.
Run()
// Close is stops internal workers and loggers (dump if necessary).
Close() error
// Get attempts to retrieve a cached response for the given request.
// Returns the response, a releaser for safe concurrent access, and a hit/miss flag.
Get(*model.Entry) (entry *model.Entry, hit bool)
// Set stores a new response in the cache and returns a releaser for managing resource lifetime.
// 1. You definitely cannot use 'inEntry' after use in Set due to it can be removed, you will receive a cache entry on hit!
// 2. Use Release and Remove for manage Entry lifetime.
Set(inEntry *model.Entry) (persisted bool)
// Remove is removes one element.
Remove(*model.Entry) (freedBytes int64, hit bool)
ShouldEvict() bool
// Clear is removes all cache entries from the storage.
Clear()
// Stat returns bytes usage and num of items in storage.
Stat() (bytes int64, length int64)
// Len - return stored value (refreshes every 100ms).
Len() int64
// Mem - return stored value (refreshes every 100ms).
Mem() int64
// Rand returns a random elem from the map.
Rand() (entry *model.Entry, ok bool)
WalkShards(ctx context.Context, fn func(key uint64, shard *sharded.Shard[*model.Entry]))
}
Storage is a generic interface for cache storages. It supports typical Get/Set operations with reference management.
Source Files
Directories