timeoutlock

Documentation

Index

• type Mutex
  • func NewMutex() Mutex
  • func (l *Mutex) Lock(ctx context.Context) bool
  • func (l *Mutex) Unlock()

Types

type Mutex

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

Mutex is a lock for long-running tasks where Lock can be interrupted by canceling a context.

func NewMutex

func NewMutex() Mutex

func (*Mutex) Lock

func (l *Mutex) Lock(ctx context.Context) bool

Lock blocks forever until the lock is free, attempting every 100 ms until the context is cancelled. Lock must be unlocked with Unlock() On success returns true. If context cancelled returns false.

func (*Mutex) Unlock

func (l *Mutex) Unlock()