ctxmu

Documentation

Index

• type CtxMutex
  • func New() *CtxMutex
  • func (mu *CtxMutex) Lock(ctx context.Context) bool
  • func (mu *CtxMutex) Locked() bool
  • func (mu *CtxMutex) Unlock()

Types

type CtxMutex

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

CtxMutex implements a context aware lock

func New

func New() *CtxMutex

New creates a new CtxMutex

func (*CtxMutex) Lock

func (mu *CtxMutex) Lock(ctx context.Context) bool

Lock acquires a lock, it can be canceled by context

func (*CtxMutex) Locked

func (mu *CtxMutex) Locked() bool

Locked checks whether the lock is hold

func (*CtxMutex) Unlock

func (mu *CtxMutex) Unlock()

Unlock releases the acquired lock