Documentation ¶
Index ¶
- type ConcurrentMap
- func (m *ConcurrentMap) Count() int
- func (m *ConcurrentMap) Get(key string) (interface{}, bool)
- func (m *ConcurrentMap) GetShard(key string) *ConcurrentMapShard
- func (m *ConcurrentMap) Has(key string) bool
- func (m *ConcurrentMap) IsEmpty() bool
- func (m *ConcurrentMap) Items() map[string]interface{}
- func (m *ConcurrentMap) IterBuffered() <-chan Tuple
- func (m *ConcurrentMap) IterCb(fn IterCb)
- func (m *ConcurrentMap) Keys() []string
- func (m *ConcurrentMap) MSet(data map[string]interface{})
- func (m *ConcurrentMap) MarshalJSON() ([]byte, error)
- func (m *ConcurrentMap) Pop(key string) (v interface{}, exists bool)
- func (m *ConcurrentMap) Remove(key string)
- func (m *ConcurrentMap) RemoveCb(key string, cb RemoveCb) bool
- func (m *ConcurrentMap) Set(key string, value interface{})
- func (m *ConcurrentMap) SetIfAbsent(key string, value interface{}) bool
- func (m *ConcurrentMap) Upsert(key string, value interface{}, cb UpsertCb) (res interface{})
- type ConcurrentMapShard
- type IterCb
- type RemoveCb
- type Tuple
- type UpsertCb
Constants ¶
This section is empty.
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:Anything. To avoid lock bottlenecks this map is dived to several (ShardCount) map shards.
func (*ConcurrentMap) Count ¶
func (m *ConcurrentMap) Count() int
Count returns the number of elements within the map.
func (*ConcurrentMap) Get ¶
func (m *ConcurrentMap) Get(key string) (interface{}, bool)
Get retrieves an element from map under given key.
func (*ConcurrentMap) GetShard ¶
func (m *ConcurrentMap) GetShard(key string) *ConcurrentMapShard
GetShard returns shard under given key.
func (*ConcurrentMap) Has ¶
func (m *ConcurrentMap) Has(key string) bool
Has looks up an item under specified key.
func (*ConcurrentMap) IsEmpty ¶
func (m *ConcurrentMap) IsEmpty() bool
IsEmpty checks if map is empty.
func (*ConcurrentMap) Items ¶
func (m *ConcurrentMap) Items() map[string]interface{}
Items returns all items as map[string]interface{}
func (*ConcurrentMap) IterBuffered ¶
func (m *ConcurrentMap) IterBuffered() <-chan Tuple
IterBuffered returns a buffered iterator which could be used in a for range loop.
func (*ConcurrentMap) IterCb ¶
func (m *ConcurrentMap) IterCb(fn IterCb)
Callback based iterator, cheapest way to read all elements in a map.
func (*ConcurrentMap) Keys ¶
func (m *ConcurrentMap) Keys() []string
Keys returns all keys as []string
func (*ConcurrentMap) MSet ¶
func (m *ConcurrentMap) MSet(data map[string]interface{})
MSet creates a sharded concurrent map out of a regular map.
func (*ConcurrentMap) MarshalJSON ¶
func (m *ConcurrentMap) MarshalJSON() ([]byte, error)
MarshalJSON reveals ConcurrentMap "private" variables to json marshal.
func (*ConcurrentMap) Pop ¶
func (m *ConcurrentMap) Pop(key string) (v interface{}, exists bool)
Pop removes an element from the map and returns it.
func (*ConcurrentMap) Remove ¶
func (m *ConcurrentMap) Remove(key string)
Remove removes an element from the map.
func (*ConcurrentMap) RemoveCb ¶
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 (*ConcurrentMap) Set ¶
func (m *ConcurrentMap) Set(key string, value interface{})
Set sets the given value under the specified key.
func (*ConcurrentMap) SetIfAbsent ¶
func (m *ConcurrentMap) SetIfAbsent(key string, value interface{}) bool
SetIfAbsent sets the given value under the specified key if no value was associated with it.
func (*ConcurrentMap) Upsert ¶
func (m *ConcurrentMap) Upsert(key string, value interface{}, cb UpsertCb) (res interface{})
Upsert (Insert or Update) - updates existing element or inserts a new one using UpsertCb.
type ConcurrentMapShard ¶
type ConcurrentMapShard struct { sync.RWMutex // Read Write mutex, guards access to internal map. // contains filtered or unexported fields }
ConcurrentMapShared is a "thread" safe string to anything map.
type IterCb ¶
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 ¶
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 ¶
type Tuple struct { Key string Val interface{} }
Tuple is used by the Iter & IterBuffered functions to wrap two variables together over a channel.
type UpsertCb ¶
type UpsertCb func(exist bool, valueInMap interface{}, newValue interface{}) interface{}
UpsertCb is callback function 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