lockermap

Documentation

Overview

Copyright (c) 2016-2019 Uber Technologies, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• type Map
  • func (m *Map) Delete(k interface{})
  • func (m *Map) Load(k interface{}, f func(sync.Locker)) bool
  • func (m *Map) Range(f func(k interface{}, v sync.Locker) bool)
  • func (m *Map) TryStore(k interface{}, v sync.Locker) bool

Types

type Map

type Map struct {
	// contains filtered or unexported fields
}

Map is a two-level locking map which synchronizes access to the map in addition to synchronizing access to the values within the map. Useful for mutating values in-place.

The zero Map is valid and empty.

func (*Map) Delete

func (m *Map) Delete(k interface{})

Delete deletes the given key from the Map.

func (*Map) Load

func (m *Map) Load(k interface{}, f func(sync.Locker)) bool

Load looks up the value of key k and executes f under the protection of said value's lock. While f executes, it is guaranteed that k will not be deleted from the map. Returns false if k was not found.

func (*Map) Range

func (m *Map) Range(f func(k interface{}, v sync.Locker) bool)

Range interates over the Map and execs f until f returns false.

func (*Map) TryStore

func (m *Map) TryStore(k interface{}, v sync.Locker) bool

TryStore stores the given key / value pair within the Map. Returns false if the key is already present.