keymutex

README

keymutex

Acquire locks on arbitrary strings by hashing over a fixed set of locks.

KeyMutex uses a FNV-1a 32-bit hash of an input string to select a mutex from a list of locks. The hash is computed in a way that does not cause allocation by converting string to bytes, as with the standard library.

Documentation

Index

• type KeyMutex
  • func New(n int) *KeyMutex
  • func (km *KeyMutex) Lock(k string)
  • func (km *KeyMutex) LockBytes(k []byte)
  • func (km *KeyMutex) Unlock(k string)
  • func (km *KeyMutex) UnlockBytes(k []byte)
• type KeyRWMutex
  • func NewRW(n int) *KeyRWMutex
  • func (km *KeyRWMutex) Lock(k string)
  • func (km *KeyRWMutex) LockBytes(k []byte)
  • func (km *KeyRWMutex) RLock(k string)
  • func (km *KeyRWMutex) RLockBytes(k []byte)
  • func (km *KeyRWMutex) RUnlock(k string)
  • func (km *KeyRWMutex) RUnlockBytes(k []byte)
  • func (km *KeyRWMutex) Unlock(k string)
  • func (km *KeyRWMutex) UnlockBytes(k []byte)

Types

type KeyMutex

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

func New

func New(n int) *KeyMutex

New returns a new instance of KeyMutex which hashes arbitrary keys to a fixed set of locks, specified by n. Use the default value if n <= 0.

func (*KeyMutex) Lock

func (km *KeyMutex) Lock(k string)

Lock acquires the lock for the specified key.

func (*KeyMutex) LockBytes

func (km *KeyMutex) LockBytes(k []byte)

func (*KeyMutex) Unlock

func (km *KeyMutex) Unlock(k string)

Unlock releases the lock for the specified key.

func (*KeyMutex) UnlockBytes

func (km *KeyMutex) UnlockBytes(k []byte)

type KeyRWMutex

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

func NewRW

func NewRW(n int) *KeyRWMutex

NewRW returns a new instance of KeyRWMutex which hashes arbitrary keys to a fixed set of RWMutexes, specified by n. Use the default value if n <= 0.

func (*KeyRWMutex) Lock

func (km *KeyRWMutex) Lock(k string)

Lock acquires the lock for the specified key.

func (*KeyRWMutex) LockBytes

func (km *KeyRWMutex) LockBytes(k []byte)

func (*KeyRWMutex) RLock

func (km *KeyRWMutex) RLock(k string)

RLock acquires the shared lock for the specified key.

func (*KeyRWMutex) RLockBytes

func (km *KeyRWMutex) RLockBytes(k []byte)

func (*KeyRWMutex) RUnlock

func (km *KeyRWMutex) RUnlock(k string)

RUnlock releases the shared lock for the specified key.

func (*KeyRWMutex) RUnlockBytes

func (km *KeyRWMutex) RUnlockBytes(k []byte)

func (*KeyRWMutex) Unlock

func (km *KeyRWMutex) Unlock(k string)

Unlock releases the lock for the specified key.

func (*KeyRWMutex) UnlockBytes

func (km *KeyRWMutex) UnlockBytes(k []byte)