lock

Documentation

Index

• type Lock
  • func New(path string) *Lock
  • func (l *Lock) Acquire() (err error)
  • func (l *Lock) Release() error
  • func (l *Lock) WithPeriod(period time.Duration) *Lock
  • func (l *Lock) WithWarn(warn string) *Lock

Types

type Lock

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

Lock is used to ensure only one agent has permission to do certain operations. It relies on creating files

func New

func New(path string) *Lock

New returns a Lock instance, it does not try to acquire the lock yet, so no file will be created until Acquire() is called.

func (*Lock) Acquire

func (l *Lock) Acquire() (err error)

Acquire attempts to lock the file. This operation blocks as long as needed until it can be acquired.

func (*Lock) Release

func (l *Lock) Release() error

Release the lock that was acquired.

func (*Lock) WithPeriod

func (l *Lock) WithPeriod(period time.Duration) *Lock

WithPeriod configures the polling period during lock acquisition, for purposes of printing the warning message.

func (*Lock) WithWarn

func (l *Lock) WithWarn(warn string) *Lock

WithWarn configures the warning message that will be printed on slow lock acquisition.