💾 Archived View for godocs.io › github.com › orcaman › concurrent-map captured on 2024-06-16 at 17:10:32. Gemini links have been rewritten to link to archived content
⬅️ Previous capture (2024-03-21)
-=-=-=-=-=-=-
import "github.com/orcaman/concurrent-map"
var SHARD_COUNT = 32
type ConcurrentMap []*ConcurrentMapShared
A "thread" safe map of type string:Anything. To avoid lock bottlenecks this map is dived to several (SHARD_COUNT) map shards.
func New() ConcurrentMap
Creates a new concurrent map.
func (m ConcurrentMap) Clear()
Clear removes all items from map.
func (m ConcurrentMap) Count() int
Count returns the number of elements within the map.
func (m ConcurrentMap) Get(key string) (interface{}, bool)
Get retrieves an element from map under given key.
func (m ConcurrentMap) GetShard(key string) *ConcurrentMapShared
GetShard returns shard under given key
func (m ConcurrentMap) Has(key string) bool
Looks up an item under specified key
func (m ConcurrentMap) IsEmpty() bool
IsEmpty checks if map is empty.
func (m ConcurrentMap) Items() map[string]interface{}
Items returns all items as map[string]interface{}
func (m ConcurrentMap) Iter() <-chan Tuple
Iter returns an iterator which could be used in a for range loop.
Deprecated: using IterBuffered() will get a better performence
func (m ConcurrentMap) IterBuffered() <-chan Tuple
IterBuffered returns a buffered iterator which could be used in a for range loop.
func (m ConcurrentMap) IterCb(fn IterCb)
Callback based iterator, cheapest way to read all elements in a map.
func (m ConcurrentMap) Keys() []string
Keys returns all keys as []string
func (m ConcurrentMap) MSet(data map[string]interface{})
func (m ConcurrentMap) MarshalJSON() ([]byte, error)
Reviles ConcurrentMap "private" variables to json marshal.
func (m ConcurrentMap) Pop(key string) (v interface{}, exists bool)
Pop removes an element from the map and returns it
func (m ConcurrentMap) Remove(key string)
Remove removes an element from the map.
func (m ConcurrentMap) RemoveCb(key string, cb RemoveCb) bool
RemoveCb locks the shard containing the key, retrieves its current value and calls the callback with those params If callback returns true and element exists, it will remove it from the map Returns the value returned by the callback (even if element was not present in the map)
func (m ConcurrentMap) Set(key string, value interface{})
Sets the given value under the specified key.
func (m ConcurrentMap) SetIfAbsent(key string, value interface{}) bool
Sets the given value under the specified key if no value was associated with it.
func (m ConcurrentMap) Upsert(key string, value interface{}, cb UpsertCb) (res interface{})
Insert or Update - updates existing element or inserts a new one using UpsertCb
type ConcurrentMapShared struct {
sync.RWMutex // Read Write mutex, guards access to internal map.
// contains filtered or unexported fields
}
A "thread" safe string to anything map.
type IterCb func(key string, v interface{})
Iterator callback,called for every key,value found in maps. RLock is held for all calls for a given shard therefore callback sess consistent view of a shard, but not across the shards
type RemoveCb func(key string, v interface{}, exists bool) bool
RemoveCb is a callback executed in a map.RemoveCb() call, while Lock is held If returns true, the element will be removed from the map
type Tuple struct {
Key string
Val interface{}
}
Used by the Iter & IterBuffered functions to wrap two variables together over a channel,
type UpsertCb func(exist bool, valueInMap interface{}, newValue interface{}) interface{}
Callback to return new element to be inserted into the map It is called while lock is held, therefore it MUST NOT try to access other keys in same map, as it can lead to deadlock since Go sync.RWLock is not reentrant