lockfile

package

v0.11.0 Latest Latest Go to latest Published: Aug 25, 2026 License: MIT Imports: 5 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/floegence/redeven

Links

Open Source Insights

Documentation ¶

Rendered for

Index ¶

Variables
func ReadContent(path string) ([]byte, error)
func RetireIf(path string, shouldRetire func([]byte) (bool, error)) (bool, error)
type Lock
- func Acquire(path string) (*Lock, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ErrAlreadyLocked indicates the lock is held by another process.
	ErrAlreadyLocked = errors.New("lock already held")
)

Functions ¶

func ReadContent ¶

func ReadContent(path string) ([]byte, error)

func RetireIf ¶ added in v0.7.2

func RetireIf(path string, shouldRetire func([]byte) (bool, error)) (bool, error)

RetireIf takes the existing lock without changing its content, evaluates the active lease while holding the lock, and clears it only when the callback confirms that the lease is safe to retire.

Types ¶

type Lock ¶

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

func Acquire ¶

func Acquire(path string) (*Lock, error)

func (*Lock) Held ¶ added in v0.11.0

func (l *Lock) Held() bool

func (*Lock) Path ¶

func (l *Lock) Path() string

func (*Lock) Release ¶

func (l *Lock) Release() error

func (*Lock) SetContent ¶

func (l *Lock) SetContent(body []byte) error

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL