subproc

package

v1.6.112 Latest Latest Go to latest Published: Aug 13, 2023 License: MPL-2.0 Imports: 8 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

Repository

github.com/hernad/nomad

Links

Open Source Insights

Documentation ¶

Overview ¶

Package subproc provides helper utilities for executing the Nomad binary as a child process of the Nomad agent.

The main entrypoint is the Do function, in which the given MainFunc will be executed as a sub-process if the first argument matches the subcommand.

Context can be used to create a context.Context object with a given timeout, and is expected to be used in conjunction with SetExpiration which uses the context's termination to forcefully terminate the child process if it has not exited by itself.

Index ¶

Constants
func Context(timeout time.Duration) (context.Context, context.CancelFunc)
func Do(name string, f MainFunc)
func Log(r io.Reader, f func(msg string, args ...any))
func Print(format string, args ...any)
func Self() string
func SetExpiration(ctx context.Context)
type MainFunc

Constants ¶

View Source

const (
	// ExitSuccess indicates the subprocess completed successfully.
	ExitSuccess = iota

	// ExitFailure indicates the subprocess terminated unsuccessfully.
	ExitFailure

	// ExitTimeout indicates the subprocess timed out before completion.
	ExitTimeout
)

Variables ¶

This section is empty.

Functions ¶

func Context ¶

func Context(timeout time.Duration) (context.Context, context.CancelFunc)

Context creates a context setup with the given timeout.

func Do ¶

func Do(name string, f MainFunc)

Do f if nomad was launched as, "nomad [name]". This process will exit without running any other part of Nomad.

func Log ¶

func Log(r io.Reader, f func(msg string, args ...any))

Log the given output to the logger.

r should be a buffer containing output (typically combined stdin + stdout) f should be an HCLogger Print method (e.g. log.Debug)

func Print ¶

func Print(format string, args ...any)

Print the given message to standard error.

func Self ¶

func Self() string

Self returns the path to the executable of this process.

func SetExpiration ¶

func SetExpiration(ctx context.Context)

SetExpiration is used to ensure the process terminates, once ctx is complete. A short grace period is added to allow any cleanup to happen first.

Types ¶

type MainFunc ¶

type MainFunc func() int

MainFunc is the function that runs for this sub-process.

The return value is a process exit code.

Source Files ¶

View all Source files

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