filemu

Documentation

Overview

Package filemu implements file-based mutexes.

Index

• type UnlockFunc
  • func Lock(ctx context.Context, path string) (UnlockFunc, error)
  • func RLock(ctx context.Context, path string) (UnlockFunc, error)

Types

type UnlockFunc

type UnlockFunc func() error

UnlockFunc is the set of unlock functions.

func Lock

func Lock(ctx context.Context, path string) (UnlockFunc, error)

Lock attempts to acquire an exclusive lock on the named file.

func RLock

func RLock(ctx context.Context, path string) (UnlockFunc, error)

RLock attempts to acquire a shared lock on the named file.