syncutil

Documentation

Index

• type LockGroup
  • func NewLockGroup(options ...LockGroupOption) *LockGroup
  • func (g *LockGroup) Lock(id uint32)
  • func (g *LockGroup) Unlock(id uint32)
• type LockGroupOption
  • func WithHash(hashFn func(id uint32) uint32) LockGroupOption
  • func WithRemoveEntryOnUnlock(removeEntryOnUnlock bool) LockGroupOption
• type Mutex
• type RWMutex

Types

type LockGroup

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

LockGroup is a map of mutex that locks entries with different id separately. It's used levitate lock contentions of using a global lock.

func NewLockGroup

func NewLockGroup(options ...LockGroupOption) *LockGroup

NewLockGroup create and return an empty lockGroup.

func (*LockGroup) Lock

func (g *LockGroup) Lock(id uint32)

Lock locks the target mutex base on the hash of id.

func (*LockGroup) Unlock

func (g *LockGroup) Unlock(id uint32)

Unlock unlocks the target mutex based on the hash of the id.

type LockGroupOption

type LockGroupOption func(lg *LockGroup)

LockGroupOption configures the lock group.

func WithHash

func WithHash(hashFn func(id uint32) uint32) LockGroupOption

WithHash sets the lockGroup's hash function to provided hashFn.

func WithRemoveEntryOnUnlock

func WithRemoveEntryOnUnlock(removeEntryOnUnlock bool) LockGroupOption

WithRemoveEntryOnUnlock sets the lockGroup's removeEntryOnUnlock to provided value.

type Mutex

type Mutex struct {
	sync.Mutex
}

Mutex is a mutual exclusion lock. The zero value for a Mutex is an unlocked mutex.

Mutex must not be copied after first use.

type RWMutex

type RWMutex struct {
	sync.RWMutex
}

RWMutex is a reader/writer mutual exclusion lock. The lock can be held by an arbitrary number of readers or a single writer. The zero value for a RWMutex is an unlocked mutex.

RWMutex must not be copied after first use.