proc

Documentation

Index

• type Platform
• type Process
• type State
• type Stdio
  • func (s Stdio) IsNull() bool

Types

type Platform

type Platform interface {
	CopyConsole(ctx context.Context, console console.Console, stdin, stdout, stderr string,
		wg, cwg *sync.WaitGroup) (console.Console, error)
	ShutdownConsole(ctx context.Context, console console.Console) error
	Close() error
}

Platform handles platform-specific behavior that may differs across platform implementations

type Process

type Process interface {
	State
	// ID returns the id for the process
	ID() string
	// Pid returns the pid for the process
	Pid() int
	// ExitStatus returns the exit status
	ExitStatus() int
	// ExitedAt is the time the process exited
	ExitedAt() time.Time
	// Stdin returns the process STDIN
	Stdin() io.Closer
	// Stdio returns io information for the container
	Stdio() Stdio
	// Status returns the process status
	Status(context.Context) (string, error)
	// Wait blocks until the process has exited
	Wait()
}

Process on a system

type State

type State interface {
	// Resize resizes the process console
	Resize(ws console.WinSize) error
	// Start execution of the process
	Start(context.Context) error
	// Delete deletes the process and its resourcess
	Delete(context.Context) error
	// Kill kills the process
	Kill(context.Context, uint32, bool) error
	// SetExited sets the exit status for the process
	SetExited(status int)
}

State of a process

type Stdio

type Stdio struct {
	Stdin    string
	Stdout   string
	Stderr   string
	Terminal bool
}

Stdio of a process

func (Stdio) IsNull

func (s Stdio) IsNull() bool

IsNull returns true if the stdio is not defined