commands

package

v0.0.0-...-8018142 Latest Latest Go to latest Published: Feb 9, 2021 License: MPL-2.0 Imports: 15 Imported by: 2

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

Repository

github.com/joyent/containerpilot

Links

Open Source Insights

README ¶

commands

Documentation ¶

Overview ¶

Package commands provides a wrapper around os/exec to consistently manage process execution, cancellation of their child processes, timeouts, logging, arg parsing, and correct shutdown.

Index ¶

func ParseArgs(raw interface{}) (executable string, args []string, err error)
type Command
- func NewCommand(rawArgs interface{}, timeout time.Duration, fields log.Fields) (*Command, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func ParseArgs ¶

func ParseArgs(raw interface{}) (executable string, args []string, err error)

ParseArgs parses the executable and its arguments from supported types.

Types ¶

type Command ¶

type Command struct {
	Name    string // this gets used only in logs, defaults to Exec
	Cmd     *exec.Cmd
	Exec    string
	Args    []string
	Timeout time.Duration
	// contains filtered or unexported fields
}

Command wraps an os/exec.Cmd with a timeout, logging, and arg parsing.

func NewCommand ¶

func NewCommand(rawArgs interface{}, timeout time.Duration, fields log.Fields) (*Command, error)

NewCommand parses JSON config into a Command

func (*Command) EnvName ¶

func (c *Command) EnvName() string

EnvName formats Name for use as an environment variable name (PID).

func (*Command) Kill ¶

func (c *Command) Kill()

Kill sends a kill signal to the underlying process if it still exists, as well as all its children

func (*Command) Run ¶

func (c *Command) Run(pctx context.Context, bus *events.EventBus)

Run creates an exec.Cmd for the Command and runs it asynchronously. If the parent context is closed/canceled this will terminate the child process and do any cleanup we need.

func (*Command) Term ¶

func (c *Command) Term()

Term sends a terminate signal to the underlying process if it still exists, as well as all its children

Source Files ¶

View all Source files

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