muctx

Documentation

Index

• type Lock
  • func LockCtx(mm *mutexes.MutexMap, ctx context.Context, key string) (child context.Context, lock *Lock)
  • func RLockCtx(mm *mutexes.MutexMap, ctx context.Context, key string) (child context.Context, lock *Lock)
  • func (ctx *Lock) Clone() *Lock
  • func (ctx *Lock) IsLock() bool
  • func (ctx *Lock) IsRLock() bool
  • func (ctx *Lock) Locked() bool
  • func (ctx *Lock) Unlock() bool

Types

type Lock

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

Lock represents a locked key in a mutex map, normally only returned as an unlock function but wrapped here to provide a storable type with metadata for context values.

func LockCtx

func LockCtx(mm *mutexes.MutexMap, ctx context.Context, key string) (child context.Context, lock *Lock)

LockCtx will check given context for lock, else acquire a lock on the mutex at key in the map.

func RLockCtx

func RLockCtx(mm *mutexes.MutexMap, ctx context.Context, key string) (child context.Context, lock *Lock)

RLockCtx will check given context for rlock, else acquire an rlock on the mutex at key in the map.

func (*Lock) Clone

func (ctx *Lock) Clone() *Lock

Clone returns a read-only clone of Lock.

func (*Lock) IsLock

func (ctx *Lock) IsLock() bool

IsLock returns whether this Lock is a write lock.

func (*Lock) IsRLock

func (ctx *Lock) IsRLock() bool

IsRLock returns whether this Lock is a read lock.

func (*Lock) Locked

func (ctx *Lock) Locked() bool

Locked returns whether Lock is currently locked.

func (*Lock) Unlock

func (ctx *Lock) Unlock() bool

Unlock will unlock the given Lock (only if it is not a read-only).