lockwatcher

Documentation

Index

• type LockWatcher
  • func New(lock sync.Locker, options LockWatcherOptions) *LockWatcher
  • func (lw *LockWatcher) GetOptions() LockWatcherOptions
  • func (lw *LockWatcher) GetStats() LockWatcherStats
  • func (lw *LockWatcher) Stop()
  • func (lw *LockWatcher) WriteHtml(writer io.Writer, prefix string) (bool, error)
• type LockWatcherOptions
• type LockWatcherStats
• type RWLock

Types

type LockWatcher

type LockWatcher struct {
	LockWatcherOptions
	// contains filtered or unexported fields
}

func New

func New(lock sync.Locker, options LockWatcherOptions) *LockWatcher

func (*LockWatcher) GetOptions

func (lw *LockWatcher) GetOptions() LockWatcherOptions

func (*LockWatcher) GetStats

func (lw *LockWatcher) GetStats() LockWatcherStats

func (*LockWatcher) Stop

func (lw *LockWatcher) Stop()

func (*LockWatcher) WriteHtml

func (lw *LockWatcher) WriteHtml(writer io.Writer,
	prefix string) (bool, error)

WriteHtml will write HTML-formatted statistics information to writer, with an optional prefix. It returns true if something was written, else false.

type LockWatcherOptions

type LockWatcherOptions struct {
	CheckInterval      time.Duration // Default: 5 seconds, minimum: 1 second.
	Function           func()
	Logger             log.DebugLogger
	RFunction          func()
	LogTimeout         time.Duration // Default: 1 second, min: 1 millisecond.
	MaximumTryInterval time.Duration // Default/maximum: LogTimeout/32.
	MinimumTryInterval time.Duration // Default/maximum: LogTimeout/256.
}

type LockWatcherStats

type LockWatcherStats struct {
	NumLockTimeouts  uint64 // Populated for sync.Mutex
	NumRLockTimeouts uint64 // Populated for sync.RWMutex
	NumWLockTimeouts uint64 // Populated for sync.RWMutex
	WaitingForLock   bool   // Populated for sync.Mutex
	WaitingForRLock  bool   // Populated for sync.RWMutex
	WaitingForWLock  bool   // Populated for sync.RWMutex
}

type RWLock

type RWLock interface {
	sync.Locker
	RLock()
	RUnlock()
	TryLock() bool
}