Documentation
¶
Index ¶
- Variables
- type ConcurrentMap
- func (m *ConcurrentMap) Count() int
- func (m *ConcurrentMap) Get(key fmt.Stringer) (interface{}, bool)
- func (m *ConcurrentMap) GetOrSet(key fmt.Stringer, value interface{}) (newValue interface{}, isGet bool)
- func (m *ConcurrentMap) Has(key fmt.Stringer) bool
- func (m *ConcurrentMap) IsEmpty() bool
- func (m *ConcurrentMap) Items() map[fmt.Stringer]interface{}
- func (m *ConcurrentMap) Iter() <-chan Tupledeprecated
- func (m *ConcurrentMap) IterBuffered() <-chan Tuple
- func (m *ConcurrentMap) IterCb(fn IterCb)
- func (m *ConcurrentMap) Keys() []fmt.Stringer
- func (m *ConcurrentMap) MSet(data map[fmt.Stringer]interface{})
- func (m *ConcurrentMap) MarshalJSON() ([]byte, error)
- func (m *ConcurrentMap) Pop(key fmt.Stringer) (v interface{}, exists bool)
- func (m *ConcurrentMap) Remove(key fmt.Stringer)
- func (m *ConcurrentMap) RemoveCb(key fmt.Stringer, cb RemoveCb) bool
- func (m *ConcurrentMap) Set(key fmt.Stringer, value interface{})
- func (m *ConcurrentMap) SetIfAbsent(key fmt.Stringer, value interface{}) bool
- func (m *ConcurrentMap) Upsert(key fmt.Stringer, value interface{}, cb UpsertCb) (res interface{})
- type ConcurrentMapShared
- type IterCb
- type RemoveCb
- type Tuple
- type UpsertCb
Constants ¶
This section is empty.
Variables ¶
var DEFAULT_SHARD_COUNT = 32
Functions ¶
This section is empty.
Types ¶
type ConcurrentMap ¶
type ConcurrentMap struct {
// contains filtered or unexported fields
}
A "thread" safe map of type string:Anything. To avoid lock bottlenecks this map is dived to several (SHARD_COUNT) map shards.
func (*ConcurrentMap) Count ¶
func (m *ConcurrentMap) Count() int
Returns the number of elements within the map.
func (*ConcurrentMap) Get ¶
func (m *ConcurrentMap) Get(key fmt.Stringer) (interface{}, bool)
Retrieves an element from map under given key.
func (*ConcurrentMap) GetOrSet ¶
func (m *ConcurrentMap) GetOrSet(key fmt.Stringer, value interface{}) (newValue interface{}, isGet bool)
func (*ConcurrentMap) Has ¶
func (m *ConcurrentMap) Has(key fmt.Stringer) bool
Looks up an item under specified key
func (*ConcurrentMap) Items ¶
func (m *ConcurrentMap) Items() map[fmt.Stringer]interface{}
Returns all items as map[string]interface{}
func (*ConcurrentMap) Iter
deprecated
func (m *ConcurrentMap) Iter() <-chan Tuple
Returns an iterator which could be used in a for range loop.
Deprecated: using IterBuffered() will get a better performence
func (*ConcurrentMap) IterBuffered ¶
func (m *ConcurrentMap) IterBuffered() <-chan Tuple
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() []fmt.Stringer
Return all keys as []string
func (*ConcurrentMap) MSet ¶
func (m *ConcurrentMap) MSet(data map[fmt.Stringer]interface{})
func (*ConcurrentMap) MarshalJSON ¶
func (m *ConcurrentMap) MarshalJSON() ([]byte, error)
Reviles ConcurrentMap "private" variables to json marshal.
func (*ConcurrentMap) Pop ¶
func (m *ConcurrentMap) Pop(key fmt.Stringer) (v interface{}, exists bool)
Removes an element from the map and returns it
func (*ConcurrentMap) Remove ¶
func (m *ConcurrentMap) Remove(key fmt.Stringer)
Removes an element from the map.
func (*ConcurrentMap) RemoveCb ¶
func (m *ConcurrentMap) RemoveCb(key fmt.Stringer, 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 fmt.Stringer, value interface{})
Sets the given value under the specified key.
func (*ConcurrentMap) SetIfAbsent ¶
func (m *ConcurrentMap) SetIfAbsent(key fmt.Stringer, value interface{}) bool
Sets the given value under the specified key if no value was associated with it.
type ConcurrentMapShared ¶
type ConcurrentMapShared struct { // contains filtered or unexported fields }
A "thread" safe string to anything map.
type IterCb ¶
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 ¶
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{}
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