flock

Documentation

Index

• type Lock
  • func New(path string) *Lock
  • func (l *Lock) Lock(ctx context.Context) error
  • func (l *Lock) TryLock(_ context.Context) (bool, error)
  • func (l *Lock) Unlock(_ context.Context) error

Types

type Lock

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

Lock provides in-process (channel) + cross-process (flock) mutual exclusion.

func New

func New(path string) *Lock

New creates a Lock for the given path.

func (*Lock) Lock

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

Lock acquires the lock, blocking until available or ctx is canceled.

func (*Lock) TryLock

func (l *Lock) TryLock(_ context.Context) (bool, error)

TryLock attempts a non-blocking acquisition. Returns (false, nil) if the lock is currently held by another caller.

func (*Lock) Unlock

func (l *Lock) Unlock(_ context.Context) error

Unlock releases the lock.