locker

package module

v0.1.1 Latest Latest Go to latest Published: May 22, 2020 License: MIT Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This is a library to create a file for the life of a process, possibly containing something like a pid, or more, based on what interface you pass in.

It has the ability to remove the file on a context cancellation, or to manually remove the file.

This section is empty.

View Source

var ErrorAlreadyLocked = errors.New("LockPath is already locked")

ErrorAlreadyLocked reports that our path is already locked.

This section is empty.

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

func New(path string, content interface{}) *Locker

func (l Locker) Lock() error

lock creates a filesystem lock for a process

func (l Locker) Read(val interface{}) error

Read reads a lockfile to get its content

func (l Locker) ShutdownContext(ctx context.Context)

func (l Locker) Unlock() error

unlock removes a lock file if it exists