mutex

Documentation

Overview

Package mutex provides a simple key/value store for arbitrary mutexes.

Index

• Variables
• type KV
  • func NewKV() *KV
  • func (m *KV) KvLock(ctx context.Context, key string)
  • func (m *KV) KvUnlock(ctx context.Context, key string)

Variables

var GlobalMutex = NewKV()

Types

type KV

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

KV 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.

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

func NewKV

func NewKV() *KV

NewKV is an implementation of KV.

func (*KV) KvLock

func (m *KV) KvLock(ctx context.Context, key string)

KvLock locks the mutex for the given key. Caller is responsible for calling kvUnlock for the same key.

func (*KV) KvUnlock

func (m *KV) KvUnlock(ctx context.Context, key string)

KvUnlock unlocks the mutex for the given key. Caller must have called kvLock for the same key first.