lock

Documentation

Index

• type Lock
  • func New(p string, retryDelay time.Duration) (*Lock, error)
  • func (l *Lock) Lock(ctx context.Context) error
  • func (l *Lock) Unlock() error

Types

type Lock

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

Lock uses a file lock to coordinate access to resources shared with other processes. Callers are responsible for preventing races within a process. Lock applies advisory locks on Linux and macOS and is therefore unreliable on these platforms when several processes concurrently try to acquire the lock.

func New

func New(p string, retryDelay time.Duration) (*Lock, error)

New is the constructor for Lock. "p" is the path to the lock file.

func (*Lock) Lock

func (l *Lock) Lock(ctx context.Context) error

Lock acquires the file lock on behalf of the process. The behavior of concurrent and repeated calls is undefined. For example, Linux may or may not allow goroutines scheduled on different threads to hold the lock simultaneously.

func (*Lock) Unlock

func (l *Lock) Unlock() error

Unlock releases the lock and deletes the lock file.