lockfile

Documentation

Overview

Package lockfile implements a pid lock file mechanism.

Index

• type LockFunc
• type Lockfile
  • func New(fp string) (Lockfile, error)
  • func (l Lockfile) Lock(ctx context.Context, timeout time.Duration) error
  • func (l Lockfile) String() string
  • func (l Lockfile) Unlock() error

Types

type LockFunc

type LockFunc func(ctx context.Context) (unlock func(), err error)

LockFunc is a function that encapsulates locking and unlocking.

type Lockfile

type Lockfile string

Lockfile is a pid file which can be locked.

func New

func New(fp string) (Lockfile, error)

New returns a new Lockfile instance. Arg fp must be an absolute path (but it's legal for the path to not exist).

func (Lockfile) Lock

func (l Lockfile) Lock(ctx context.Context, timeout time.Duration) error

Lock attempts to acquire the lock, retrying if necessary, until the timeout expires. If timeout is zero, retry will not occur. On success, nil is returned. An error is returned if the lock cannot be acquired for any reason.

func (Lockfile) String

func (l Lockfile) String() string

String returns the Lockfile's absolute path.

func (Lockfile) Unlock

func (l Lockfile) Unlock() error

Unlock a lock, if we owned it. Returns any error that happened during release of lock.