flock

Documentation

Index

• func WithLock(options Options, syncFn func() error) error
• type Error
  • func (err *Error) Error() string
• type Options

Functions

func WithLock

func WithLock(options Options, syncFn func() error) error

WithLock executes a callback function with a global exclusive file-system lock If the lock is never acquired, the returned error will be of type flock.Error Else, the error will be whatever was returned by the callback function

Types

type Error

type Error struct {
	Err error // Err underlying error (if there was one)
	// contains filtered or unexported fields
}

Error for errors generated in the flock package

func (*Error) Error

func (err *Error) Error() string

Error() implements error interface

type Options

type Options struct {
	Path          string        // Path to file to use for lock
	RetryInterval time.Duration // RetryInterval how often to retry lock attempts
	Timeout       time.Duration // Timeout how long to wait for the lock before giving up
}

Options holds necessary attributes for a file lock with a timeout.