lock

Documentation

Overview

Package lock provides methods for working with lock files

Index

• Variables
• func Create(name string) error
• func Has(name string) bool
• func IsExpired(name string, ttl time.Duration) bool
• func Remove(name string) error
• func Wait(name string, deadline time.Time) bool

Examples

• Create
• Has
• IsExpired
• Remove
• Wait

Variables

var Dir = "/var/tmp"

Dir is a path to directory with lock files

Functions

func Create

func Create(name string) error

Create creates new lock file

Example

err := Create("my_app")

if err != nil {
	panic(err.Error())
}

// do some stuff

err = Remove("my_app")

if err != nil {
	panic(err.Error())
}

func Has

func Has(name string) bool

Has returns true if lock file exists

Example

if Has("my_app") {
	panic("Can't start application due to lock file")
}

func IsExpired

func IsExpired(name string, ttl time.Duration) bool

IsExpired returns true if lock file reached TTL

Example

if Has("my_app") {
	if IsExpired("my_app", time.Hour) {
		// looks like lock file was created long time ago, so delete it
		Remove("my_app")
	} else {
		panic("Can't start application due to lock file")
	}
}

func Remove

func Remove(name string) error

Remove deletes lock file

Example

err := Create("my_app")

if err != nil {
	panic(err.Error())
}

// do your stuff

err = Remove("my_app")

if err != nil {
	panic(err.Error())
}

func Wait

func Wait(name string, deadline time.Time) bool

Wait waits until lock file being deleted

Example

ok := Wait("my_app", time.Now().Add(time.Minute))

if !ok {
	panic("Can't start application due to lock file")
}

// do your stuff