flock

Documentation

Index

• type Meta
• type T
  • func New(p string, sessionId string, lockP func(string) locker.Locker) *T
  • func (t *T) Lock(timeout time.Duration, intent string) (err error)
  • func (t *T) Probe() (Meta, error)
  • func (t *T) UnLock() error

Types

type Meta

type Meta struct {
	At        time.Time `json:"at"`
	PID       int       `json:"pid"`
	Intent    string    `json:"intent"`
	SessionID string    `json:"session_id"`
}

type T

type T struct {
	locker.Locker
	Path string
	// contains filtered or unexported fields
}

T wraps flock and dumps JSON data in the lock file hinting about what holds the lock.

func New

func New(p string, sessionId string, lockP func(string) locker.Locker) *T

New allocate a file lock struct from the Locker provider.

func (*T) Lock

func (t *T) Lock(timeout time.Duration, intent string) (err error)

Lock acquires an exclusive file lock on the file and writes a JSON formatted structure hinting who holds the lock and with what intention.

func (*T) Probe

func (t *T) Probe() (Meta, error)

Probe attempts to acquire a file lock. If successful, it releases the lock and returns an empty Meta. If the lock is already held by another process, it reads and returns the current lock metadata. Note: Reading the metadata may fail if the other process has not finished writing it.

func (*T) UnLock

func (t *T) UnLock() error

UnLock releases the file lock acquired by Lock.