process

Documentation

Overview

Package process has helper code for managing server processes and connections to them.

Index

• func StartOnDevice(ctx context.Context, name string, opts StartOptions) (int, error)
• type PortWatcher
  • func NewPortWatcher(portChan chan<- string, opts *StartOptions) *PortWatcher
  • func (w *PortWatcher) WaitForFile(ctx context.Context)
  • func (w *PortWatcher) Write(b []byte) (n int, err error)
• type StartOptions

Functions

func StartOnDevice

func StartOnDevice(ctx context.Context, name string, opts StartOptions) (int, error)

StartOnDevice runs the application on the given remote device, with the given path and options, waits for the "Bound on port {port}" string to be printed to stdout, and then returns the port number.

Types

type PortWatcher

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

PortWatcher will wait for the given port to become available on the given device. It will look at the given stdout, for the lines Bound on port <portnum>, and in the given portFile for the same lines. If either is found, the port will be written to portChan. Otherwise an error will be written to the channel.

func NewPortWatcher

func NewPortWatcher(portChan chan<- string, opts *StartOptions) *PortWatcher

NewPortWatcher creates and returns an initialized port watcher

func (*PortWatcher) WaitForFile

func (w *PortWatcher) WaitForFile(ctx context.Context)

Waits until the port file is found, or the context is cancelled

func (*PortWatcher) Write

func (w *PortWatcher) Write(b []byte) (n int, err error)

type StartOptions

type StartOptions struct {
	// Command line arguments for starting the process.
	Args []string

	// Environment variables for starting the process.
	Env *shell.Env

	// Standard output pipe for the new process.
	Stdout io.Writer

	// Standard error pipe for the new process.
	Stderr io.Writer

	// Should all stderr and and stdout also be logged to the logger?
	Verbose bool

	// PortFile, if not "", is a file that can be search if we can
	// not find the output on stdout
	PortFile string

	// If not "", the working directory for this command
	WorkingDir string

	// IgnorePort, if true, then will not wait for the port to become
	// available
	IgnorePort bool

	// Device, which device should this be started on
	Device bind.Device
}

StartOptions holds the options that can be passed to Start.