lock

Documentation

Overview

Package lock is the equivalent of sync.Mutex but with a context.

Prefer standard sync.Mutex if you don't use the context.

Index

• type Lock
  • func New() *Lock
  • func (l *Lock) Lock()
  • func (l *Lock) LockWithContext(ctx context.Context) error
  • func (l *Lock) Unlock()
• type Locker

Types

type Lock

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

Lock is like a mutex but with ctx.

func New

func New() *Lock

func (*Lock) Lock

func (l *Lock) Lock()

Lock bocks other calls until Unlock() is called.

See LockWithContext()

func (*Lock) LockWithContext

func (l *Lock) LockWithContext(ctx context.Context) error

LockWithContext bocks other calls until Unlock() is called or the context is cancelled. It forwards the context error when cancelled.

func (*Lock) Unlock

func (l *Lock) Unlock()

type Locker

type Locker interface {
	LockWithContext(ctx context.Context) error
	Unlock()
	Lock()
}