Documentation
¶
Overview ¶
Package cachev2 provides a high-performance concurrent map implementation optimized for cache operations. The implementation uses sharding to minimize lock contention by dividing the map into multiple independent shards, each protected by its own read-write mutex.
The concurrent map stores string keys mapped to *cache.Item values and is designed to be thread-safe for concurrent read and write operations across multiple goroutines.
Key features:
- Sharded design with 32 shards to reduce lock contention
- FNV-1a hash function for efficient key distribution
- Thread-safe operations with optimized read/write locking
- Buffered iteration support for safe concurrent traversal
- Standard map operations: Set, Get, Has, Remove, Pop, Clear, Count
Example usage:
cm := cachev2.New()
cm.Set("key", &cache.Item{...})
if item, ok := cm.Get("key"); ok {
// Process item
}
Index ¶
- Constants
- type ConcurrentMap
- func (cm *ConcurrentMap) Clear()
- func (cm *ConcurrentMap) Count() int
- func (cm *ConcurrentMap) Get(key string) (*cache.Item, bool)
- func (cm *ConcurrentMap) GetShard(key string) *ConcurrentMapShard
- func (cm *ConcurrentMap) Has(key string) bool
- func (cm *ConcurrentMap) IterBuffered() <-chan Tuple
- func (cm *ConcurrentMap) Pop(key string) (*cache.Item, bool)
- func (cm *ConcurrentMap) Remove(key string)
- func (cm *ConcurrentMap) Set(key string, value *cache.Item)
- type ConcurrentMapShard
- type Tuple
Constants ¶
const ( // ShardCount is the number of shards used by the map. ShardCount = 32 // ShardCount32 is the number of shards used by the map pre-casted to uint32 to avoid performance issues. ShardCount32 uint32 = uint32(ShardCount) )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ConcurrentMap ¶
type ConcurrentMap struct {
// contains filtered or unexported fields
}
ConcurrentMap is a "thread" safe map of type string:*cache.Item. To avoid lock bottlenecks this map is divided into several (ShardCount) map shards.
func (*ConcurrentMap) Count ¶
func (cm *ConcurrentMap) Count() int
Count returns the number of items in the map.
func (*ConcurrentMap) Get ¶
func (cm *ConcurrentMap) Get(key string) (*cache.Item, bool)
Get retrieves an element from map under given key.
func (*ConcurrentMap) GetShard ¶
func (cm *ConcurrentMap) GetShard(key string) *ConcurrentMapShard
GetShard returns shard under given key.
func (*ConcurrentMap) Has ¶
func (cm *ConcurrentMap) Has(key string) bool
Has checks if key is present in the map.
func (*ConcurrentMap) IterBuffered ¶
func (cm *ConcurrentMap) IterBuffered() <-chan Tuple
IterBuffered returns a buffered iterator which could be used in a for range loop.
func (*ConcurrentMap) Pop ¶
func (cm *ConcurrentMap) Pop(key string) (*cache.Item, bool)
Pop removes an element from the map and returns it.
func (*ConcurrentMap) Remove ¶
func (cm *ConcurrentMap) Remove(key string)
Remove removes the value under the specified key.
type ConcurrentMapShard ¶
ConcurrentMapShard is a "thread" safe string to `*cache.Item` map shard.
Source Files