background

package

v0.0.0-...-0f74808 Latest Latest Go to latest Published: Mar 18, 2024 License: AGPL-3.0 Imports: 16 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package background contains an abstraction for running processes in the background.

This section is empty.

View Source

var ErrUserKilled = xerrors.Errorf("daemon killed by user")

This section is empty.

type Process struct {
	// contains filtered or unexported fields
}

Process is an abstraction for running a command as a background process.

func New(ctx context.Context, log slog.Logger, cmd string, args ...string) *Process

New returns an instantiated daemon.

func (d *Process) Restart(ctx context.Context, cmd string, args ...string) error

Restart kill the running process and reruns the command with the updated cmd and args.

func (d *Process) Run() <-chan error

Run runs the command and waits for it to exit. It is a convenience function that combines both Start() and Wait().

func (d *Process) Start() error

Start starts the daemon. It functions akin to ox/exec.Command.Start().

func (d *Process) Wait() <-chan error

Wait waits for the process to exit, returning the error on the provided channel.