mutexkv

Documentation

Index

• type MutexKV
  • func NewMutexKV() *MutexKV
  • func (m *MutexKV) Lock(key string)
  • func (m *MutexKV) Unlock(key string)

Types

type MutexKV

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

MutexKV is a simple key/value store for arbitrary mutexes. It can be used to serialize changes across arbitrary collaborators that share knowledge of the keys they must serialize on.

Deprecated: This will be removed in v2 without replacement. If you need its functionality, you can copy it or reference the v1 package.

The initial use case is to let aws_security_group_rule resources serialize their access to individual security groups based on SG ID.

func NewMutexKV

func NewMutexKV() *MutexKV

Returns a properly initalized MutexKV

Deprecated: This will be removed in v2 without replacement. If you need its functionality, you can copy it or reference the v1 package.

func (*MutexKV) Lock

func (m *MutexKV) Lock(key string)

Locks the mutex for the given key. Caller is responsible for calling Unlock for the same key

Deprecated: This will be removed in v2 without replacement. If you need its functionality, you can copy it or reference the v1 package.

func (*MutexKV) Unlock

func (m *MutexKV) Unlock(key string)

Unlock the mutex for the given key. Caller must have called Lock for the same key first

Deprecated: This will be removed in v2 without replacement. If you need its functionality, you can copy it or reference the v1 package.