cmdrunner

Documentation

Index

• Variables
• func ReattachFunc(pid int, addr net.Addr) runner.ReattachFunc
• type CmdAttachedRunner
  • func (*CmdAttachedRunner) HostToPlugin(hostNet, hostAddr string) (string, string, error)
  • func (c *CmdAttachedRunner) ID() string
  • func (c *CmdAttachedRunner) Kill(_ context.Context) error
  • func (*CmdAttachedRunner) PluginToHost(pluginNet, pluginAddr string) (string, string, error)
  • func (c *CmdAttachedRunner) Wait(_ context.Context) error
• type CmdRunner
  • func NewCmdRunner(logger hclog.Logger, cmd *exec.Cmd) (*CmdRunner, error)
  • func (c *CmdRunner) Diagnose(_ context.Context) string
  • func (*CmdRunner) HostToPlugin(hostNet, hostAddr string) (string, string, error)
  • func (c *CmdRunner) ID() string
  • func (c *CmdRunner) Kill(_ context.Context) error
  • func (c *CmdRunner) Name() string
  • func (*CmdRunner) PluginToHost(pluginNet, pluginAddr string) (string, string, error)
  • func (c *CmdRunner) Start(_ context.Context) error
  • func (c *CmdRunner) Stderr() io.ReadCloser
  • func (c *CmdRunner) Stdout() io.ReadCloser
  • func (c *CmdRunner) Wait(_ context.Context) error

Variables

var (

	// ErrProcessNotFound is returned when a client is instantiated to
	// reattach to an existing process and it isn't found.
	ErrProcessNotFound = errors.New("Reattachment process not found")
)

Functions

func ReattachFunc

func ReattachFunc(pid int, addr net.Addr) runner.ReattachFunc

ReattachFunc returns a function that allows reattaching to a plugin running as a plain process. The process may or may not be a child process.

Types

type CmdAttachedRunner

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

CmdAttachedRunner is mostly a subset of CmdRunner, except the Wait function does not assume the process is a child of the host process, and so uses a different implementation to wait on the process.

func (*CmdAttachedRunner) HostToPlugin

func (*CmdAttachedRunner) HostToPlugin(hostNet, hostAddr string) (string, string, error)

func (*CmdAttachedRunner) ID

func (c *CmdAttachedRunner) ID() string

func (*CmdAttachedRunner) Kill

func (c *CmdAttachedRunner) Kill(_ context.Context) error

func (*CmdAttachedRunner) PluginToHost

func (*CmdAttachedRunner) PluginToHost(pluginNet, pluginAddr string) (string, string, error)

func (*CmdAttachedRunner) Wait

func (c *CmdAttachedRunner) Wait(_ context.Context) error

type CmdRunner

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

CmdRunner implements the runner.Runner interface. It mostly just passes through to exec.Cmd methods.

func NewCmdRunner

func NewCmdRunner(logger hclog.Logger, cmd *exec.Cmd) (*CmdRunner, error)

NewCmdRunner returns an implementation of runner.Runner for running a plugin as a subprocess. It must be passed a cmd that hasn't yet been started.

func (*CmdRunner) Diagnose

func (c *CmdRunner) Diagnose(_ context.Context) string

func (*CmdRunner) HostToPlugin

func (*CmdRunner) HostToPlugin(hostNet, hostAddr string) (string, string, error)

func (*CmdRunner) ID

func (c *CmdRunner) ID() string

func (*CmdRunner) Kill

func (c *CmdRunner) Kill(_ context.Context) error

func (*CmdRunner) Name

func (c *CmdRunner) Name() string

func (*CmdRunner) PluginToHost

func (*CmdRunner) PluginToHost(pluginNet, pluginAddr string) (string, string, error)

func (*CmdRunner) Start

func (c *CmdRunner) Start(_ context.Context) error

func (*CmdRunner) Stderr

func (c *CmdRunner) Stderr() io.ReadCloser

func (*CmdRunner) Stdout

func (c *CmdRunner) Stdout() io.ReadCloser

func (*CmdRunner) Wait

func (c *CmdRunner) Wait(_ context.Context) error