pidfile

README

pidfile

golang package for create and clear pid file.

Documentation

Index

• Constants
• func ClearPidFile(pf *PidFile) error
• type File
  • func NewFile(path string) *File
  • func (f *File) Read() ([]byte, error)
  • func (f *File) Remove() error
  • func (f *File) Rename(newFile string) error
  • func (f *File) Write(data []byte) error
• type Pid
  • func NewPid(id int) *Pid
  • func (p *Pid) ProcessExist() bool
• type PidFile
  • func CreatePidFile(path string) (*PidFile, error)
  • func NewPidFile(path string) *PidFile
  • func (pf *PidFile) Clear() error
  • func (pf *PidFile) Create() error
  • func (pf *PidFile) ReadPidFromFile(file *File) (*Pid, error)
  • func (pf *PidFile) WritePidToFile(file *File, pid *Pid) error

Constants

const (
	PID_FILE_MIN_ID          = 0
	PID_FILE_TMP_PATH_SUFFIX = ".tmp"
)

Functions

func ClearPidFile

func ClearPidFile(pf *PidFile) error

Types

type File

type File struct {
	Path string
}

func NewFile

func NewFile(path string) *File

func (*File) Read

func (f *File) Read() ([]byte, error)

func (*File) Remove

func (f *File) Remove() error

func (*File) Rename

func (f *File) Rename(newFile string) error

func (*File) Write

func (f *File) Write(data []byte) error

type Pid

type Pid struct {
	Id int
}

func NewPid

func NewPid(id int) *Pid

func (*Pid) ProcessExist

func (p *Pid) ProcessExist() bool

type PidFile

type PidFile struct {
	Pid     *Pid
	File    *File
	TmpFile *File
}

func CreatePidFile

func CreatePidFile(path string) (*PidFile, error)

func NewPidFile

func NewPidFile(path string) *PidFile

func (*PidFile) Clear

func (pf *PidFile) Clear() error

func (*PidFile) Create

func (pf *PidFile) Create() error

func (*PidFile) ReadPidFromFile

func (pf *PidFile) ReadPidFromFile(file *File) (*Pid, error)

func (*PidFile) WritePidToFile

func (pf *PidFile) WritePidToFile(file *File, pid *Pid) error