pidfile

package
v24.0.0+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 15, 2023 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Overview

Package pidfile provides structure and helper functions to create and remove PID file. A PID file is usually a file used to store the process ID of a running process.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Read

func Read(path string) (pid int, err error)

Read reads the "PID file" at path, and returns the PID if it contains a valid PID of a running process, or 0 otherwise. It returns an error when failing to read the file, or if the file doesn't exist, but malformed content is ignored. Consumers should therefore check if the returned PID is a non-zero value before use.

func Write

func Write(path string, pid int) error

Write writes a "PID file" at the specified path. It returns an error if the file exists and contains a valid PID of a running process, or when failing to write the file.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL