lockfile

Documentation

Overview

Package lockfile provides methods to associate process ids (PIDs) with a file.

Index

• func CreateLockfile(file string) error
• func RemoveLockfile(file string)

Functions

func CreateLockfile

func CreateLockfile(file string) error

CreateLockfile associates the provided file with the process ID of the caller.

file should not contain any useful content because CreateLockfile may delete and recreate it.

Only one active process can be associated with a file at a time. Thus, if another active process is currently associated with file, then CreateLockfile will return an error.

func RemoveLockfile

func RemoveLockfile(file string)

RemoveLockfile removes file and the corresponding lock on it.