multimutex

Documentation

Index

• type Mutex
  • func NewMutex[T comparable]() *Mutex[T]
  • func (c *Mutex[T]) Lock(id T)
  • func (c *Mutex[T]) Unlock(id T)

Types

type Mutex

type Mutex[T comparable] struct {
	// contains filtered or unexported fields
}

Mutex is a struct that keeps track of a set of mutexes with a given ID. It can be used for making sure only one goroutine gets given the mutex per ID.

func NewMutex

func NewMutex[T comparable]() *Mutex[T]

NewMutex creates a new Mutex.

func (*Mutex[T]) Lock

func (c *Mutex[T]) Lock(id T)

Lock locks the mutex by the given ID. If the mutex is already locked by this ID, Lock blocks until the mutex is available.

func (*Mutex[T]) Unlock

func (c *Mutex[T]) Unlock(id T)

Unlock unlocks the mutex by the given ID. It is a run-time error if the mutex is not locked by the ID on entry to Unlock.