syncutil

Documentation

Index

• func SetLogger(fn func(context.Context, string, ...interface{}))
• type Mutex
• type RWMutex
• type TimedMutex
  • func MakeTimedMutex(ctx context.Context, warnDuration time.Duration) TimedMutex
  • func (tm *TimedMutex) Lock()
  • func (tm *TimedMutex) Unlock()

Functions

func SetLogger

func SetLogger(fn func(context.Context, string, ...interface{}))

SetLogger changes the function which will be used by TimedMutex when warning about an above-threshold invocation.

Types

type Mutex

type Mutex struct {
	sync.Mutex
}

A Mutex is a mutual exclusion lock.

type RWMutex

type RWMutex struct {
	sync.RWMutex
}

An RWMutex is a reader/writer mutual exclusion lock.

type TimedMutex

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

TimedMutex is a mutex which dumps a stack trace whenever a lock is unlocked after being held for longer than the supplied duration, which must be strictly positive.

func MakeTimedMutex

func MakeTimedMutex(ctx context.Context, warnDuration time.Duration) TimedMutex

MakeTimedMutex creates a TimedMutex which warns when an Unlock happens more than warnDuration after the corresponding lock. It will use the supplied context for the warning message; see SetLogger().

func (*TimedMutex) Lock

func (tm *TimedMutex) Lock()

Lock implements sync.Locker

func (*TimedMutex) Unlock

func (tm *TimedMutex) Unlock()

Unlock implements sync.Locker