common

Documentation

Overview

Package common provides the ability to write a file with an eventual rename on Close (using os.Rename). This allows for a file to always be in a consistent state and never represent an in-progress write.

NOTE: `os.Rename` may not be atomic on your operating system.

Index

• Constants
• func ReadPid() (int, error)
• func SavePid(processConfig conf.ProcessConfig) error
• func SetPidFilePath(p string)
• func WritePid() error
• type AtomicFile
  • func AtomicFileNew(path string, mode os.FileMode) (*AtomicFile, error)
  • func (f *AtomicFile) Abort() error
  • func (f *AtomicFile) Close() error

Constants

const (
	RestSuccess = 0
)

Functions

func ReadPid

func ReadPid() (int, error)

ReadPid the pid from the configured file. It is an error if the pidFile hasn't been configured.

func SavePid

func SavePid(processConfig conf.ProcessConfig) error

SavePid save current process's pid into files.

func SetPidFilePath

func SetPidFilePath(p string)

SetPidFilePath sets the pidFile path.

func WritePid

func WritePid() error

WritePid the pidFile based on the flag. It is an error if the pidFile hasn't been configured.

Types

type AtomicFile

type AtomicFile struct {
	*os.File
	// contains filtered or unexported fields
}

AtomicFile behaves like os.File, but does an atomic rename operation at Close.

func AtomicFileNew

func AtomicFileNew(path string, mode os.FileMode) (*AtomicFile, error)

AtomicFileNew creates a new temporary file that will replace the file at the given path when Closed.

func (*AtomicFile) Abort

func (f *AtomicFile) Abort() error

Abort closes the file and removes it instead of replacing the configured file. This is useful if after starting to write to the file you decide you don't want it anymore.

func (*AtomicFile) Close

func (f *AtomicFile) Close() error

Close the file replacing the configured file.