lock

Documentation

Index

• type LockToken
• type Locker
  • func NewLocker() *Locker
  • func (r *Locker) AsyncLockWithCtx(ctx context.Context) (LockToken, chan<- LockToken, error)
  • func (r *Locker) RLock()
  • func (r *Locker) RTryLockWithCtx(ctx context.Context) bool
  • func (r *Locker) RUnlock()
  • func (r *Locker) TryLockWithCtx(ctx context.Context) bool
  • func (r *Locker) Unlock()
  • func (r *Locker) WithLock(f func(l LockToken))
  • func (r *Locker) WithLockInCtx(ctx context.Context, f func(l LockToken) error) error

Types

type LockToken

type LockToken interface {
	// contains filtered or unexported methods
}

LockToken represents proof that a list lock has been acquired

type Locker

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

Locker

func NewLocker

func NewLocker() *Locker

func (*Locker) AsyncLockWithCtx

func (r *Locker) AsyncLockWithCtx(ctx context.Context) (LockToken, chan<- LockToken, error)

AsyncLock acquires a lock until the token is returned to the receiving channel

func (*Locker) RLock

func (r *Locker) RLock()

RLock acquires a read lock

func (*Locker) RTryLockWithCtx

func (r *Locker) RTryLockWithCtx(ctx context.Context) bool

RTryLockWithCtx tries to acquires a read lock with context and returns false if context is done, otherwise returns true.

func (*Locker) RUnlock

func (r *Locker) RUnlock()

RUnlock releases a read lock

func (*Locker) TryLockWithCtx

func (r *Locker) TryLockWithCtx(ctx context.Context) bool

TryLockWithCtx tries to acquires a lock with context and returns false if context is done, otherwise returns true.

func (*Locker) Unlock

func (r *Locker) Unlock()

Unlock releases a lock

func (*Locker) WithLock

func (r *Locker) WithLock(f func(l LockToken))

WithLock acquires a lock for the duration that the provided function is being executed. A token as proof of the lock is passed to the function.

func (*Locker) WithLockInCtx

func (r *Locker) WithLockInCtx(ctx context.Context, f func(l LockToken) error) error

WithLockInCtx tries to acquires a lock until it succeeds or context times out. If it fails, return value is false otherwise true. And, executes the function `f`, if lock is acquired. A token as proof of the lock is passed to the function.